Interface IRemoteTrack

RemoteTrack is the basic interface for remote tracks, providing public methods for [RemoteAudioTrack]IRemoteAudioTrack and [RemoteVideoTrack]IRemoteVideoTrack.

Hierarchy

Properties

isPlaying trackMediaType

Methods

getListeners getMediaStreamTrack getStats getTrackId getUserId off on once play removeAllListeners stop

Properties

isPlaying

isPlaying: boolean

Whether a media track is playing on the webpage:

  • true: The media track is playing on the webpage.
  • false: The media track is not playing on the webpage.

trackMediaType

trackMediaType: "audio" | "video"

The type of a media track:

  • "audio": Audio track.
  • "video": Video track.

Methods

getListeners

  • Gets all the listeners for a specified event.

    Parameters

    • event: string

      The event name.

    Returns Function[]

getMediaStreamTrack

getStats

getTrackId

  • Gets the ID of a media track, a unique identifier generated by the SDK.

    Returns

    The media track ID.

    Returns string

getUserId

  • Gets the uid of the remote user who publishes the remote track.

    Returns

    The uid of the remote user.

    Returns UID

off

  • Removes the listener for a specified event.

    Parameters

    • event: string

      The event name.

    • listener: Function

      The callback that corresponds to the event listener.

    Returns void

on

  • Listens for a specified event.

    When the specified event happens, the SDK triggers the callback that you pass.

    Parameters

    • event: "first-frame-decoded"

      The event name.

    • listener: (() => void)

      The callback to trigger.

        • (): void

        • Occurs when the first remote audio or video frame is decoded.

          As Member Of

          IRemoteTrack

          Group

          Events

          Returns void

    Returns void

once

  • Listens for a specified event once.

    When the specified event happens, the SDK triggers the callback that you pass and then removes the listener.

    Parameters

    • event: string

      The event name.

    • listener: Function

      The callback to trigger.

    Returns void

play

  • Plays a media track on the webpage.

    Parameters

    • Optional element: string | HTMLElement

      Specifies a DOM element. The SDK will create a <video> element under the specified DOM element to play the video track. You can specify a DOM element in either of following ways:

      • string: Specify the ID of the DOM element.
      • HTMLElement: Pass a DOM object.

    Returns void

removeAllListeners

  • Removes all listeners for a specified event.

    Parameters

    • Optional event: string

      The event name. If left empty, all listeners for all events are removed.

    Returns void

stop

  • Stops playing the media track.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc