RemoteAudioTrack

继承

• RemoteTrack
  • RemoteAudioTrack

属性

isPlaying

isPlaying: boolean

媒体轨道是否正在页面上播放。

• true: 媒体轨道正在页面上播放。
• false: 媒体轨道没有在页面上播放。

trackMediaType

trackMediaType: "audio" | *"video"

媒体轨道的类型：

• "audio": 音频轨道。
• "video": 视频轨道。

方法

getListeners

getListeners(event: string): Function[]

指定一个事件名，获取当前所有监听这个事件的回调函数。

参数

• event: string

  事件名称。

返回值 Function[]

getMediaStreamTrack

getMediaStreamTrack(): MediaStreamTrack

获取浏览器原生的 MediaStreamTrack 对象。

返回值 MediaStreamTrack

一个 MediaStreamTrack 对象。

getTrackId

• getTrackId(): string

获取由 SDK 生成的对于媒体轨道来说的唯一 ID。

返回值 string

媒体轨道 ID。

getVolumeLevel

getVolumeLevel(): number

获取远端音频轨道的音量等级。

返回值 number

音量等级值，范围 [0, 1]，1 代表理论最大音量。

off

off(event: string, listener: Function): void

取消一个指定事件的监听。

参数

• event: string

  指定事件的名称。

• listener: Function

  监听事件时传入的回调函数。

返回值 void

on

on(event: "first-frame-decoded", listener: event_first_frame_decoded): void

参数

• event: "first-frame-decoded"

• listener: event_first_frame_decoded

返回值 void

once

once(event: string, listener: Function): *void

监听一个指定的事件，当事件触发时会调用传入的回调函数。

当监听后事件第一次触发时，该监听和回调函数就会被立刻移除，也就是只监听一次指定事件。

参数

• event: string

  指定事件的名称。

• listener: Function

  传入的回调函数。

返回值 void

play

play(): void

播放远端音频轨道。

播放音频时 SDK 不会创建任何 DOM 元素，所以无需像视频一样提供 DOM 元素。

返回值 void

removeAllListeners

removeAllListeners(event?: undefined | string): void

指定一个事件，取消其所有的监听。

参数

• Optional event: undefined | string

  指定事件的名称，如果没有指定事件，则取消所有事件的所有监听。

返回值 void

setPlaybackDevice

• setPlaybackDevice(deviceId: string): Promise<void>

设置音频输出设备，比如扬声器。

该方法只支持 Chrome 浏览器，其他浏览器调用将会抛出 NOT_SUPPORT 错误。

参数

• 设备 ID，可以通过 getPlaybackDevices 方法获取。

返回值 Promise<void>

setVolume

setVolume(volume: number): void

设置远端音频轨道的播放音量

参数

• volume: number

  音量值，范围 [0, 1000]，0 代表静音，100 代表原始音量。

返回值 void

stop

stop(): *void

停止播放。

返回值 void