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

LocalVideoTrack

Summary
LocalVideoTrack represents a video track that can be published to a Room.
Remarks
It provides methods to attach and detach the track to and from HTMLVideoElements.

Constructor

Construct a new video track from a MediaStreamTrack.
Signature
new LocalVideoTrack(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

attach

Attaches the track to an HTML video element.
Signature
attach(element?: HTMLVideoElement)
NameTypeDescription
element optionalHTMLVideoElementThe video element to attach to (optional).
Returns
HTMLVideoElement The HTMLVideoElement the video track is attached to.
Remarks
If no element is provided, a new video element will be created and returned.

detach

Detaches the track from an HTML video element.
Signature
detach(element?: HTMLMediaElement)
NameTypeDescription
element optionalHTMLMediaElementThe video element to detach from (optional).
Returns
HTMLMediaElement | HTMLMediaElement[] The detached video element(s).
Remarks
If no element is provided, the track will be detached from all previously attached elements.

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.