# 原始音频数据 (/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## RegisterAudioFrameObserver [#registeraudioframeobserver]
注册音频观测器对象。
```csharp
public abstract int RegisterAudioFrameObserver(IAudioFrameObserver audioFrameObserver, AUDIO_FRAME_POSITION position, OBSERVER_MODE mode = OBSERVER_MODE.INTPTR);
```
该方法用于注册音频观测器对象,即注册回调。当需要 SDK 触发 [OnMixedAudioFrame](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#callback_iaudioframeobserverbase_onmixedaudioframe)、[OnRecordAudioFrame](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#callback_iaudioframeobserverbase_onrecordaudioframe)、[OnPlaybackAudioFrame](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#callback_iaudioframeobserverbase_onplaybackaudioframe)、[OnPlaybackAudioFrameBeforeMixing](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#callback_iaudioframeobserver_onplaybackaudioframebeforemixing) 和 [OnEarMonitoringAudioFrame](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#callback_iaudioframeobserverbase_onearmonitoringaudioframe) 回调时,需要调用该方法注册回调。
### 调用时机 [#调用时机]
该方法需要在加入频道前调用。
### 调用限制 [#调用限制]
无。
### 参数 [#参数]
接口对象实例。详见 [IAudioFrameObserver](/zh-CN/api-reference/rtc/csharp-windows/rtc-interface-class#class_iaudioframeobserver)。如果传入 NULL,则表示取消注册。建议在收到 [OnLeaveChannel](/zh-CN/api-reference/rtc/csharp-windows/channel#callback_irtcengineeventhandler_onleavechannel) 后调用,来释放音频观测器对象。
音频数据回调模式,详见 [OBSERVER_MODE](/zh-CN/api-reference/rtc/csharp-windows/enum-observermode)。
### 返回值 [#返回值]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
## SetEarMonitoringAudioFrameParameters [#setearmonitoringaudioframeparameters]
设置耳返的音频数据格式。
```csharp
public abstract int SetEarMonitoringAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall);
```
### 详情 [#详情]
该方法用于设置 [OnEarMonitoringAudioFrame](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#callback_iaudioframeobserverbase_onearmonitoringaudioframe) 回调的耳返音频数据格式。
:::caution
注意:
- 调用该方法前,你需要先调用 [EnableInEarMonitoring](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-capture),将 includeAudioFilters 设置为 EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS 或 EAR_MONITORING_FILTER_NOISE_SUPPRESSION。
- SDK 会通过该方法中的 samplesPerCall、sampleRate 和 channel 参数计算出采样间隔,计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。请确保采样间隔不小于 0.01 秒。SDK 会根据该采样间隔触发 OnEarMonitoringAudioFrame 回调。
:::
### 参数 [#参数-1]
OnEarMonitoringAudioFrame 中报告音频的采样率 (Hz),可设置为 8000、 16000、 32000、44100 或 48000。
OnEarMonitoringAudioFrame 中报告音频的声道数,可设置为 1 或 2:
- 1: 单声道。
- 2: 双声道。
音频帧的使用模式,详见 [RAW_AUDIO_FRAME_OP_MODE_TYPE](/zh-CN/api-reference/rtc/csharp-windows/enum-rawaudioframeopmodetype)。
OnEarMonitoringAudioFrame 中报告的音频的采样点数,如旁路推流应用中通常为 1024。
### 返回值 [#返回值-1]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类]
- [IRtcEngine](/zh-CN/api-reference/rtc/csharp-windows/rtc-interface-class#class_irtcengine)
## SetMixedAudioFrameParameters [#setmixedaudioframeparameters]
设置采集和播放音频混音后的原始音频数据格式。
```csharp
public abstract int SetMixedAudioFrameParameters(int sampleRate, int channel, int samplesPerCall);
```
SDK 会通过该方法中的 samplesPerCall、sampleRate 和 channel 参数计算出采样间隔,计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。请确保采样间隔不小于 0.01 秒。SDK 会根据该采样间隔触发 [OnMixedAudioFrame](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#callback_iaudioframeobserverbase_onmixedaudioframe) 回调。
### 调用时机 [#调用时机-1]
该方法需要在加入频道前调用。
### 调用限制 [#调用限制-1]
无。
### 参数 [#参数-2]
音频数据的采样率 (Hz),可设置为 8000、 16000、 32000、44100 或 48000。
音频数据的声道数,可设置为 1 或 2:
- 1: 单声道。
- 2: 双声道。
音频数据的采样点数,如旁路推流应用中通常为 1024。
### 返回值 [#返回值-2]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-1]
- [IRtcEngine](/zh-CN/api-reference/rtc/csharp-windows/rtc-interface-class#class_irtcengine)
## SetPlaybackAudioFrameBeforeMixingParameters [#setplaybackaudioframebeforemixingparameters]
设置混音前的原始音频播放数据格式。
```csharp
public abstract int SetPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel);
```
SDK 会根据该采样间隔触发 [OnPlaybackAudioFrameBeforeMixing](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#callback_iaudioframeobserver_onplaybackaudioframebeforemixing) 回调。
### 调用时机 [#调用时机-2]
该方法需要在加入频道前调用。
### 调用限制 [#调用限制-2]
无。
### 参数 [#参数-3]
音频数据的采样率 (Hz),可设置为 8000、 16000、 32000、44100 或 48000。
音频数据的声道数,可设置为 1 或 2:
- 1: 单声道。
- 2: 双声道。
### 返回值 [#返回值-3]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-2]
- [IRtcEngine](/zh-CN/api-reference/rtc/csharp-windows/rtc-interface-class#class_irtcengine)
## SetPlaybackAudioFrameParameters [#setplaybackaudioframeparameters]
设置播放的原始音频数据格式。
```csharp
public abstract int SetPlaybackAudioFrameParameters(int sampleRate, int channel,
RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall);
```
SDK 会通过该方法中的 samplesPerCall、sampleRate 和 channel 参数计算出采样间隔,计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。请确保采样间隔不小于 0.01 秒。SDK 会根据该采样间隔触发 [OnPlaybackAudioFrame](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#callback_iaudioframeobserverbase_onplaybackaudioframe) 回调。
### 调用时机 [#调用时机-3]
该方法需要在加入频道前调用。
### 调用限制 [#调用限制-3]
无。
### 参数 [#参数-4]
音频数据的采样率 (Hz),可设置为 8000、 16000、 32000、44100 或 48000。
音频数据的声道数,可设置为 1 或 2:
- 1: 单声道。
- 2: 双声道。
音频帧的使用模式,详见 [RAW_AUDIO_FRAME_OP_MODE_TYPE](/zh-CN/api-reference/rtc/csharp-windows/enum-rawaudioframeopmodetype)。
音频数据的采样点数,如旁路推流应用中通常为 1024。
### 返回值 [#返回值-4]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-3]
- [IRtcEngine](/zh-CN/api-reference/rtc/csharp-windows/rtc-interface-class#class_irtcengine)
## SetRecordingAudioFrameParameters [#setrecordingaudioframeparameters]
设置采集的原始音频数据格式。
```csharp
public abstract int SetRecordingAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall);
```
SDK 会通过该方法中的 samplesPerCall、sampleRate 和 channel 参数计算出采样间隔,计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。请确保采样间隔不小于 0.01 秒。SDK 会根据该采样间隔触发 [OnRecordAudioFrame](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#callback_iaudioframeobserverbase_onrecordaudioframe) 回调。
### 调用时机 [#调用时机-4]
该方法需要在加入频道前调用。
### 调用限制 [#调用限制-4]
无。
### 参数 [#参数-5]
音频数据的采样率 (Hz),可设置为 8000、 16000、 32000、44100 或 48000。
音频数据的声道数,可设置为 1 或 2:
- 1: 单声道。
- 2: 双声道。
音频帧的使用模式,详见 [RAW_AUDIO_FRAME_OP_MODE_TYPE](/zh-CN/api-reference/rtc/csharp-windows/enum-rawaudioframeopmodetype)。
音频数据的采样点数,如旁路推流应用中通常为 1024。
### 返回值 [#返回值-5]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-4]
- [IRtcEngine](/zh-CN/api-reference/rtc/csharp-windows/rtc-interface-class#class_irtcengine)
## UnRegisterAudioFrameObserver [#unregisteraudioframeobserver]
取消注册音频帧观测器。
```csharp
public abstract int UnRegisterAudioFrameObserver();
```
### 返回值 [#返回值-6]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-5]
- [IRtcEngine](/zh-CN/api-reference/rtc/csharp-windows/rtc-interface-class#class_irtcengine)
## OnEarMonitoringAudioFrame [#onearmonitoringaudioframe]
获得耳返的原始音频数据。
```csharp
public virtual bool OnEarMonitoringAudioFrame(AudioFrame audioFrame)
{
return true;
}
```
### 详情 [#详情-1]
为保证耳返的音频数据格式符合预期,你可以在如下两种方法中任选一种,设置耳返音频数据格式:
- 方法一:调用 [SetEarMonitoringAudioFrameParameters](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#api_irtcengine_setearmonitoringaudioframeparameters) 设置音频数据格式后,调用 [RegisterAudioFrameObserver](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#api_imediaengine_registeraudioframeobserver) 注册音频观测器对象,SDK 会根据该方法中的参数计算采样间隔,并根据该采样间隔触发 OnEarMonitoringAudioFrame 回调。
- 方法二:调用 [RegisterAudioFrameObserver](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#api_imediaengine_registeraudioframeobserver) 注册音频观测器对象后,在 回调的返回值中设置具体的音频观测位置,然后在 回调的返回值中设置音频数据格式,SDK 会根据该回调的返回值计算采样间隔,并根据该采样间隔触发 OnEarMonitoringAudioFrame 回调。
:::note
注:
- 方法一的优先级高于方法二,如果已使用方法一设置了音频数据格式,则使用方法二的设置不生效。
:::
### 参数 [#参数-6]
音频原始数据。详见 [AudioFrame](/zh-CN/api-reference/rtc/csharp-windows/class-audioframe)。
### 返回值 [#返回值-7]
无实际含义。
## OnPlaybackAudioFrameBeforeMixing [#onplaybackaudioframebeforemixing]
获取所订阅的远端用户混音前的声音。
```csharp
public virtual bool OnPlaybackAudioFrameBeforeMixing(string channel_id,
uint uid,
AudioFrame audio_frame)
{
return false;
}
```
### 参数 [#参数-7]
频道 ID。
订阅的远端用户的 ID。
音频原始数据。详见 [AudioFrame](/zh-CN/api-reference/rtc/csharp-windows/class-audioframe)。
### 返回值 [#返回值-8]
无实际含义。
## OnPlaybackAudioFrame [#onplaybackaudioframe]
获得播放的原始音频数据。
```csharp
public virtual bool OnPlaybackAudioFrame(string channelId, AudioFrame audio_frame)
{
return true;
}
```
### 详情 [#详情-2]
为保证播放的音频数据格式符合预期,你可以在如下两种方法中任选一种,设置音频的数据格式:
- 方法一:调用 [SetPlaybackAudioFrameParameters](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#api_irtcengine_setplaybackaudioframeparameters) 设置音频数据格式后,调用 [RegisterAudioFrameObserver](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#api_imediaengine_registeraudioframeobserver) 注册音频观测器对象,SDK 会根据该方法中的参数计算采样间隔,并根据该采样间隔触发 OnPlaybackAudioFrame 回调。
- 方法二:调用 [RegisterAudioFrameObserver](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#api_imediaengine_registeraudioframeobserver) 注册音频观测器对象后,在 回调的返回值中设置具体的音频观测位置,然后在 回调的返回值中设置音频数据格式,SDK 会根据该回调的返回值计算采样间隔,并根据该采样间隔触发 OnPlaybackAudioFrame 回调。
:::note
注:
- 方法一的优先级高于方法二,如果使用方法一设置音频数据格式,方法二设置无效。
:::
### 参数 [#参数-8]
音频原始数据。详见 [AudioFrame](/zh-CN/api-reference/rtc/csharp-windows/class-audioframe)。
频道 ID。
### 返回值 [#返回值-9]
无实际含义。
## OnRecordAudioFrame [#onrecordaudioframe]
获得采集的原始音频数据。
```csharp
public virtual bool OnRecordAudioFrame(string channelId, AudioFrame audioFrame)
{
return true;
}
```
### 详情 [#详情-3]
为保证采集的音频数据格式符合预期,你可以在如下两种方法中任选一种,设置音频的数据格式:
- 方法一:调用 [SetRecordingAudioFrameParameters](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#api_irtcengine_setrecordingaudioframeparameters) 设置音频数据格式后,调用 [RegisterAudioFrameObserver](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#api_imediaengine_registeraudioframeobserver) 注册音频观测器对象,SDK 会根据该方法中的参数计算采样间隔,并根据该采样间隔触发 OnRecordAudioFrame 回调。
- 方法二:调用 [RegisterAudioFrameObserver](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#api_imediaengine_registeraudioframeobserver) 注册音频观测器对象后,在 回调的返回值中设置具体的音频观测位置,然后在 回调的返回值中设置音频数据格式,SDK 会根据该回调的返回值计算采样间隔,并根据该采样间隔触发 OnRecordAudioFrame 回调。
:::note
注:
- 方法一的优先级高于方法二,如果使用方法一设置音频数据格式,方法二设置无效。
:::
### 参数 [#参数-9]
音频原始数据。详见 [AudioFrame](/zh-CN/api-reference/rtc/csharp-windows/class-audioframe)。
频道 ID。
### 返回值 [#返回值-10]
无实际含义。
## OnMixedAudioFrame [#onmixedaudioframe]
获取采集和播放音频混音后的数据。
```csharp
public virtual bool OnMixedAudioFrame(string channelId, AudioFrame audio_frame)
{
return true;
}
```
### 详情 [#详情-4]
为保证采集和播放混音后的音频数据格式符合预期,你可以在如下两种方法中任选一种,设置音频的数据格式:
- 方法一:调用 [SetMixedAudioFrameParameters](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#api_irtcengine_setmixedaudioframeparameters) 设置音频数据格式后,调用 [RegisterAudioFrameObserver](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#api_imediaengine_registeraudioframeobserver) 注册音频观测器对象,SDK 会根据该方法中的参数计算采样间隔,并根据该采样间隔触发 OnMixedAudioFrame 回调。
- 方法二:调用 [RegisterAudioFrameObserver](/zh-CN/api-reference/rtc/csharp-windows/audio/audio-raw#api_imediaengine_registeraudioframeobserver) 注册音频观测器对象后,在 回调的返回值中设置具体的音频观测位置,然后在 回调的返回值中设置音频数据格式,SDK 会根据该回调的返回值计算采样间隔,并根据该采样间隔触发 OnMixedAudioFrame 回调。
:::note
注:
- 方法一的优先级高于方法二,如果使用方法一设置音频数据格式,方法二设置无效。
:::
### 参数 [#参数-10]
音频原始数据。详见 [AudioFrame](/zh-CN/api-reference/rtc/csharp-windows/class-audioframe)。
频道 ID。
### 返回值 [#返回值-11]
无实际含义。