LocalAudioTrack

基础本地音频轨道,提供了本地音频轨道的主要功能。

继承自:LocalTrack

属性列表

属性

类型

描述

支持的最低版本

deviceId

string

获取设备ID。

1.0.0

isPlaying

boolean

媒体轨道是否正在播放

1.0.0

接口列表

接口

描述

支持的最低版本

setEnabled()

启用/停止启用 音频轨道

1.0.0

setMuted()

暂停/恢复音频轨道

1.0.0

getVolume()

获取当前播放音量大小

1.0.0

getVolumeLevel()

设置播放音量大小

1.0.0

getTrackId()

获取流轨道 id

1.0.0

getTrackLabel()

off()

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

1.0.0

on()

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

1.0.0

once()

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

1.0.0

removeAllListeners()

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

1.0.0

接口详情

getVolume()

获取当前播放音量大小

类型签名

getVolume(): number;

返回

当前播放音量大小

getVolumeLevel()

获取本地音频轨道的音量等级。

类型签名

getVolumeLevel(): number;

返回

number

音量等级值,范围 [0, 1],1 代表理论最大音量。通常该值大于 0.6 代表用户在持续说话。

setVolume()

设置播放音量大小

类型签名

setVolume(volume: number): void;

参数

参数

类型

描述

volume

number

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

返回

void

getTrackId()

获取流轨道 id

类型签名

getTrackId(): string;

返回

string

流轨道 id

play()

在页面上播放媒体轨道

类型签名

play(): void;

返回

void

stop()

停止播放

类型签名

stop(): void;

返回

void

close()

关闭本地轨道,并释放相关采集设备。

一旦本地轨道被关闭,就无法再次使用。如需再次使用本地轨道,需要重新创建。

类型签名

close(): void;

返回

void

getTrackLabel()

获取本地轨道的来源描述

类型签名

getTrackLabel(): string;

返回

string

音频或视频轨道描述

setDevice()

更新设置轨道使用的媒体设备

类型签名

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

参数

参数

类型

描述

deviceId

string

设备 id

返回

Promise<void>

setEnabled()

启用/禁用该轨道。

轨道禁用后,播放和发布都将被停止,如果该轨道已发布,调用 setEnabled后,远端会触发 user-info-updated 事件。

类型签名

setEnabled(enabled: boolean): Promise<void>;

参数

参数

参数

描述

enabled

boolean

是否启用该轨道 - true: 启用该轨道。 - false: 禁用该轨道。

返回

Promise<void>

说明

setEnabled 与 setMuted 的区别在于setMuted 调用该方法响应速度更快且不影响音视频设备采集状态,例如调用setEnabled 停用摄像头轨道时,摄像头指示灯会关闭,而setMuted 不会关闭指示灯;

setEnabledsetMuted不能同时调用;

setMuted()

发送或暂停发送该轨道的媒体数据。

如果该轨道已发布,调用 setMuted后,远端会触发 user-info-updated 事件。

类型签名

setMuted(muted: boolean): Promise<void>;

参数

参数

参数

描述

muted

boolean

发送或暂停发送该轨道的媒体数据 - true: 发送媒体数据 - false: 暂停发送媒体数据

返回

Promise<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