TrackPublication
Defined in: client-sdk-js/src/participant/Participant.ts:36
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new TrackPublication(init): TrackPublication;Defined in: client-sdk-js/src/participant/Participant.ts:54
Parameters
Section titled “Parameters”string
boolean
source
Section titled “source”track?
Section titled “track?”trackName
Section titled “trackName”string
trackSid
Section titled “trackSid”string
Returns
Section titled “Returns”TrackPublication
Properties
Section titled “Properties”dimensions?
Section titled “dimensions?”dimensions?: object;Defined in: client-sdk-js/src/participant/Participant.ts:52
Original video dimensions from the publisher.
height
Section titled “height”height: number;width: number;info?: TrackInfo;Defined in: client-sdk-js/src/participant/Participant.ts:43
kind: string;Defined in: client-sdk-js/src/participant/Participant.ts:39
mimeType?
Section titled “mimeType?”mimeType?: string;Defined in: client-sdk-js/src/participant/Participant.ts:46
MIME type of the track (e.g. video/VP8, audio/opus).
muted: boolean;Defined in: client-sdk-js/src/participant/Participant.ts:42
simulcasted?
Section titled “simulcasted?”simulcasted?: boolean;Defined in: client-sdk-js/src/participant/Participant.ts:49
Whether the track was published with simulcast.
source
Section titled “source”source: TrackSource;Defined in: client-sdk-js/src/participant/Participant.ts:40
track?
Section titled “track?”track?: Track;Defined in: client-sdk-js/src/participant/Participant.ts:41
trackName
Section titled “trackName”trackName: string;Defined in: client-sdk-js/src/participant/Participant.ts:38
trackSid
Section titled “trackSid”trackSid: string;Defined in: client-sdk-js/src/participant/Participant.ts:37
Accessors
Section titled “Accessors”audioTrack
Section titled “audioTrack”Get Signature
Section titled “Get Signature”get audioTrack(): | LocalAudioTrack | RemoteAudioTrack | undefined;Defined in: client-sdk-js/src/participant/Participant.ts:94
Type-safe audio track getter. Returns undefined if the track is video.
Returns
Section titled “Returns”| LocalAudioTrack
| RemoteAudioTrack
| undefined
isEnabled
Section titled “isEnabled”Get Signature
Section titled “Get Signature”get isEnabled(): boolean;Defined in: client-sdk-js/src/participant/Participant.ts:84
Whether the track is enabled (not muted).
Returns
Section titled “Returns”boolean
isLocal
Section titled “isLocal”Get Signature
Section titled “Get Signature”get isLocal(): boolean;Defined in: client-sdk-js/src/participant/Participant.ts:110
Whether this publication belongs to the local participant.
Returns
Section titled “Returns”boolean
isMuted
Section titled “isMuted”Get Signature
Section titled “Get Signature”get isMuted(): boolean;Defined in: client-sdk-js/src/participant/Participant.ts:89
Whether the track is muted.
Returns
Section titled “Returns”boolean
isSubscribed
Section titled “isSubscribed”Get Signature
Section titled “Get Signature”get isSubscribed(): boolean;Defined in: client-sdk-js/src/participant/Participant.ts:79
Whether the track is subscribed (i.e. a concrete Track is available).
Returns
Section titled “Returns”boolean
videoTrack
Section titled “videoTrack”Get Signature
Section titled “Get Signature”get videoTrack(): | LocalVideoTrack | RemoteVideoTrack | undefined;Defined in: client-sdk-js/src/participant/Participant.ts:102
Type-safe video track getter. Returns undefined if the track is audio.
Returns
Section titled “Returns”| LocalVideoTrack
| RemoteVideoTrack
| undefined