Hierarchy (view full)


  • Parameters

    • mediaTrack: MediaStreamTrack
    • Optional constraints: MediaTrackConstraints

      MediaTrackConstraints that are being used when restarting or reacquiring tracks

    • userProvidedTrack: boolean = true

      Signals to the SDK whether or not the mediaTrack should be managed (i.e. released and reacquired) internally by the SDK

    • Optional loggerOptions: LoggerOptions

    Returns LocalVideoTrack


attachedElements: HTMLMediaElement[] = []
isMuted: boolean = false
kind: Video
sid?: string

sid is set after track is published to server, or if it's a remote track

signalClient?: SignalClient
simulcastCodecs: Map<"vp8" | "h264" | "vp9" | "av1", SimulcastTrackInfo> = ...
source: Source
streamState: StreamState = Track.StreamState.Active

indicates current state of stream, it'll indicate paused if the track has been paused by congestion controller


  • get currentBitrate(): number
  • current receive bits per second

    Returns number


  • Parameters

    • codec: "vp8" | "h264" | "vp9" | "av1"
    • Optional encodings: RTCRtpEncodingParameters[]

    Returns undefined | SimulcastTrackInfo

  • creates a new HTMLAudioElement or HTMLVideoElement, attaches to it, and returns it

    Returns HTMLMediaElement

  • attaches track to an existing HTMLAudioElement or HTMLVideoElement


    • element: HTMLMediaElement

    Returns HTMLMediaElement

  • pauses publishing to the server without disabling the local MediaStreamTrack this is used to display a user's own video locally while pausing publishing to the server. this API is unsupported on Safari < 12 due to a bug

    Returns Promise<void>

Generated using TypeDoc