Interface IMicrophoneAudioTrack

可以通过 AgoraRTC.createMicrophoneAudioTrack 来获取。

Properties

enabled

enabled: boolean

Inherited from IBufferSourceAudioTrack.enabled

本地轨道当前的启用状态。

isPlaying

isPlaying: boolean

Inherited from IBufferSourceAudioTrack.isPlaying

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

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

muted

muted: boolean

Inherited from IBufferSourceAudioTrack.muted

本地媒体轨道当前的静音状态。

processorDestination

processorDestination: IAudioProcessor

Inherited from IBufferSourceAudioTrack.processorDestination

自从

4.10.0

本地音频轨道上当前媒体处理链路的最终节点。

trackMediaType

trackMediaType: "audio"|"video"

Inherited from IBufferSourceAudioTrack.trackMediaType

媒体轨道的类型：

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

Methods

close

close(): void

Inherited from IBufferSourceAudioTrack.close

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

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

Returns
返回类型	描述
void

getListeners

getListeners(event: string): Function[]

Inherited from EventEmitter.getListeners

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

Parameters
参数名	描述
`event`string required	事件名称。

Returns
返回类型	描述
Function[]

getMediaStreamTrack

getMediaStreamTrack(): MediaStreamTrack

Inherited from IBufferSourceAudioTrack.getMediaStreamTrack

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

Returns
返回类型	描述
MediaStreamTrack	一个 MediaStreamTrack 对象。

getRTCRtpTransceiver

getRTCRtpTransceiver(type?: StreamType): RTCRtpTransceiver | undefined

Inherited from IBufferSourceAudioTrack.getRTCRtpTransceiver

获取当前轨道的 RTCRtpTransceiver 实例。

该方法目前主要用于视频流的端到端加密（Beta）。

如果 SDK 发生断线重连，当前轨道对应的 RTCRtpTransceiver 实例可能会发生变化。你可以通过以下回调来获取新的 RTCRtpTransceiver 实例：

本地轨道：ILocalTrack.transceiver-updated

远端轨道：IRemoteTrack.transceiver-updated

Parameters
参数名	描述
`type`StreamType optional	视频流的类型。详见 StreamType。

Returns
返回类型	描述
RTCRtpTransceiver \| undefined	当前轨道的 `RTCRtpTransceiver` 实例。

getStats

getStats(): LocalAudioTrackStats

Inherited from IBufferSourceAudioTrack.getStats

Overrides ILocalTrack.getStats

获取本地音频轨道的质量相关信息。

deprecated

自 v4.1.0 起废弃，请使用 AgoraRTCClient.getLocalVideoStats 和 AgoraRTCClient.getLocalAudioStats。

Returns
返回类型	描述
LocalAudioTrackStats

getTrackId

getTrackId(): string

Inherited from IBufferSourceAudioTrack.getTrackId

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

Returns
返回类型	描述
string	媒体轨道 ID。

getTrackLabel

getTrackLabel(): string

Inherited from IBufferSourceAudioTrack.getTrackLabel

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

Returns
返回类型	描述
string	可能返回以下值：如果是通过 `createMicrophoneAudioTrack` 或 `createCameraVideoTrack` 创建的轨道，返回 MediaDeviceInfo.label 字段。如果是通过 `createScreenVideoTrack` 创建的轨道，返回屏幕共享的 `sourceId`。如果是 `createCustomAudioTrack` 或 `createCustomVideoTrack` 创建的轨道，返回 MediaStreamTrack.label 字段。

getVolumeLevel

getVolumeLevel(): number

Inherited from IBufferSourceAudioTrack.getVolumeLevel

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

Returns
返回类型	描述
number	音量等级值，范围 [0, 1]，1 代表理论最大音量。通常该值大于 0.6 代表用户在持续说话。

off

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

Inherited from EventEmitter.off

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

Parameters
参数名	描述
`event`string required	指定事件的名称。
`listener`Function required	监听事件时传入的回调函数。

Returns
返回类型	描述
void

on

on [1/3]

on(event: "track-updated", listener: typeof event_track_updated): void

Inherited from ILocalAudioTrack.on

Overrides EventEmitter.on

Parameters
参数名	描述
`event`"track-updated" required	事件名称。
`listener`typeof event_track_updated required	详见 track-updated。

Returns
返回类型	描述
void

on [2/3]

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

Inherited from ILocalAudioTrack.on

Overrides EventEmitter.on

Parameters
参数名	描述
`event`"track-ended" required	事件名称。
`listener`typeof event_track_ended required	详见 track-ended。

Returns
返回类型	描述
void

on [3/3]

on(event: "transceiver-updated", listener: typeof event_transceiver_updated): void

Inherited from ILocalAudioTrack.on

Overrides EventEmitter.on

添加事件监听器。

Parameters
参数名	描述
`event`"transceiver-updated" required	事件名称。
`listener`typeof event_transceiver_updated required	详见 ILocalTrack.transceiver-updated。

Returns
返回类型	描述
void

once

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

Inherited from EventEmitter.once

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

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

Parameters
参数名	描述
`event`string required	指定事件的名称。
`listener`Function required	传入的回调函数。

Returns
返回类型	描述
void

pipe

pipe(processor: IAudioProcessor): IAudioProcessor

Inherited from IBufferSourceAudioTrack.pipe

自从

4.10.0

将 Processor 注入本地音频轨道。

Parameters
参数名	描述
`processor`IAudioProcessor required	`Processor` 实例。每个插件均有对应类型的 `Processor`。

Returns
返回类型	描述
IAudioProcessor	`Processor` 实例。

play

play(): void

Inherited from IBufferSourceAudioTrack.play

Overrides ILocalTrack.play

播放本地音频轨道。

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

Returns
返回类型	描述
void

removeAllListeners

removeAllListeners(event?: string): void

Inherited from EventEmitter.removeAllListeners

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

Parameters
参数名	描述
`event`string optional	指定事件的名称，如果没有指定事件，则取消所有事件的所有监听。

Returns
返回类型	描述
void

setAudioFrameCallback

setAudioFrameCallback(audioFrameCallback: null | function, frameSize?: number): void

Inherited from IBufferSourceAudioTrack.setAudioFrameCallback

设置原始音频数据（PCM）回调。

设置成功后，SDK 会不断地将本地音频轨道的音频帧以 AudioBuffer 的形式通过回调返回。

你可以通过 frameSize 来设置每次回调中音频帧的大小。该设置也会影响回调的间隔，frameSize 越大，每次回调的音频数据越多，回调间隔越长。

JavaScript

track.setAudioFrameCallback((buffer) => {
  for (let channel = 0; channel < buffer.numberOfChannels; channel += 1) {
    // Float32Array with PCM data
    const currentChannelData = buffer.getChannelData(channel);
    console.log("PCM data in channel", channel, currentChannelData);
  }
}, 2048);

// ....
// Stop getting the raw audio data
track.setAudioFrameCallback(null);

Parameters
参数名	描述
`audioFrameCallback`null \| function required	用于接收 AudioBuffer 的回调函数。设为 `null` 后，SDK 就会停止获取音频原始数据。
`frameSize`number optional	每次回调的 `AudioBuffer` 中每个声道包含的采样数据个数，只能设为下列值：256, 512, 1024, 2048, 4096, 8192, 16384。默认为 4096。

Returns
返回类型	描述
void

setDevice

setDevice(deviceId: string): Promise<void>

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

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

Parameters
参数名	描述
`deviceId`string required	指定设备的设备 Id，可以通过 AgoraRTC.getMicrophones 获取。

Returns
返回类型	描述
Promise<void>

setEnabled

setEnabled(enabled: boolean): Promise<void>

Overrides IBufferSourceAudioTrack.setEnabled

自从

4.0.0

启用/禁用该轨道。

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

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

如果该轨道已发布，禁用轨道后，远端会触发 user-unpublished 事件。重新启用后，远端会触发 user-published 事件。

setEnabled 和 setMuted 不能同时调用。

Parameters
参数名	描述
`enabled`boolean required	是否启用该轨道: `true`: 启用该轨道. `false`: 禁用该轨道.

Returns
返回类型	描述
Promise<void>

setMuted

setMuted(muted: boolean): Promise<void>

Inherited from IBufferSourceAudioTrack.setMuted

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

自从

4.6.0

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

与 setEnabled 相比，调用该方法响应速度更快且不影响视频采集状态，详见 setEnabled 和 setMuted 有什么区别？。

setEnabled 和 setMuted 不能同时调用。

Parameters
参数名	描述
`muted`boolean required	是否发送该轨道的媒体数据: `true`: 暂停发送该轨道的媒体数据。 `false`: 恢复发送该轨道的媒体数据。

Returns
返回类型	描述
Promise<void>

setPlaybackDevice

setPlaybackDevice(deviceId: string): Promise<void>

Inherited from IBufferSourceAudioTrack.setPlaybackDevice

自从

4.1.0

注意事项：

自 v4.7.0 起，该方法不再生效。请改用 IRemoteAudioTrack.setPlaybackDevice。

设置本地播放远端音频流的设备（扬声器）。

Parameters
参数名	描述
`deviceId`string required	设备 ID，可以通过 getPlaybackDevices 方法获取。

Returns
返回类型	描述
Promise<void>

setVolume

setVolume(volume: number): void

Inherited from IBufferSourceAudioTrack.setVolume

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

Parameters
参数名	描述
`volume`number required	音量值，范围 [0, 1000], 0 代表静音，100 代表原始音量。100 以上会使用 WebAudio 进行音量增益。如果本地音频轨道已经发布，修改音量会影响远端听到的音量大小。

Returns
返回类型	描述
void

stop

stop(): void

Inherited from IBufferSourceAudioTrack.stop

停止播放。

Returns
返回类型	描述
void

unpipe

unpipe(): void

Inherited from IBufferSourceAudioTrack.unpipe

自从

4.10.0

取消本地音频轨道上注入的 Processor。

Returns
返回类型	描述
void

Properties

enabled

isPlaying

muted

processorDestination

trackMediaType

Methods

close

getListeners

getMediaStreamTrack

getRTCRtpTransceiver

getStats

deprecated

getTrackId

getTrackLabel

getVolumeLevel

off

on

on [1/3]

on [2/3]

on [3/3]

once

pipe

play

removeAllListeners

setAudioFrameCallback

setDevice

setEnabled

setMuted

setPlaybackDevice

setVolume

stop

unpipe

咨询电话

咨询电话

PropertiesCopy Anchor Link

enabledCopy Anchor Link

isPlayingCopy Anchor Link

mutedCopy Anchor Link

processorDestinationCopy Anchor Link

trackMediaTypeCopy Anchor Link

MethodsCopy Anchor Link

closeCopy Anchor Link

getListenersCopy Anchor Link

getMediaStreamTrackCopy Anchor Link

getRTCRtpTransceiverCopy Anchor Link

getStatsCopy Anchor Link

deprecatedCopy Anchor Link

getTrackIdCopy Anchor Link

getTrackLabelCopy Anchor Link

getVolumeLevelCopy Anchor Link

offCopy Anchor Link

onCopy Anchor Link

on [1/3]Copy Anchor Link

on [2/3]Copy Anchor Link

on [3/3]Copy Anchor Link

onceCopy Anchor Link

pipeCopy Anchor Link

playCopy Anchor Link

removeAllListenersCopy Anchor Link

setAudioFrameCallbackCopy Anchor Link

setDeviceCopy Anchor Link

setEnabledCopy Anchor Link

setMutedCopy Anchor Link

setPlaybackDeviceCopy Anchor Link

setVolumeCopy Anchor Link

stopCopy Anchor Link

unpipeCopy Anchor Link

咨询电话

咨询电话

Properties

enabled

isPlaying

muted

processorDestination

trackMediaType

Methods

close

getListeners

getMediaStreamTrack

getRTCRtpTransceiver

getStats

deprecated

getTrackId

getTrackLabel

getVolumeLevel

off

on

on [1/3]

on [2/3]

on [3/3]

once

pipe

play

removeAllListeners

setAudioFrameCallback

setDevice

setEnabled

setMuted

setPlaybackDevice

setVolume

stop

unpipe