Skip to content

Added JSDocs to TrackMetadata type #489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Magmusacy merged 1 commit into from
Mar 6, 2026
Merged

Added JSDocs to TrackMetadata type #489

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 8 additions & 1 deletion packages/ts-client/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,17 @@ import type { AuthErrorReason } from './auth';
import type { JoinErrorReason } from './guards';
import type { ReconnectConfig } from './reconnection';

/**
* Metadata attached to a track published by a peer.
* Sent over the signaling channel so other peers know what kind of track they're receiving.
* @category Tracks
*/
export type TrackMetadata = {
/** The kind of media this track carries. */
type: 'camera' | 'microphone' | 'screenShareVideo' | 'screenShareAudio' | 'customVideo' | 'customAudio';
/** Whether the track is currently muted/disabled. */
paused: boolean;
// track label used in recordings
/** The peer's display name, used in recordings. */
displayName?: string;
};

Expand Down
Loading