Interface IRemoteTrack

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

Hierarchy

Index

Events

first-frame-decoded

  • first-frame-decoded(): void
  • Occurs when the first remote audio or video frame is decoded.

    Returns void

transceiver-updated-2

  • transceiver-updated-2(transceiver: RTCRtpTransceiver): void
  • Occurs when the RTCRtpTransceiver instance of the current track is updated.

    Parameters

    • transceiver: RTCRtpTransceiver

      The new RTCRtpTransceiver instance.

    Returns void

video-state-changed

  • video-state-changed(videoState: VideoState): void
  • Occurs when the video state changes.

    Parameters

    Returns void

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

  • getListeners(event: string): Function[]
  • Gets all the listeners for a specified event.

    Parameters

    • event: string

      The event name.

    Returns Function[]

getMediaStreamTrack

  • getMediaStreamTrack(): MediaStreamTrack

getRTCRtpTransceiver

  • getRTCRtpTransceiver(type?: StreamType): RTCRtpTransceiver | undefined

getStats

getTrackId

  • getTrackId(): string

getUserId

  • getUserId(): UID
  • Gets the uid of the remote user who publishes the remote track.

    Returns UID

    The uid of the remote user.

off

  • off(event: string, listener: Function): void
  • 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

  • on(event: "track-updated", listener: typeof event_track_updated): void
  • on(event: "first-frame-decoded", listener: typeof event_first_frame_decoded): void
  • on(event: "transceiver-updated", listener: typeof event_transceiver_updated_2): void

once

  • once(event: string, listener: Function): void
  • 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

  • play(element?: string | HTMLElement): void
  • 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

  • removeAllListeners(event?: string): void
  • 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

  • stop(): void