atmoky Engage Server SDK is now available! Check out the documentation to learn more.
API Reference
Classes
LocalTrackPublication

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
Type
Dimensions

kind

The kind of track that is published

mimeType

optional
MimeType of the published track
Type
string

options

optional
The TrackPublishOptions used to publish this track

simulcasted

optional
true if track was simulcasted to server, video-only
Type
boolean

source

Source of the published track

track

optional
The LocalTrack associated with this publication

trackName

Name of the published track
Type
string

trackSid

Server-generated unique ID of the published track
Type
string

Methods

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>

atmoky Logo

© 2023 atmoky, GmbH.
All rights reserved.

We use cookies to measure and improve your browsing experience, and serve personalized ads or content.