LocalTrackPublication
Defined in: client-sdk-js/src/participant/LocalTrackPublication.ts:11
Extends
Section titled “Extends”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;Inherited from
Section titled “Inherited from”info?: TrackInfo;Defined in: client-sdk-js/src/participant/Participant.ts:43
Inherited from
Section titled “Inherited from”kind: string;Defined in: client-sdk-js/src/participant/Participant.ts:39
Inherited from
Section titled “Inherited from”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).
Inherited from
Section titled “Inherited from”muted: boolean;Defined in: client-sdk-js/src/participant/Participant.ts:42
Inherited from
Section titled “Inherited from”options?
Section titled “options?”options?: TrackPublishOptions;Defined in: client-sdk-js/src/participant/LocalTrackPublication.ts:16
The options used when publishing the track.
simulcasted?
Section titled “simulcasted?”simulcasted?: boolean;Defined in: client-sdk-js/src/participant/Participant.ts:49
Whether the track was published with simulcast.
Inherited from
Section titled “Inherited from”source
Section titled “source”source: TrackSource;Defined in: client-sdk-js/src/participant/Participant.ts:40
Inherited from
Section titled “Inherited from”track?
Section titled “track?”track?: Track;Defined in: client-sdk-js/src/participant/Participant.ts:41
Inherited from
Section titled “Inherited from”trackName
Section titled “trackName”trackName: string;Defined in: client-sdk-js/src/participant/Participant.ts:38
Inherited from
Section titled “Inherited from”trackSid
Section titled “trackSid”trackSid: string;Defined in: client-sdk-js/src/participant/Participant.ts:37
Inherited from
Section titled “Inherited from”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
Inherited from
Section titled “Inherited from”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
Inherited from
Section titled “Inherited from”isLocal
Section titled “isLocal”Get Signature
Section titled “Get Signature”get isLocal(): boolean;Defined in: client-sdk-js/src/participant/LocalTrackPublication.ts:35
Whether this publication belongs to the local participant.
Returns
Section titled “Returns”boolean
Overrides
Section titled “Overrides”isMuted
Section titled “isMuted”Get Signature
Section titled “Get Signature”get isMuted(): boolean;Defined in: client-sdk-js/src/participant/LocalTrackPublication.ts:39
Whether the track is muted.
Returns
Section titled “Returns”boolean
Overrides
Section titled “Overrides”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
Inherited from
Section titled “Inherited from”isUpstreamPaused
Section titled “isUpstreamPaused”Get Signature
Section titled “Get Signature”get isUpstreamPaused(): boolean;Defined in: client-sdk-js/src/participant/LocalTrackPublication.ts:48
Whether upstream publishing is paused for this track.
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
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”getTrackFeatures()
Section titled “getTrackFeatures()”getTrackFeatures(): AudioTrackFeature[];Defined in: client-sdk-js/src/participant/LocalTrackPublication.ts:89
Returns a list of audio track features detected from the current track settings. Only applicable to audio tracks.
Returns
Section titled “Returns”mute()
Section titled “mute()”mute(): void;Defined in: client-sdk-js/src/participant/LocalTrackPublication.ts:53
Mute the track associated with this publication.
Returns
Section titled “Returns”void
pauseUpstream()
Section titled “pauseUpstream()”pauseUpstream(): Promise<void>;Defined in: client-sdk-js/src/participant/LocalTrackPublication.ts:74
Pause publishing to the server without disabling the local MediaStreamTrack.
Returns
Section titled “Returns”Promise<void>
resumeUpstream()
Section titled “resumeUpstream()”resumeUpstream(): Promise<void>;Defined in: client-sdk-js/src/participant/LocalTrackPublication.ts:81
Resume publishing after a call to pauseUpstream.
Returns
Section titled “Returns”Promise<void>
unmute()
Section titled “unmute()”unmute(): void;Defined in: client-sdk-js/src/participant/LocalTrackPublication.ts:63
Unmute the track associated with this publication.
Returns
Section titled “Returns”void