需要访问旧版文档站？前往旧版文档官网首页。 (在新标签页打开)
声网文档中心

原始音频数据

  • React Native

更新时间不可用

registerAudioFrameObserver

注册音频观测器对象。

TypeScript
abstract registerAudioFrameObserver(observer: IAudioFrameObserver): number;

该方法用于注册音频观测器对象，即注册回调。当需要 SDK 触发 onMixedAudioFrame、onRecordAudioFrame、onPlaybackAudioFrame、onPlaybackAudioFrameBeforeMixing 和 onEarMonitoringAudioFrame 回调时，需要调用该方法注册回调。

调用时机

该方法需要在加入频道前调用。

参数

参数名描述
observer

接口对象实例。详见 IAudioFrameObserver。建议在收到 onLeaveChannel 后调用，来释放音频观测器对象。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setEarMonitoringAudioFrameParameters

设置耳返的音频数据格式。

TypeScript
abstract setEarMonitoringAudioFrameParameters(
    sampleRate: number,
    channel: number,
    mode: RawAudioFrameOpModeType,
    samplesPerCall: number
  ): number;

该方法用于设置 onEarMonitoringAudioFrame 回调的耳返音频数据格式。

注：

  • 调用该方法前，你需要先调用 enableInEarMonitoring，将 includeAudioFilters 设置为 EarMonitoringFilterBuiltInAudioFilters 或 EarMonitoringFilterNoiseSuppression。
  • SDK 会通过该方法中的 samplesPerCall、sampleRate 和 channel 参数计算出采样间隔，计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。请确保采样间隔不小于 0.01 秒。SDK 会根据该采样间隔触发 onEarMonitoringAudioFrame 回调。

参数

参数名描述
sampleRate

onEarMonitoringAudioFrame 中报告音频的采样率 (Hz)，可设置为 8000、 16000、 32000、44100 或 48000。

channel

onEarMonitoringAudioFrame 中报告音频的声道数，可设置为 1 或 2:

  • 1: 单声道。
  • 2: 双声道。
mode

音频帧的使用模式，详见 RawAudioFrameOpModeType。

samplesPerCall

onEarMonitoringAudioFrame 中报告的音频的采样点数，如旁路推流应用中通常为 1024。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setMixedAudioFrameParameters

设置采集和播放音频混音后的原始音频数据格式。

TypeScript
abstract setMixedAudioFrameParameters(
    sampleRate: number,
    channel: number,
    samplesPerCall: number
  ): number;

SDK 会通过该方法中的 samplesPerCall、sampleRate 和 channel 参数计算出采样间隔，计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。请确保采样间隔不小于 0.01 秒。SDK 会根据该采样间隔触发 onMixedAudioFrame 回调。

调用时机

该方法需要在加入频道前调用。

参数

参数名描述
sampleRate

音频数据的采样率 (Hz)，可设置为 8000、 16000、 32000、44100 或 48000。

channel

音频数据的声道数，可设置为 1 或 2:

  • 1: 单声道。
  • 2: 双声道。
samplesPerCall

音频数据的采样点数，如旁路推流应用中通常为 1024。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setPlaybackAudioFrameBeforeMixingParameters

设置混音前的原始音频播放数据格式。

TypeScript
abstract setPlaybackAudioFrameBeforeMixingParameters(
    sampleRate: number,
    channel: number
    samplesPerCall: number
  ): number;

SDK 会根据该采样间隔触发 onPlaybackAudioFrameBeforeMixing 回调。

调用时机

该方法需要在加入频道前调用。

参数

参数名描述
sampleRate

音频数据的采样率 (Hz)，可设置为 8000、 16000、 32000、44100 或 48000。

channel

音频数据的声道数，可设置为 1 或 2:

  • 1: 单声道。
  • 2: 双声道。
samplesPerCall

设置 onPlaybackAudioFrameBeforeMixing 回调中返回音频数据的采样点数。在 RTMP 推流场景中，建议设置为 1024。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setPlaybackAudioFrameParameters

设置播放的原始音频数据格式。

TypeScript
abstract setPlaybackAudioFrameParameters(
    sampleRate: number,
    channel: number,
    mode: RawAudioFrameOpModeType,
    samplesPerCall: number
  ): number;

SDK 会通过该方法中的 samplesPerCall、sampleRate 和 channel 参数计算出采样间隔，计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。请确保采样间隔不小于 0.01 秒。SDK 会根据该采样间隔触发 onPlaybackAudioFrame 回调。

调用时机

该方法需要在加入频道前调用。

参数

参数名描述
sampleRate

音频数据的采样率 (Hz)，可设置为 8000、 16000、 24000、 32000、44100 或 48000。

channel

音频数据的声道数，可设置为 1 或 2:

  • 1: 单声道。
  • 2: 双声道。
mode

音频帧的使用模式，详见 RawAudioFrameOpModeType。

samplesPerCall

音频数据的采样点数，如旁路推流应用中通常为 1024。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setRecordingAudioFrameParameters

设置采集的原始音频数据格式。

TypeScript
abstract setRecordingAudioFrameParameters(
    sampleRate: number,
    channel: number,
    mode: RawAudioFrameOpModeType,
    samplesPerCall: number
  ): number;

SDK 会通过该方法中的 samplesPerCall、sampleRate 和 channel 参数计算出采样间隔，计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。请确保采样间隔不小于 0.01 秒。SDK 会根据该采样间隔触发 onRecordAudioFrame 回调。

调用时机

该方法需要在加入频道前调用。

参数

参数名描述
sampleRate

音频数据的采样率 (Hz)，可设置为 8000、 16000、 32000、44100 或 48000。

channel

音频数据的声道数，可设置为 1 或 2:

  • 1: 单声道。
  • 2: 双声道。
mode

音频帧的使用模式，详见 RawAudioFrameOpModeType。

samplesPerCall

音频数据的采样点数，如旁路推流应用中通常为 1024。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

unregisterAudioFrameObserver

取消注册音频帧观测器。

TypeScript
abstract unregisterAudioFrameObserver(observer: IAudioFrameObserver): number;

参数

参数名描述
observer

音频帧观测器，观测每帧音频的接收，详见 IAudioFrameObserver。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

onEarMonitoringAudioFrame

获得耳返的原始音频数据。

TypeScript
onEarMonitoringAudioFrame?(audioFrame: AudioFrame): void;

为保证耳返的音频数据格式符合预期，你可以使用如下方法设置耳返音频数据格式：调用 setEarMonitoringAudioFrameParameters 设置音频数据格式后，调用 registerAudioFrameObserver 注册音频观测器对象，SDK 会根据该方法中的参数计算采样间隔，并根据该采样间隔触发 onEarMonitoringAudioFrame 回调。

参数

参数名描述
audioFrame

音频原始数据。详见 AudioFrame。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onMixedAudioFrame

获取采集和播放音频混音后的数据。

TypeScript
onMixedAudioFrame?(channelId: string, audioFrame: AudioFrame): void;

为保证采集和播放混音后的音频数据格式符合预期，你可以在如下方法设置音频的数据格式：调用 setMixedAudioFrameParameters 设置音频数据格式后，调用 registerAudioFrameObserver 注册音频观测器对象，SDK 会根据该方法中的参数计算采样间隔，并根据该采样间隔触发 onMixedAudioFrame 回调。

参数

参数名描述
audioFrame

音频原始数据。详见 AudioFrame。

channelId

频道 ID。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onPlaybackAudioFrame

获得播放的原始音频数据。

TypeScript
onPlaybackAudioFrame?(channelId: string, audioFrame: AudioFrame): void;

为保证播放的音频数据格式符合预期，你可以在如下方法设置音频的数据格式：调用 setPlaybackAudioFrameParameters 设置音频数据格式后，调用 registerAudioFrameObserver 注册音频观测器对象，SDK 会根据该方法中的参数计算采样间隔，并根据该采样间隔触发 onPlaybackAudioFrame 回调。

参数

参数名描述
audioFrame

音频原始数据。详见 AudioFrame。

channelId

频道 ID。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onPlaybackAudioFrameBeforeMixing

获取所订阅的远端用户混音前的声音。

TypeScript
onPlaybackAudioFrameBeforeMixing?(
    channelId: string,
    uid: number,
    audioFrame: AudioFrame
  ): void;

注： 由于框架的限制，该回调不支持将处理后的音频数据发送回 SDK。

参数

参数名描述
channelId

频道 ID。

uid

订阅的远端用户的 ID。

audioFrame

音频原始数据。详见 AudioFrame。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onRecordAudioFrame

获得采集的原始音频数据。

TypeScript
onRecordAudioFrame?(channelId: string, audioFrame: AudioFrame): void;

为保证采集的音频数据格式符合预期，你可以在如下方法设置音频的数据格式：调用 setRecordingAudioFrameParameters 设置音频数据格式后，调用 registerAudioFrameObserver 注册音频观测器对象，SDK 会根据该方法中的参数计算采样间隔，并根据该采样间隔触发 onRecordAudioFrame 回调。

参数

参数名描述
audioFrame

音频原始数据。详见 AudioFrame。

channelId

频道 ID。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利