ZegoCustomAudioSource
2026-08-04
ZegoCustomAudioSource
Declared in ZegoCustomAudioSource.java
方法
getIndex
getIndex
public int getIndex()获取自定义音频源实例索引。
Declared in
ZegoCustomAudioSource.java自定义音频源实例索引。
startCapture
startCapture
public int startCapture()启动自定义音频源采集。
Declared in
ZegoCustomAudioSource.java启动自定义音频源采集。
- 业务场景：通常用于需要在不同的音频采集源之间切换的场景下。
- 调用时机：在创建自定义音频源 [createCustomAudioSource] 后调用生效。
- 支持版本：3.25.0 及以上。
- 使用限制：无。
- 注意事项：ZegoCustomAudioSource 仅支持作为混音源使用，不支持作为主采集源使用。
接口调用结果。
stopCapture
stopCapture
public int stopCapture()停止自定义音频源采集。
Declared in
ZegoCustomAudioSource.java停止自定义音频源采集。
- 业务场景：通常用于需要在不同的音频采集源之间切换的场景下。
- 调用时机：在创建自定义音频源 [createCustomAudioSource] 后调用生效。
- 支持版本：3.25.0 及以上。
- 使用限制：无。
- 注意事项：ZegoCustomAudioSource 仅支持作为混音源使用，不支持作为主采集源使用。
接口调用结果。
enableAEC
enableAEC
public int enableAEC(boolean enable)启用自定义音频源回声消除。
Declared in
ZegoCustomAudioSource.java参数
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | boolean | 是否启用回声消除。 |
详情
启用自定义音频源回声消除。
- 业务场景：通常用于需要在不同的音频采集源之间切换的场景下。
- 调用时机：在创建自定义音频源 [createCustomAudioSource] 后调用生效。
- 支持版本：3.25.0 及以上。
- 使用限制：无。
- 注意事项：ZegoCustomAudioSource 仅支持作为混音源使用，不支持作为主采集源使用。
返回值
接口调用结果。
setVolume
setVolume
public int setVolume(int volume)设置自定义音频源音量。
Declared in
ZegoCustomAudioSource.java参数
| 名称 | 类型 | 描述 |
|---|---|---|
| volume | int | 音量大小，范围为 0 ~ 100。 |
详情
设置自定义音频源的音量大小。
- 业务场景：通常用于需要在不同的音频采集源之间切换的场景下。
- 调用时机：在创建自定义音频源 [createCustomAudioSource] 后调用生效。
- 支持版本：3.25.0 及以上。
- 使用限制：音量范围为 0 ~ 100。
- 注意事项：ZegoCustomAudioSource 仅支持作为混音源使用，不支持作为主采集源使用。
返回值
接口调用结果。
mute
mute
public int mute(boolean mute)静音或取消静音自定义音频源。
Declared in
ZegoCustomAudioSource.java参数
| 名称 | 类型 | 描述 |
|---|---|---|
| mute | boolean | 是否静音自定义音频源。 |
详情
静音或取消静音自定义音频源的音频数据。
- 业务场景：通常用于需要在不同的音频采集源之间切换的场景下。
- 调用时机：在创建自定义音频源 [createCustomAudioSource] 后调用生效。
- 支持版本：3.25.0 及以上。
- 使用限制：无。
- 注意事项：ZegoCustomAudioSource 仅支持作为混音源使用，不支持作为主采集源使用。
返回值
接口调用结果。
pushAudioFrame
pushAudioFrame
public int pushAudioFrame(ByteBuffer data, int dataLength, ZegoAudioFrameParam param)推送音频帧到自定义音频源。
Declared in
ZegoCustomAudioSource.java参数
| 名称 | 类型 | 描述 |
|---|---|---|
| data | ByteBuffer | PCM buffer 数据。注意必须是 DirectByteBuffer 类型，可以通过 allocateDirect() 构造。 |
| dataLength | int | buffer 数据的总长度。 |
| param | ZegoAudioFrameParam | 该 PCM 音频帧的参数。 |
详情
推送音频帧到自定义音频源。
- 业务场景：通常用于开发者自己管理音频数据采集，并将音频帧输入到指定自定义音频源的场景。
- 调用时机：在创建自定义音频源 [createCustomAudioSource] 后调用生效。
- 支持版本：3.25.0 及以上。
- 使用限制：无。
- 注意事项：ZegoCustomAudioSource 仅支持作为混音源使用，不支持作为主采集源使用。
返回值
接口调用结果。