文档

RemoteAudioTrack

更新时间:

远端音频轨道,调用 subscribe 后通过 DingRTCRemoteUser.audioTrack 对象获取

继承自:RemoteTrack

属性列表

属性

类型

描述

支持的最低版本

isPlaying

boolean

媒体轨道是否正在播放

3.0.0

trackMediaType

TrackMediaType

媒体轨道类型

3.0.0

userId

string

远端用户uid

3.0.0

接口列表

接口

描述

最低支持的版本

getVolume()

获取当前播放音量大小

3.0.0

getVolumeLevel()

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

3.0.0

play()

播放远端音频轨道。

3.0.0

setSpeaker()

设置声音输出设备

3.0.0

setVolume()

设置播放音量大小

3.0.0

getMediaStreamTrack()

获取媒体轨道

3.0.0

getTrackId()

获取流轨道 id

3.0.0

play()

在页面上播放媒体轨道

3.0.0

replaceTrack()

替换音视频轨道

3.0.0

stop()

停止播放

3.0.0

off()

取消一个指定事件的监听回调函数

3.0.0

on()

监听一个指定事件并设置回调函数

3.0.0

once()

监听一个指定事件一次,回调函数触发后移除

3.0.0

removeAllListeners()

取消该对象指定事件或所有事件上的监听回调

3.0.0

接口详情

getVolume()

获取当前播放音量大小

类型签名

getVolume(): number;

返回

number

当前播放音量大小

getVolumeLevel()

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

类型签名

getVolumeLevel(): number;

返回

number

play()

播放远端音频轨道。

类型签名

play(): void;

返回

void

setSpeaker()

设置声音输出设备

类型签名

setSpeaker(deviceId: string): Promise<void>;

参数

参数

类型

描述

deviceId

string

设备标识, 通过 getPlaybackDevices() 获取。

返回

Promise<void>

setVolume()

设置播放音量大小

类型签名

setVolume(volume: number): void;

参数

参数

类型

描述

volume

number

音量值,范围 [0, 1],0 代表静音,1 代表原始音量。

返回

void

getMediaStreamTrack()

获取媒体轨道

类型签名

getMediaStreamTrack(): MediaStreamTrack;

返回

MediaStreamTrack

媒体轨道

getTrackId()

获取流轨道 id

类型签名

getTrackId(): string;

返回

string

流轨道 id

play()

在页面上播放媒体轨道

类型签名

play(): void;

返回

void

replaceTrack()

替换音视频轨道

类型签名

replaceTrack(track: MediaStreamTrack, stopOldTrack?: boolean): void;

参数

类型

描述

track

MediaStreamTrack

音视频轨道

stopOldTrack

boolean

(Optional)是否停止上一个轨道

返回

void

stop()

停止播放

类型签名

stop(): void;

返回

void

on()

监听一个指定事件并设置回调函数

类型签名

on(event: string, fn: Function): void;

参数

参数

类型

描述

event

string

监听的指定事件

fn

Function

监听事件触发时的回调函数

返回

void

off()

取消一个指定事件的监听回调函数

类型签名

off(event: string, fn: Function): void;

参数

参数

类型

描述

event

string

监听的指定事件

fn

Function

监听事件触发时的回调函数

返回

void

once()

监听一个指定事件一次,回调函数触发后移除

类型签名

once(event: string, fn: Function): void;

参数

参数

类型

描述

event

string

监听的指定事件

fn

Function

监听事件触发时的回调函数

返回

void

removeAllListeners()

取消该对象指定事件或所有事件上的监听回调

类型签名

removeAllListeners(event?: string): void;

参数

参数

类型

描述

event

string

(Optional)设置了指定事件时,对应监听回调函数将会清空。当参数未填写时,对象的所有事件的监听函数都将清空

返回

void

  • 本页导读 (0)
文档反馈