LocalTrackPublication
Summary
LocalTrackPublication represents a LocalTrack that has been published to a Room.
It contains the LocalTrack itself, as well as the TrackPublishOptions used to
publish the track.Properties
dimensions
optional
dimension of the original published stream, video-only
dimension of the original published stream, video-only
Type
Dimensionskind
The kind of track that is published
Type
Track.KindmimeType
optional
MimeType of the published track
MimeType of the published track
Type
stringoptions
Type
TrackPublishOptionssimulcasted
optional
true if track was simulcasted to server, video-only
true if track was simulcasted to server, video-only
Type
booleansource
Source of the published track
Type
Track.Sourcetrack
Type
LocalTracktrackName
Name of the published track
Type
stringtrackSid
Server-generated unique ID of the published track
Type
stringMethods
mute
Mute the track associated with this publication
Signature
mute()Returns
Promise<undefined | LocalTrack>pauseUpstream
Pauses the media stream track associated with this publication from being sent to the server
and signals "muted" event to other participants
Useful if you want to pause the stream without pausing the local media stream track
Signature
pauseUpstream()Returns
Promise<void>resumeUpstream
Resumes sending the media stream track associated with this publication to the server after a
call to pauseUpstream and signals "unmuted" event to other participants (unless the
track is explicitly muted).
Signature
resumeUpstream()Returns
Promise<void>unmute
Unmute track associated with this publication
Signature
unmute()Returns
Promise<undefined | LocalTrack>