ZegoExternalAudioDevice Class Reference

Inherits from NSObject
Declared in zego-api-external-audio-device-oc.h

Overview

提供音频外部采集和外部渲染的功能

+ enableExternalAudioDevice:

开/关外部音频设备，即开启音频外部采集和外部渲染功能（App 实现音频的采集和播放） (Deprecated: 请使用 setAudioSource:channel: 代替)

+ (void)enableExternalAudioDevice:(bool)enable

Parameters

enable

true 表示开启音频外部采集和外部渲染功能，false 表示关闭音频外部采集和外部渲染功能。

Discussion

  • 一般在以下情况使用音频外部采集、音频外部渲染的功能：
  • 1.客户需要从现有音频流、音频文件或者定制的采集系统中获得采集后输入给 SDK 进行传输。
  • 2.客户有自己对 PCM 输入源做特殊的音效处理的需求，在音效处理后输入给 SDK 进行传输。

  • 3.在客户有自己的渲染需求时使用音频外部渲染的功能，比如对拉取到的原始 PCM 数据做特殊应用或者处理后再渲染。

  • 注意：

  • 1.必须在 启动预览/推流/拉流 之前设置。
  • 2.开发者采用音频外部采集和渲染后，SDK 内部不负责声音增强、噪音抑制、回音消除等功能，需要用户自己实现。
  • 3.音频外部采集和外部渲染是一体的，如果开发者采用了外部渲染，则在有需要的情况下，应当自己实现外部采集；同理，采用了外部采集，在有需要的情况下，应当自己实现外部渲染。

See Also

Declared In

zego-api-external-audio-device-oc.h

+ setAudioSrcForAuxiliaryPublishChannel:

选择辅助推流通道的音频采集源 (Deprecated: 请使用 setAudioSource:channel: 代替 )

+ (int)setAudioSrcForAuxiliaryPublishChannel:(ZegoAPIAuxPublishChannelAudioSrcType)type

Parameters

type

辅助推流通道音频采集源类别，详见 enum ZegoAPIAuxPublishChannelAudioSrcType

Return Value

详见 enum ZegoAPIErrorCode，非0失败

Discussion

  • 需要同时推两路流时使用。
  • 注意：必须在 启动预览/推流/拉流 之前设置。

Declared In

zego-api-external-audio-device-oc.h

+ setAudioSource:channel:

设置推流通道的音源

+ (int)setAudioSource:(ZegoAPIExternalAudioDeviceSourceType)source channel:(ZegoAPIPublishChannelIndex)publishChannel

Parameters

source

音频来源, 详见 ZegoAPIExternalAudioDeviceSourceType 定义
publishChannel

选定推流通道

Return Value

详见 enum ZegoAPIErrorCode，非0失败

Discussion

  • 一般在以下情况使用音频外部采集、音频外部渲染的功能：
  • 1.客户需要从现有音频流、音频文件或者定制的采集系统中获得采集后输入给 SDK 进行传输。
  • 2.客户有自己对 PCM 输入源做特殊的音效处理的需求，在音效处理后输入给 SDK 进行传输。
  • 3.在客户有自己的渲染需求时使用音频外部渲染的功能，比如对拉取到的原始 PCM 数据做特殊应用或者处理后再渲染。

Note: 必须在开启预览或者启动推流/拉流 前调用才有效

Note: 开发者采用外部采集和渲染后，SDK 内部不负责声音增强、噪音抑制、回音消除等功能，需要用户自己实现

Note: 当 publishChannel = 0 时表示主通道, 只支持外部采集方式

Note: 当 publishChannel = 1 时表示辅助通道, 支持三种音源, 和主推流通道一样, 使用外部采集, 使用媒体播放器的音源

Note: 当 publishChannel > 1 时, 只支持外部采集方式

Note: 当 source_type 选择 kZegoAPIExternalAudioDeviceSourceTypeNone 时表示关闭外部音源, 主通道使用内部采集音源, 其他通道无音源

Declared In

zego-api-external-audio-device-oc.h

+ startCapture:

通知 SDK 开始进行音频的外部采集

+ (int)startCapture:(ZegoAPIPublishChannelIndex)publishChannel

Parameters

publishChannel

选定推流通道，详见 enum ZegoAPIPublishChannelIndex。

Return Value

详见 enum ZegoAPIErrorCode

Discussion

  • 注意：建议在 startPublishing 之前调用；如果在推流之后调用，会损失从 startPublishing 到startCapture 这段时间的音频数据。

See Also

Declared In

zego-api-external-audio-device-oc.h

+ stopCapture:

通知 SDK 结束音频的外部采集

+ (int)stopCapture:(ZegoAPIPublishChannelIndex)publishChannel

Parameters

publishChannel

选定推流通道，详见 enum ZegoAPIPublishChannelIndex。

Return Value

详见 enum ZegoAPIErrorCode

Discussion

  • 注意：建议在 stopPublishing 之后调用；如果在停止推流之前调用，会损失从stopCapture 到 stopPublishing 这段时间的音频数据。

Declared In

zego-api-external-audio-device-oc.h

+ onRecordAudioFrame:channel:

把采集到的音频数据塞给 SDK

+ (int)onRecordAudioFrame:(ZegoAPIAudioFrame *)audioFrame channel:(ZegoAPIPublishChannelIndex)publishChannel

Parameters

audioFrame

采集到的音频帧，详见 interface ZegoAPIAudioFrame。
publishChannel

选定推流通道，详见 enum ZegoAPIPublishChannelIndex。

Return Value

详见 enum ZegoAPIErrorCode

Discussion

  • 准备好音频帧数据后调用此 API 将音频数据塞给 SDK。

See Also

Declared In

zego-api-external-audio-device-oc.h

+ startRender

通知 SDK App 开始播放音频

+ (int)startRender

Return Value

详见 enum ZegoAPIErrorCode

See Also

Declared In

zego-api-external-audio-device-oc.h

+ stopRender

通知 SDK App 结束播放音频

+ (int)stopRender

Return Value

详见 enum ZegoAPIErrorCode

Declared In

zego-api-external-audio-device-oc.h

+ onPlaybackAudioFrame:

从 SDK 获取可渲染的音频数据

+ (int)onPlaybackAudioFrame:(ZegoAPIAudioFrame *)audioFrame

Parameters

audioFrame

得到的音频数据，SDK 根据本地设置的音频采样率、帧数据类型将相应的音频数据写入到 App 提供的地址；详见 interface ZegoAPIAudioFrame。

Return Value

详见 enum ZegoAPIErrorCode

Discussion

  • 在需要渲染音频数据时调用以获取待渲染的音频数据，调用频率一般是20ms或10ms。

See Also

Declared In

zego-api-external-audio-device-oc.h

+ onReferenceAudioFrame:channel:

把音频数据塞给 SDK，用作对自定义渲染音频消除回声的参考。

+ (int)onReferenceAudioFrame:(ZegoAPIAudioFrame *)audioFrame channel:(ZegoAPIPublishChannelIndex)publishChannel

Parameters

audioFrame

采集到的音频帧，详见 interface ZegoAPIAudioFrame。
publishChannel

选定推流通道，详见 enum ZegoAPIPublishChannelIndex。

Return Value

详见 enum ZegoAPIErrorCode

Discussion

  • 准备好音频帧数据后调用此 API 将音频数据塞给 SDK。

See Also

Declared In

zego-api-external-audio-device-oc.h