Options
All
  • Public
  • Public/Protected
  • All
Menu

RemoteVideoTrack is the basic interface for the remote video track.

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

Hierarchy

Index

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 <internal>.ImageData

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

getListeners

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

    Parameters

    • event: string

      The event name.

    Returns Function[]

getMediaStreamTrack

getStats

getTrackId

  • getTrackId(): string
  • Gets the ID of a media track, a unique identifier generated by the SDK.

    Returns string

    The media track ID.

getUserId

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

    Returns UID

    The uid of the remote user.

getVideoElementVisibleStatus

  • Returns undefined | CheckVisibleResult

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: "first-frame-decoded", listener: () => void): void
  • on(event: "video-element-visible-status", listener: (data?: CheckVisibleResult) => void): void
  • Listens for a specified event.

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

    Parameters

    • event: "first-frame-decoded"
    • listener: () => void
        • (): void
        • Occurs when the first remote audio or video frame is decoded.

          asmemberof

          IRemoteTrack

          Returns void

    Returns void

  • Parameters

    Returns 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

  • 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

  • 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
  • Stops playing the media track.

    Returns void

Generated using TypeDoc