通知
本站点除 Legacy 产品与方案外，已迁移至 声网新文档中心 ，当前页面不再维护
Documentation
All
Console 官网 Community Technical support
English
search-icon

Agora Web SDK API Reference

Overview AgoraRTC AgoraRTCClient LocalTrack RemoteTrack Error codes

Hierarchy

Index

Properties

Methods

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

getTrackId

  • getTrackId(): string

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

    Returns string

    The media track ID.

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: string, listener: Function): void

  • Listens for a specified event.

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

    Parameters

    • event: string

      The event name.

    • listener: Function

      The callback to trigger.

    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

  • 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?: undefined | string): void

  • Removes all listeners for a specified event.

    Parameters

    • Optional event: undefined | 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