Interface IRemoteVideoTrack

RemoteVideoTrack is the basic interface for the remote video track.

You can get create a remote video track by the [AgoraRTCRemoteUser.videoTrack]videoTrack object after calling [subscribe]subscribe.

Hierarchy

Properties

isPlaying trackMediaType

Methods

getCurrentFrameData getListeners getMediaStreamTrack getStats getTrackId getUserId getVideoElementVisibleStatus 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

getCurrentFrameData

  • Since
       4.1.0

    Gets the data of the video frame being rendered.

    You should call this method after calling play. Otherwise, the method call returns null.

    Returns

    An ImageData object that stores RGBA data. ImageData is a web API supported by the browser. For details, see ImageData.

    Returns ImageData

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

getVideoElementVisibleStatus

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

  • Parameters

    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 remote video track on the web page.

    Parameters

    • 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.
    • Optional config: VideoPlayerConfig

      Sets the playback configurations, such as display mode and mirror mode. See VideoPlayerConfig. By default, the SDK enables mirror mode for a local video track.

    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