音频观测器
介绍跟音频观测器相关的方法和回调。
UnRegisterAudioEncodedFrameObserver
取消注册音频编码数据观测器。
public abstract int UnRegisterAudioEncodedFrameObserver();
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
UnRegisterAudioFrameObserver
取消注册音频帧观测器。
public abstract int UnRegisterAudioFrameObserver();
返回值
- 0:方法调用成功。
- < 0:方法调用失败。
OnEarMonitoringAudioFrame
获得耳返的原始音频数据。
public virtual bool OnEarMonitoringAudioFrame(AudioFrame audioFrame) { return true; }
为保证耳返的音频数据格式符合预期,你可以调用 SetEarMonitoringAudioFrameParameters 设置音频数据格式后,调用 RegisterAudioFrameObserver 注册音频观测器对象,SDK 会根据该方法中的参数计算采样间隔,并根据该采样间隔触发 OnEarMonitoringAudioFrame 回调。
参数
- audioFrame
- 音频原始数据。详见 AudioFrame。
返回值
无实际含义。
OnFrame
已获取音频帧回调。
public virtual bool OnFrame(AudioPcmFrame frame) { return true; }
注册音频数据观测器后,每次接收到一帧音频帧时,都会触发该回调,报告音频帧信息。
参数
- frame
- 音频帧信息。详见 AudioPcmFrame。
返回值
无实际含义。
OnLocalAudioSpectrum
获取本地音频频谱。
public virtual bool OnLocalAudioSpectrum(AudioSpectrumData data) { return true; }
成功调用 RegisterAudioSpectrumObserver 实现 IAudioSpectrumObserver 中的 OnLocalAudioSpectrum 回调并调用 EnableAudioSpectrumMonitor 开启音频频谱监测后,SDK 会按照你设置的时间间隔触发该回调,报告编码后的本地音频数据的频谱。
参数
- data
- 本地用户的音频频谱数据。详见 AudioSpectrumData。
返回值
true
: 接收。false
: 不接收。
OnMixedAudioEncodedFrame
获取本地和所有远端用户混音后的音频编码数据。
public virtual void OnMixedAudioEncodedFrame(IntPtr frameBufferPtr, int length, EncodedAudioFrameInfo audioEncodedFrameInfo) { }
调用 RegisterAudioEncodedFrameObserver 并将音频编码内容设为 AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED 后,你可以通过该回调获取本地和所有远端用户混音、编码后的音频数据。
参数
- frameBufferPtr
- 音频 buffer。
- length
- 音频数据长度,单位为字节。
- audioEncodedFrameInfo
- 编码后音频的信息。详见 EncodedAudioFrameInfo。
OnMixedAudioFrame
获取采集和播放音频混音后的数据。
public virtual bool OnMixedAudioFrame(string channelId, AudioFrame audio_frame) { return true; }
为保证采集和播放混音后的音频数据格式符合预期,你可以调用 SetMixedAudioFrameParameters 设置音频数据格式后,调用 RegisterAudioFrameObserver 注册音频观测器对象,SDK 会根据该方法中的参数计算采样间隔,并根据该采样间隔触发 OnMixedAudioFrame 回调。
参数
- audio_frame
- 音频原始数据。详见 AudioFrame。
- channelId
- 频道 ID。
返回值
无实际含义。
OnPlaybackAudioEncodedFrame
获取所有远端用户的音频编码数据。
public virtual void OnPlaybackAudioEncodedFrame(IntPtr frameBufferPtr, int length, EncodedAudioFrameInfo audioEncodedFrameInfo) { }
调用 RegisterAudioEncodedFrameObserver 并将音频编码内容设为 AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK 后,你可以通过该回调获取所有远端用户的音频编码数据。
参数
- frameBufferPtr
- 音频 buffer。
- length
- 音频数据长度,单位为字节。
- audioEncodedFrameInfo
- 编码后音频的信息。详见 EncodedAudioFrameInfo。
OnPlaybackAudioFrame
获得播放的原始音频数据。
public virtual bool OnPlaybackAudioFrame(string channelId, AudioFrame audio_frame) { return true; }
为保证播放的音频数据格式符合预期,你可以调用 SetPlaybackAudioFrameParameters 设置音频数据格式后,调用 RegisterAudioFrameObserver 注册音频观测器对象,SDK 会根据该方法中的参数计算采样间隔,并根据该采样间隔触发 OnPlaybackAudioFrame 回调。
参数
- audio_frame
- 音频原始数据。详见 AudioFrame。
- channelId
- 频道 ID。
返回值
无实际含义。
OnPlaybackAudioFrameBeforeMixing
获得混音前的指定用户的声音。
public virtual bool OnPlaybackAudioFrameBeforeMixing(string channel_id, uint uid, AudioFrame audio_frame) { return false; }
参数
- channel_id
- 频道 ID。
- uid
- 指定用户的用户 ID。
- audio_frame
- 音频原始数据。详见 AudioFrame。
返回值
无实际含义。
OnRecordAudioEncodedFrame
获取本地用户的音频编码数据。
public virtual void OnRecordAudioEncodedFrame(IntPtr frameBufferPtr, int length, EncodedAudioFrameInfo audioEncodedFrameInfo) { }
调用 RegisterAudioEncodedFrameObserver 并将音频编码内容设为 AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD 后,你可以通过该回调获取本地用户的音频编码数据。
参数
- frameBufferPtr
- 音频 buffer。
- length
- 音频数据长度,单位为字节。
- audioEncodedFrameInfo
- 编码后音频的信息。详见 EncodedAudioFrameInfo。
OnRecordAudioFrame
获得采集的原始音频数据。
public virtual bool OnRecordAudioFrame(string channelId, AudioFrame audioFrame) { return true; }
为保证采集的音频数据格式符合预期,你可以调用 SetRecordingAudioFrameParameters 设置音频数据格式后,调用 RegisterAudioFrameObserver 注册音频观测器对象,SDK 会根据该方法中的参数计算采样间隔,并根据该采样间隔触发 OnRecordAudioFrame 回调。
参数
- audioFrame
- 音频原始数据。详见 AudioFrame。
- channelId
- 频道 ID。
返回值
无实际含义。
OnRemoteAudioSpectrum
获取远端音频频谱。
public virtual bool OnRemoteAudioSpectrum(UserAudioSpectrumInfo[] spectrums, uint spectrumNumber) { return true; }
成功调用 RegisterAudioSpectrumObserver 实现 IAudioSpectrumObserver 中的 OnRemoteAudioSpectrum 回调并调用 EnableAudioSpectrumMonitor 开启音频频谱监测后,SDK 会按照你设置的时间间隔触发该回调,报告接收到的远端音频数据的频谱。
参数
- spectrums
- 远端用户的音频频谱信息,详见 UserAudioSpectrumInfo。 数组数量等于 SDK 监测到的远端用户数量,数组为空表示没有监测到远端用户的音频频谱。
- spectrumNumber
- 远端用户的数量。
返回值
true
: 接收。false
: 不接收。
RegisterAudioEncodedFrameObserver
注册音频编码数据观测器。
public abstract int RegisterAudioEncodedFrameObserver(AudioEncodedFrameObserverConfig config, IAudioEncodedFrameObserver observer);
详情
- 请在加入频道后调用该方法。
- 由于该方法和 StartAudioRecording [3/3] 都会设置音频内容和音质,不建议该方法和 StartAudioRecording [3/3] 一起使用。否则,只有后调用的方法会生效。
参数
- config
- 编码后音频的观测器设置。详见 AudioEncodedFrameObserverConfig。
- observer
- 编码后音频的观测器。详见 IAudioEncodedFrameObserver。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
RegisterAudioFrameObserver
注册音频观测器对象。
public abstract int RegisterAudioFrameObserver(IAudioFrameObserver audioFrameObserver, AUDIO_FRAME_POSITION position, OBSERVER_MODE mode = OBSERVER_MODE.INTPTR);
详情
该方法用于注册音频观测器对象,即注册回调。当需要 SDK 给出 OnMixedAudioFrame、OnRecordAudioFrame、OnPlaybackAudioFrame 或 OnEarMonitoringAudioFrame 等回调时,需要使用该方法注册回调。
参数
- audioFrameObserver
-
接口对象实例。详见 IAudioFrameObserver。如果传入 NULL,则表示取消注册。建议在收到 OnLeaveChannel 后调用,来释放音频观测器对象。
- mode
- 音频数据回调模式,详见 OBSERVER_MODE。
- position
- 音频观测位置。
- 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 回调。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。
RegisterAudioSpectrumObserver
注册音频频谱观测器。
public abstract int RegisterAudioSpectrumObserver(IAudioSpectrumObserver observer);
详情
成功注册音频频谱观测器并调用 EnableAudioSpectrumMonitor 开启音频频谱监测后,SDK 会按照你设置的时间间隔报告你在 IAudioSpectrumObserver 类中实现的回调。
参数
- observer
-
音频频谱观测器。详见 IAudioSpectrumObserver。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
SetMixedAudioFrameParameters
设置 OnMixedAudioFrame 报告的音频数据格式。
public abstract int SetMixedAudioFrameParameters(int sampleRate, int channel, int samplesPerCall);
参数
- sampleRate
-
音频数据采样率 (Hz),可设置为
8000
、16000
、32000
、44100
或48000
。
- channel
-
音频数据声道数,可设置为
1
(单声道) 或2
(双声道)。
- samplesPerCall
-
音频数据采样点数。旁路推流场景下通常设为
1024
。
SDK 会根据该方法设置的采样间隔(秒)定期触发 OnMixedAudioFrame 回调。 采样间隔 = samplesPerCall
/(sampleRate
x channel
)。请确保你的取值能满足采样间隔大于或等于 0.01 秒。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
SetPlaybackAudioFrameBeforeMixingParameters
设置 OnPlaybackAudioFrameBeforeMixing 报告的音频数据格式。
public abstract int SetPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel);
参数
- sampleRate
-
音频数据采样率 (Hz),可设置为
8000
、16000
、32000
、44100
或48000
。
- channel
-
音频数据声道数,可设置为
1
(单声道) 或2
(双声道) 。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败
SetPlaybackAudioFrameParameters
设置播放的音频格式。
public abstract int SetPlaybackAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall);
详情
该方法设置 OnPlaybackAudioFrame 回调数据的格式。
- 该方法需要在加入频道前调用。
- SDK 会通过该方法中的 samplesPerCall、sampleRate 和 channel 参数计算出采样间隔,计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。请确保采样间隔不小于 0.01 秒。SDK 会根据该采样间隔触发 OnPlaybackAudioFrame 回调。
参数
- sampleRate
- OnPlaybackAudioFrame 中返回数据的采样率,可设置为 8000、 16000、 32000、44100 或 48000。
- channel
-
OnPlaybackAudioFrame 中返回数据的通道数,可设置为 1 或 2:
- 1: 单声道
- 2: 双声道
- mode
-
音频帧的使用模式,详见 RAW_AUDIO_FRAME_OP_MODE_TYPE。
- samplesPerCall
- OnPlaybackAudioFrame 中返回数据的采样点数,如旁路推流应用中通常为 1024。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。
SetRecordingAudioFrameParameters
设置采集的原始音频数据格式。
public abstract int SetRecordingAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall);
详情
该方法设置 OnRecordAudioFrame 回调的采集音频格式。
- 该方法需要在加入频道前调用。
- SDK 会通过该方法中的 samplesPerCall、sampleRate 和 channel 参数计算出采样间隔,计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。请确保采样间隔不小于 0.01 秒。SDK 会根据该采样间隔触发 OnRecordAudioFrame 回调。
参数
- sampleRate
- OnRecordAudioFrame 中返回数据的采样率,可设置为 8000、 16000、 32000、44100 或 48000。
- channel
-
OnRecordAudioFrame 中返回数据的通道数,可设置为 1 或 2:
- 1: 单声道。
- 2: 双声道。
- mode
-
音频帧的使用模式,详见 RAW_AUDIO_FRAME_OP_MODE_TYPE。
- samplesPerCall
- OnRecordAudioFrame 中返回数据的采样点数,如旁路推流应用中通常为 1024。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。
UnregisterAudioSpectrumObserver
取消注册音频频谱观测器。
public abstract int UnregisterAudioSpectrumObserver();
详情
调用 RegisterAudioSpectrumObserver 后,如果你想取消注册音频频谱观测器,请调用该方法。
返回值
- 0: 方法调用成功
- < 0: 方法调用失败