ZegoAudioProcessing Class Reference

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

Overview

回声信号分别的增益值，取值范围[0.0, 1.0]

+ enableVirtualStereo:angle:

设置虚拟立体声

+ (bool)enableVirtualStereo:(bool)enable angle:(int)angle

Parameters

enable

true 开启，false 关闭
angle

虚拟立体声中声源的角度，范围为 -1 ~ 360，90 为正前方，0 / 180 / 270 分别对应最右边 / 最左边 / 正后方；特别的，设置 -1 时为全方位虚拟立体声效果。

Return Value

true 成功，false 失败

Discussion

必须在初始化 SDK 后调用，并且需要设置双声道(参考 setAudioChannelCount)， 推流成功后动态设置不同的 angle 都会生效

Declared In

zego-api-audio-processing-oc.h

+ enableReverb:mode:

设置音频混响 (Deprecated: 请使用 setReverbPreset:(ZegoAPIVoiceReverbType)type;)

+ (bool)enableReverb:(bool)enable mode:(ZegoAPIAudioReverbMode)mode

Parameters

enable

true 开启，false 关闭
mode

混响模式，参考 ZegoAPIAudioReverbMode

Return Value

true 成功，false 失败

Discussion

必须在初始化 SDK 后调用，推流成功后动态设置不同的 mode 都会生效

Declared In

zego-api-audio-processing-oc.h

+ setReverbParam:dryWetRatio:

设置音频混响参数

+ (bool)setReverbParam:(float)roomSize dryWetRatio:(float)dryWetRatio

Parameters

roomSize

房间大小，取值范围 0.0 ~ 1.0。 值越大说明混响时间越长，产生的混响拖尾效应越大
dryWetRatio

干湿比，取值范围 >= 0.0。 干湿比的值越小，wet的值越大，产生的混响效果越大

Return Value

true 成功，false 失败

Discussion

任意一个参数设置为0.0时，混响关闭

必须在初始化 SDK 后调用，推流成功后动态设置不同的参数都会生效

Declared In

zego-api-audio-processing-oc.h

+ setReverbParam:

设置音频混响参数

+ (bool)setReverbParam:(ZegoAudioReverbParam)param

Parameters

param

混响参数，各个参数含义参考 ZegoAudioReverbParam 的定义

Return Value

true 成功，false 失败

Discussion

必须在初始化 SDK 后调用，推流成功后动态设置不同的 param 都会生效

Declared In

zego-api-audio-processing-oc.h

+ setAdvancedReverbParam:config:

设置音频混响参数以获得不同的混响效果

+ (bool)setAdvancedReverbParam:(bool)enable config:(ZegoAudioAdvancedReverbParam)config

Parameters

enable

true 开启混响效果，false 关闭混响效果
config

混响参数，各个参数含义参考 ZegoAudioAdvancedReverbParam

Return Value

true 设置成功，false 设置失败

Discussion

必须在初始化 SDK 后调用，推流成功后动态设置不同的 config 都会生效

仅在 enable 为 true 时, config 值才有效

Declared In

zego-api-audio-processing-oc.h

+ setReverbPreset:

设置预设的音频混响效果

+ (bool)setReverbPreset:(ZegoAPIVoiceReverbType)type

Parameters

type

预设的混响效果，参考 ZegoAPIVoiceReverbType

Return Value

true 成功，false 失败

Discussion

必须在初始化 SDK 后调用，推流成功后动态设置不同的 type 都会生效

Declared In

zego-api-audio-processing-oc.h

+ setVoiceChangerParam:

设置变声器参数，用于调整声调

+ (bool)setVoiceChangerParam:(float)param

Parameters

param

变声器参数

Return Value

true 成功，false 失败

Discussion

必须在初始化 SDK 后调用

变声音效只针对采集的声音有效

取值[-12.0, 12.0]，几种典型的变声音效(男变女，女变男等)定义见上文

Declared In

zego-api-audio-processing-oc.h

+ setReverbEchoParam:

设置回声参数

+ (bool)setReverbEchoParam:(ZegoReverbEchoParam)param

Parameters

param

回声参数，各个参数含义参考 ZegoReverbEchoParam 的定义

Return Value

true 成功，false 失败

Discussion

必须在初始化 SDK 后调用，支持推流成功后动态设置

Declared In

zego-api-audio-processing-oc.h

+ setVoicePreset:

预设变声配置

+ (bool)setVoicePreset:(ZegoAPIVoiceChangerType)type

Parameters

type

变声器类型，参考 ZegoAPIVoiceChangerType

Return Value

true 成功，false 失败

Discussion

必须在初始化 SDK 后调用

变声音效只针对采集的声音有效

该接口的效果可由SetReverbParam、SetVoiceChangerParam、SetReverbEchoParam组合实现， 调用该接口后，若想有单独调用上述接口的效果，需先调用 SetVoicePreset(ZEGO_VOICE_CHANGER_TYPE_CHANGER_OFF)还原配置

Declared In

zego-api-audio-processing-oc.h

+ setAudioEqualizerGain:index:

调整音效均衡器参数

+ (bool)setAudioEqualizerGain:(float)bandGain index:(int)bandIndex

Parameters

bandGain

取值范围[-15, 15]。默认值是0，如果所有频带的增益值全部为0，则会关闭EQ功能
bandIndex

取值范围[0, 9]。分别对应10个频带，其中心频率分别是[31, 62, 125, 250, 500, 1K, 2K, 4K, 8K, 16K]Hz

Return Value

true 调用成功，false 调用失败 @attention 在 InitSDK 之后调用有效。使用此接口前请与即构技术支持联系确认是否支持此功能。

Declared In

zego-api-audio-processing-oc.h

+ setElectronicEffects:mode:tonal:

设置电音配置

+ (bool)setElectronicEffects:(bool)enable mode:(ZegoAPIElectronicEffectsMode)mode tonal:(int)tonal

Parameters

enable

true 开启，false 关闭，默认关闭
mode

电音的调式，参考 ZegoAPIElectronicEffectsMode，默认大调
tonal

电音在某个调式下的起始音高，代表声音一个八度的12个半音，取值范围 [0, 11], 默认0

Return Value

true 成功，false 失败 @attention 支持版本：6.4.0 及以上。 @attention 在 InitSDK 之后调用有效。使用此接口前请与即构技术支持联系确认是否支持此功能。

Declared In

zego-api-audio-processing-oc.h

+ enableSpeechEnhance:level:

设置人声增强

+ (bool)enableSpeechEnhance:(bool)enable level:(int)level

Parameters

enable

true 开启，false 关闭
level

人声增强等级, 取值范围 [0, 10]

Discussion

Note: 支持版本：6.19.0 及以上。

Note: 在 InitSDK 之后调用有效。在KTV外放场景中，由于3A损伤/距离原因，会导致人声较弱/虚/不清晰，需要通过人声增强技术提升外放体验。

Note: 支持动态修改，重复调用本接口，使用最后一次调用的设置。

Note: 在 UninitSDK 后，设置才会失效。

Declared In

zego-api-audio-processing-oc.h