Skip to content
This repository has been archived by the owner on Nov 13, 2024. It is now read-only.

Standarize track metadata for recording component #120

Merged
merged 2 commits into from
Jun 7, 2024
Merged

Standarize track metadata for recording component #120

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a85327b
Standarize track metadata for recording component
Karolk99 Jun 6, 2024
6c045a6
Update docs/getting_started/components/recording.md
Karolk99 Jun 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/getting_started/components/recording.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,12 @@ Credentials:
* `FJ_S3_SECRET_ACCESS_KEY` - Your secret access key for AWS.
Path prefix:
* `FJ_S3_PATH_PREFIX` - path prefix under which all streams will be stored.

## Client SDK

The recording component allows for customization of each track. Currently, there are two fields that can be set based on client and track properties:

* `displayName` - The name of the track that will be displayed on the recording.
* `type` - The type of the track. At present, only screensharing is supported; all other types will be ignored.

These fields should be provided by the client for each track, utilizing track metadata. For additional information, please refer to the `addTrack` function of specific client SDK e.g. [ts-client-sdk](https://fishjam-dev.github.io/ts-client-sdk/classes/FishjamClient.html#addTrack).