MicrophoneAudioTrack

最近更新时间:2023-11-06 02:37:12

继承

属性

isPlaying

isPlaying: boolean

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

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

trackMediaType

trackMediaType: "audio" | *"video"

媒体轨道的类型:

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

方法

close

close(): void

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

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

如果释放的轨道处于发布状态时,收到track-ended时应执行取消发布操作。

track.on("track-ended", () => {
    // 建议本地发布之后 设置一个变量做为本地有无发布的判断条件,在取消发布前做一下判断,
    // 并且在取消判断后对该值进行取反操作方便下次做判断;
    client.unpublish(track);
});

返回值 void


getListeners

getListeners(event: string): Function[]

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

参数

  • event: string

    事件名称。

返回值 Function[]


getMediaStreamTrack

getMediaStreamTrack(): MediaStreamTrack

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

返回值 MediaStreamTrack

一个 MediaStreamTrack 对象。


getTrackId

getTrackId(): string

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

返回值 string

媒体轨道 ID。


getTrackLabel

getTrackLabel(): string

获取本地轨道的来源描述。

返回值 string

可能返回以下值:

  • 如果是通过 createMicrophoneAudioTrackcreateCameraVideoTrack 创建的轨道,返回 MediaDeviceInfo.label 字段。
  • 如果是通过 createScreenVideoTrack 创建的轨道,返回屏幕共享的 sourceId
  • 如果是 createCustomAudioTrackcreateCustomVideoTrack 创建的轨道,返回 MediaStreamTrack.label 字段。

getVolumeLevel

  • getVolumeLevel(): number

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

返回值 number

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


off

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

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

参数

  • event: string

    指定事件的名称。

  • listener: Function

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

返回值 void


on

on(event: "track-ended", listener: event_track_ended): void

如果释放的轨道处于发布状态时,收到track-ended时应执行取消发布操作。

track.on("track-ended", () => {
    // 建议本地发布之后 设置一个变量做为本地有无发布的判断条件,在取消发布前做一下判断,
    // 并且在取消判断后对该值进行取反操作方便下次做判断;
    client.unpublish(track);
});

参数

返回值 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


setDevice

setDevice(deviceId: string): Promise<void>

设置负责采集音频数据的麦克风设备。

在发布前和发布后均可调用此方法。

参数

返回值 Promise<void>


setEnabled

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

启用/禁用该轨道。

轨道禁用后,播放和发布都将被停止。

禁用轨道不会触发 LocalTrack.on("track-ended") 事件。

参数

  • enabled: boolean

    是否启用该轨道:

    • true: 启用该轨道.
    • false: 禁用该轨道.

返回值 Promise<void>


setMuted

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

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

如果该轨道已发布,调用 setMuted(true) 后,远端会触发 user-unpublished 事件。再调用 setMuted(false) 后,远端会触发 user-published 事件。

参数

  • muted: boolean

    是否发送该轨道的媒体数据:

    • true: 暂停发送该轨道的媒体数据。
    • false: 恢复发送该轨道的媒体数据。

返回值 Promise<void>


setVolume

setVolume(volume: number): void

设置本地音频轨道的音量。

参数

  • volume: number

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

返回值 void


stop

stop(): *void

停止播放。

返回值 void