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

LocalAudioTrack

Summary
LocalAudioTrack represents an audio track that can be published to a Room.

Constructor

Constructs a LocalAudioTrack.
Signature
new LocalAudioTrack(mediaTrack: MediaStreamTrack, constraints?: MediaTrackConstraints, userProvidedTrack: boolean)
NameTypeDescription
mediaTrackMediaStreamTrack
constraints optionalMediaTrackConstraintsMediaTrackConstraints that are being used when restarting or reacquiring tracks
userProvidedTrackbooleanSignals to the SDK whether or not the mediaTrack should be managed (i.e. released and reacquired) internally by the SDK

Properties

sid

optional
Server assigned id.
Remarks
The value set after the track is published to the server, or if it's a remote track.
Type
string

streamState

Indicates the current state of stream.
Remarks
It'll indicate paused if the track has been paused by the congestion controller.
Type
StreamState

Accessors

Methods

getDeviceId

Signature
getDeviceId()
Returns
Promise<undefined | string> DeviceID of the device that is currently being used for this track

atmoky Logo

© 2024 atmoky, GmbH.
All rights reserved.

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