原始音频数据
registerAudioFrameObserver
注册音频观测器对象。
virtual int registerAudioFrameObserver(IAudioFrameObserver* observer) = 0;
该方法用于注册音频观测器对象，即注册回调。当需要 SDK 给出 onMixedAudioFrame、onRecordAudioFrame、onPlaybackAudioFrame 或 onEarMonitoringAudioFrame 等回调时，需要使用该方法注册回调。
注意： 该方法需要在加入频道前调用。
参数
| 参数名 | 描述 |
|---|---|
observer | 接口对象实例。详见 |
返回值
-
0：方法调用成功。
-
< 0：方法调用失败。详见
错误码了解详情和解决建议。
setMixedAudioFrameParameters
设置 onMixedAudioFrame 报告的音频数据格式。
virtual int setMixedAudioFrameParameters(int sampleRate, int channel, int samplesPerCall) = 0;
参数
| 参数名 | 描述 |
|---|---|
sampleRate | 音频数据采样率 (Hz)，可设置为 |
channel | 音频数据声道数，可设置为 |
samplesPerCall | 音频数据采样点数。旁路推流场景下通常设为 |
返回值
-
0: 方法调用成功。
-
< 0: 方法调用失败。详见
错误码了解详情和解决建议。
setPlaybackAudioFrameBeforeMixingParameters
设置 onPlaybackAudioFrameBeforeMixing 报告的音频数据格式。
virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel) = 0;
参数
| 参数名 | 描述 |
|---|---|
sampleRate | 音频数据采样率 (Hz)，可设置为 |
channel | 音频数据声道数，可设置为 |
返回值
-
0: 方法调用成功。
-
< 0: 方法调用失败。详见
错误码了解详情和解决建议。
setPlaybackAudioFrameParameters
设置播放的音频格式。
virtual int setPlaybackAudioFrameParameters(int sampleRate,
int channel,
RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
int samplesPerCall) = 0;
该方法设置 onPlaybackAudioFrame 回调数据的格式。
注意：
-
该方法需要在加入频道前调用。
-
SDK 会通过该方法中的
samplesPerCall、sampleRate和channel参数计算出采样间隔，计算公式为采样间隔 =samplesPerCall/(sampleRate×channel)。请确保采样间隔不小于 0.01 秒。SDK 会根据该采样间隔触发onPlaybackAudioFrame回调。
参数
| 参数名 | 描述 |
|---|---|
sampleRate |
|
channel |
|
mode | 音频帧的使用模式，详见 |
samplesPerCall |
|
返回值
-
0：方法调用成功。
-
< 0：方法调用失败。详见
错误码了解详情和解决建议。
setRecordingAudioFrameParameters
设置采集的原始音频数据格式。
virtual int setRecordingAudioFrameParameters(int sampleRate,
int channel,
RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
int samplesPerCall) = 0;
该方法设置 onRecordAudioFrame 回调的采集音频格式。
注意：
-
该方法需要在加入频道前调用。
-
SDK 会通过该方法中的
samplesPerCall、sampleRate和channel参数计算出采样间隔，计算公式为采样间隔 =samplesPerCall/(sampleRate×channel)。请确保采样间隔不小于 0.01 秒。SDK 会根据该采样间隔触发onRecordAudioFrame回调。
参数
| 参数名 | 描述 |
|---|---|
sampleRate |
|
channel |
|
mode | 音频帧的使用模式，详见 |
samplesPerCall |
|
返回值
-
0：方法调用成功。
-
< 0：方法调用失败。详见
错误码了解详情和解决建议。
onPlaybackAudioFrameBeforeMixing
获得混音前的指定用户的声音。
virtual bool onPlaybackAudioFrameBeforeMixing(const char* channelId, rtc::uid_t uid, AudioFrame& audioFrame) = 0;
参数
| 参数名 | 描述 |
|---|---|
channelId | 频道 ID。 |
uid | 指定用户的用户 ID。 |
audioFrame | 音频原始数据。详见 |
返回值
无实际含义。
所属接口类getMixedAudioParams
设置 onMixedAudioFrame 回调数据的格式。
virtual AudioParams getMixedAudioParams() = 0;
你需要在调用 registerAudioFrameObserver 方法时注册该回调。成功注册音频数据观测器后，SDK 会触发该回调，你可以在该回调的返回值中设置 SDK 采集和播放音频混音后的数据格式。
注意：
SDK 会通过你在返回值中设置的 AudioParams 计算采样间隔触发 onMixedAudioFrame 回调。计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。
请确保采样间隔不小于 0.01 秒。
返回值
SDK 采集和播放音频混音后的音频数据，详见 AudioParams。
getObservedAudioFramePosition
设置音频观测位置。
virtual int getObservedAudioFramePosition() = 0;
成功注册音频数据观测器后，SDK 会在每个特定的音频帧处理节点通过该回调来判断是否触发如下回调：
你可以根据场景需求，通过修改 getObservedAudioFramePosition 的返回值，设置你需要观测的某个或多个位置。
注解观测多个位置时，需要使用 |（或运算符）。为降低设备耗能，你可以根据实际需求适当减少观测位置。
返回值
返回设置观测位置的位掩码，取值如下：
-
AUDIO_FRAME_POSITION_PLAYBACK (0x0001)：该位置可观测所有远端用户混音后的播放音频，对应
onPlaybackAudioFrame回调。 -
AUDIO_FRAME_POSITION_RECORD (0x0002)：该位置可观测采集的本地用户的音频，对应
onRecordAudioFrame回调。 -
AUDIO_FRAME_POSITION_MIXED (0x0004)：该位置可观测本地和所有远端用户混音后的音频，对应
onMixedAudioFrame回调。 -
AUDIO_FRAME_POSITION_BEFORE_MIXING (0x0008)：该位置可观测单个远端用户混音前的音频，对应
onPlaybackAudioFrameBeforeMixing回调。 -
AUDIO_FRAME_POSITION_EAR_MONITORING (0x0010)：该位置可观测单个本地用户耳返的音频，对应
onEarMonitoringAudioFrame回调。
getPlaybackAudioParams
设置 onPlaybackAudioFrame 回调数据的格式。
virtual AudioParams getPlaybackAudioParams() = 0;
你需要在调用 registerAudioFrameObserver 方法时注册该回调。成功注册音频数据观测器后，SDK 会触发该回调，你可以在该回调的返回值中设置 SDK 播放的音频数据格式。
注意：
SDK 会通过你在返回值中设置的 AudioParams 计算采样间隔触发 onPlaybackAudioFrame 回调。计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。
请确保采样间隔不小于 0.01 秒。
返回值
SDK 播放的音频数据，详见 AudioParams。
getRecordAudioParams
设置 onRecordAudioFrame 回调数据的格式。
virtual AudioParams getRecordAudioParams() = 0;
你需要在调用 registerAudioFrameObserver 方法时注册该回调。成功注册音频数据观测器后，SDK 会触发该回调，你可以在该回调的返回值中设置 SDK 采集的音频数据格式。
注意：
SDK 会通过你在返回值中设置的 AudioParams 计算采样间隔触发 onRecordAudioFrame 回调。计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。
请确保采样间隔不小于 0.01 秒。
返回值
SDK 采集的音频数据，详见 AudioParams。
onPlaybackAudioFrame
获得播放的原始音频数据。
virtual bool onPlaybackAudioFrame(const char* channelId, AudioFrame& audioFrame) = 0;
为保证播放的音频数据格式符合预期，你可以在如下两种方法中任选一种，设置音频的数据格式：
-
方法一：调用
setPlaybackAudioFrameParameters设置音频数据格式后，调用registerAudioFrameObserver注册音频观测器对象，SDK 会根据该方法中的参数计算采样间隔，并根据该采样间隔触发onPlaybackAudioFrame回调。 -
方法二：调用
registerAudioFrameObserver注册音频观测器对象后，在getObservedAudioFramePosition回调的返回值中设置具体的音频观测位置，然后在getPlaybackAudioParams回调的返回值中设置音频数据格式，SDK 会根据该回调的返回值计算采样间隔，并根据该采样间隔触发onPlaybackAudioFrame回调。
注：
- 方法一的优先级高于方法二，如果使用方法一设置音频数据格式，方法二设置无效。
参数
| 参数名 | 描述 |
|---|---|
audioFrame | 音频原始数据。详见 |
channelId | 频道 ID。 |
返回值
无实际含义。
所属接口类onRecordAudioFrame
获得采集的原始音频数据。
virtual bool onRecordAudioFrame(const char* channelId, AudioFrame& audioFrame) = 0;
为保证采集的音频数据格式符合预期，你可以在如下两种方法中任选一种，设置音频的数据格式：
-
方法一：调用
setRecordingAudioFrameParameters设置音频数据格式后，调用registerAudioFrameObserver注册音频观测器对象，SDK 会根据该方法中的参数计算采样间隔，并根据该采样间隔触发onRecordAudioFrame回调。 -
方法二：调用
registerAudioFrameObserver注册音频观测器对象后，在getObservedAudioFramePosition回调的返回值中设置具体的音频观测位置，然后在getRecordAudioParams回调的返回值中设置音频数据格式，SDK 会根据该回调的返回值计算采样间隔，并根据该采样间隔触发onRecordAudioFrame回调。
注：
- 方法一的优先级高于方法二，如果使用方法一设置音频数据格式，方法二设置无效。
参数
| 参数名 | 描述 |
|---|---|
audioFrame | 音频原始数据。详见 |
channelId | 频道 ID。 |
返回值
无实际含义。
所属接口类onMixedAudioFrame
获取采集和播放音频混音后的数据。
virtual bool onMixedAudioFrame(const char* channelId, AudioFrame& audioFrame) = 0;
为保证采集和播放混音后的音频数据格式符合预期，你可以在如下两种方法中任选一种，设置音频的数据格式：
-
方法一：调用
setMixedAudioFrameParameters设置音频数据格式后，调用registerAudioFrameObserver注册音频观测器对象，SDK 会根据该方法中的参数计算采样间隔，并根据该采样间隔触发onMixedAudioFrame回调。 -
方法二：调用
registerAudioFrameObserver注册音频观测器对象后，在getObservedAudioFramePosition回调的返回值中设置具体的音频观测位置，然后在getMixedAudioParams回调的返回值中设置音频数据格式，SDK 会根据该回调的返回值计算采样间隔，并根据该采样间隔触发onMixedAudioFrame回调。
注：
- 方法一的优先级高于方法二，如果使用方法一设置音频数据格式，方法二设置无效。
参数
| 参数名 | 描述 |
|---|---|
audioFrame | 音频原始数据。详见 |
channelId | 频道 ID。 |
返回值
无实际含义。
所属接口类