Classes
struct	ZegoAVAPIAdvancedReverbParams

struct	ZegoAVAPIReverbEchoParams

struct	ZegoAVAPIReverbParams

Enumerations
enum	ZegoAVAPIAudioReverbMode { ZEGO_AUDIO_REVERB_MODE_SOFT_ROOM = 0 , ZEGO_AUDIO_REVERB_MODE_WARM_CLUB = 1 , ZEGO_AUDIO_REVERB_MODE_CONCERT_HALL = 2 , ZEGO_AUDIO_REVERB_MODE_LARGE_AUDITORIUM = 3 }

enum	ZegoAVAPIVoiceReverbType { ZEGO_AUDIO_REVERB_TYPE_OFF = 0 , ZEGO_AUDIO_REVERB_TYPE_SOFT_ROOM = 1 , ZEGO_AUDIO_REVERB_TYPE_WARM_CLUB = 2 , ZEGO_AUDIO_REVERB_TYPE_CONCERT_HALL = 3 , ZEGO_AUDIO_REVERB_TYPE_LARGE_AUDITORIUM = 4 , ZEGO_AUDIO_REVERB_TYPE_RECORDING_STUDIO = 5 , ZEGO_AUDIO_REVERB_TYPE_BASEMENT = 6 , ZEGO_AUDIO_REVERB_TYPE_KTV = 7 , ZEGO_AUDIO_REVERB_TYPE_POPULAR = 8 , ZEGO_AUDIO_REVERB_TYPE_ROCK = 9 , ZEGO_AUDIO_REVERB_TYPE_VOCAL_CONCERT = 10 , ZEGO_AUDIO_REVERB_TYPE_HIPHOP = 11 , ZEGO_AUDIO_REVERB_TYPE_MISTY = 12 , ZEGO_AUDIO_REVERB_TYPE_3DVOICE = 13 , ZEGO_AUDIO_REVERB_TYPE_GRAMOPHONE = 14 , ZEGO_AUDIO_REVERB_TYPE_KTV2 = 15 , ZEGO_AUDIO_REVERB_TYPE_ROCK2 = 16 , ZEGO_AUDIO_REVERB_TYPE_MISTY2 = 17 }

enum	ZegoAVAPIVoiceChangerType { ZEGO_VOICE_CHANGER_TYPE_CHANGER_OFF = 0 , ZEGO_VOICE_CHANGER_TYPE_OPTIMUS_PRIME = 1 , ZEGO_VOICE_CHANGER_TYPE_AI_ROBOT = 2 , ZEGO_VOICE_CHANGER_TYPE_FOREIGNER = 3 , ZEGO_VOICE_CHANGER_TYPE_ELUSIVE = 4 , ZEGO_VOICE_CHANGER_TYPE_MALE_MAGNETIC = 5 , ZEGO_VOICE_CHANGER_TYPE_FEMALE_FRESH = 6 , ZEGO_VOICE_CHANGER_TYPE_MEN_TO_CHILD = 7 , ZEGO_VOICE_CHANGER_TYPE_MEN_TO_WOMEN = 8 , ZEGO_VOICE_CHANGER_TYPE_WOMEN_TO_CHILD = 9 , ZEGO_VOICE_CHANGER_TYPE_WOMEN_TO_MEN = 10 , ZEGO_VOICE_CHANGER_TYPE_FEMALE_ENERGETIC = 11 , ZEGO_VOICE_CHANGER_TYPE_RICHNESS = 12 , ZEGO_VOICE_CHANGER_TYPE_MUFFLED = 13 , ZEGO_VOICE_CHANGER_TYPE_ROUNDNESS = 14 , ZEGO_VOICE_CHANGER_TYPE_DICTIONARIES = 15 , ZEGO_VOICE_CHANGER_TYPE_FULLNESS = 16 , ZEGO_VOICE_CHANGER_TYPE_CLEAR = 17 , ZEGO_VOICE_CHANGER_TYPE_HIGHLY_RESONANT = 18 , ZEGO_VOICE_CHANGER_TYPE_LOUD_CLEAR = 19 , ZEGO_VOICE_CHANGER_TYPE_MINIONS = 20 , ZEGO_VOICE_CHANGER_TYPE_MAJOR_C = 21 , ZEGO_VOICE_CHANGER_TYPE_MINOR_A = 22 , ZEGO_VOICE_CHANGER_TYPE_HARMONIC_MINOR = 23 }

enum	ZegoAVAPIElectronicEffectsMode { ZEGO_ELECTRONIC_EFFECTS_MODE_MAJOR = 0 , ZEGO_ELECTRONIC_EFFECTS_MODE_MINOR = 1 , ZEGO_ELECTRONIC_EFFECTS_MODE_HARMONIC_MINOR = 2 }

Functions
ZEGOAVKIT_API bool	EnableVirtualStereo (bool bEnable, int angle)

ZEGOAVKIT_API bool	EnableReverb (bool bEnable, ZegoAVAPIAudioReverbMode mode)

ZEGOAVKIT_API bool	SetReverbParam (float roomSize, float dryWetRatio)

ZEGOAVKIT_API bool	SetReverbParam (ZegoAVAPIReverbParams params)

ZEGOAVKIT_API bool	SetAdvancedReverbParam (bool bEnable, ZegoAVAPIAdvancedReverbParams config)

ZEGOAVKIT_API bool	SetReverbPreset (ZegoAVAPIVoiceReverbType type)

ZEGOAVKIT_API bool	SetVoiceChangerParam (float param)

ZEGOAVKIT_API bool	SetReverbEchoParam (ZegoAVAPIReverbEchoParams params)

ZEGOAVKIT_API bool	SetVoicePreset (ZegoAVAPIVoiceChangerType type)

ZEGOAVKIT_API bool	SetAudioEqualizerGain (int bandIndex, float bandGain)

ZEGOAVKIT_API bool	SetElectronicEffects (bool enable, ZegoAVAPIElectronicEffectsMode mode, int tonal)

ZEGOAVKIT_API bool	EnableSpeechEnhance (bool enable, int level)

Variables
const float	ZEGO_VOICE_CHANGER_NONE

const float	ZEGO_VOICE_CHANGER_WOMEN_TO_MEN

const float	ZEGO_VOICE_CHANGER_MEN_TO_WOMEN

const float	ZEGO_VOICE_CHANGER_WOMEN_TO_CHILD

const float	ZEGO_VOICE_CHANGER_MEN_TO_CHILD

Enumeration Type Documentation

◆ ZegoAVAPIAudioReverbMode

enum ZEGO::AUDIOPROCESSING::ZegoAVAPIAudioReverbMode

音频混响模式

Deprecated:: 请参考 ZegoAVAPIVoiceReverbType 及 SetReverbPreset(ZegoAVAPIVoiceReverbType)

Enumerator
ZEGO_AUDIO_REVERB_MODE_SOFT_ROOM	房间模式
ZEGO_AUDIO_REVERB_MODE_WARM_CLUB	俱乐部（大房间）模式
ZEGO_AUDIO_REVERB_MODE_CONCERT_HALL	音乐厅模式
ZEGO_AUDIO_REVERB_MODE_LARGE_AUDITORIUM	大教堂模式

◆ ZegoAVAPIElectronicEffectsMode

enum ZEGO::AUDIOPROCESSING::ZegoAVAPIElectronicEffectsMode

电音的调式

See also: SetElectronicEffects(bool, ZegoAVAPIElectronicEffectsMode, int)

Enumerator
ZEGO_ELECTRONIC_EFFECTS_MODE_MAJOR	大调
ZEGO_ELECTRONIC_EFFECTS_MODE_MINOR	小调
ZEGO_ELECTRONIC_EFFECTS_MODE_HARMONIC_MINOR	和声小调

◆ ZegoAVAPIVoiceChangerType

enum ZEGO::AUDIOPROCESSING::ZegoAVAPIVoiceChangerType

变声器类型

See also: SetVoicePreset(ZegoAVAPIVoiceChangerType)

Enumerator
ZEGO_VOICE_CHANGER_TYPE_CHANGER_OFF	恢复原声
ZEGO_VOICE_CHANGER_TYPE_OPTIMUS_PRIME	擎天柱音效
ZEGO_VOICE_CHANGER_TYPE_AI_ROBOT	AI机器人音效
ZEGO_VOICE_CHANGER_TYPE_FOREIGNER	外国人音效
ZEGO_VOICE_CHANGER_TYPE_ELUSIVE	空灵音效
ZEGO_VOICE_CHANGER_TYPE_MALE_MAGNETIC	磁性男声音效
ZEGO_VOICE_CHANGER_TYPE_FEMALE_FRESH	清新女声音效
ZEGO_VOICE_CHANGER_TYPE_MEN_TO_CHILD	男声变童声
ZEGO_VOICE_CHANGER_TYPE_MEN_TO_WOMEN	男声变女声
ZEGO_VOICE_CHANGER_TYPE_WOMEN_TO_CHILD	女声变童声
ZEGO_VOICE_CHANGER_TYPE_WOMEN_TO_MEN	女声变男声
ZEGO_VOICE_CHANGER_TYPE_FEMALE_ENERGETIC	女活力
ZEGO_VOICE_CHANGER_TYPE_RICHNESS	浑厚
ZEGO_VOICE_CHANGER_TYPE_MUFFLED	低沉
ZEGO_VOICE_CHANGER_TYPE_ROUNDNESS	圆润
ZEGO_VOICE_CHANGER_TYPE_DICTIONARIES	假音
ZEGO_VOICE_CHANGER_TYPE_FULLNESS	饱满
ZEGO_VOICE_CHANGER_TYPE_CLEAR	清澈
ZEGO_VOICE_CHANGER_TYPE_HIGHLY_RESONANT	高亢
ZEGO_VOICE_CHANGER_TYPE_LOUD_CLEAR	嘹亮
ZEGO_VOICE_CHANGER_TYPE_MINIONS	小黄人
ZEGO_VOICE_CHANGER_TYPE_MAJOR_C	C大调电音
ZEGO_VOICE_CHANGER_TYPE_MINOR_A	A小调电音
ZEGO_VOICE_CHANGER_TYPE_HARMONIC_MINOR	和声小调电音

◆ ZegoAVAPIVoiceReverbType

enum ZEGO::AUDIOPROCESSING::ZegoAVAPIVoiceReverbType

预设的音频混响效果

See also: SetReverbPreset(ZegoAVAPIVoiceReverbType)

Enumerator
ZEGO_AUDIO_REVERB_TYPE_OFF	关闭混响
ZEGO_AUDIO_REVERB_TYPE_SOFT_ROOM	房间模式
ZEGO_AUDIO_REVERB_TYPE_WARM_CLUB	俱乐部（大房间）模式
ZEGO_AUDIO_REVERB_TYPE_CONCERT_HALL	音乐厅模式
ZEGO_AUDIO_REVERB_TYPE_LARGE_AUDITORIUM	大教堂模式
ZEGO_AUDIO_REVERB_TYPE_RECORDING_STUDIO	录音棚
ZEGO_AUDIO_REVERB_TYPE_BASEMENT	地下室
ZEGO_AUDIO_REVERB_TYPE_KTV	KTV
ZEGO_AUDIO_REVERB_TYPE_POPULAR	流行
ZEGO_AUDIO_REVERB_TYPE_ROCK	摇滚
ZEGO_AUDIO_REVERB_TYPE_VOCAL_CONCERT	演唱会
ZEGO_AUDIO_REVERB_TYPE_HIPHOP	嘻哈
ZEGO_AUDIO_REVERB_TYPE_MISTY	飘渺（空旷）
ZEGO_AUDIO_REVERB_TYPE_3DVOICE	3D人声
ZEGO_AUDIO_REVERB_TYPE_GRAMOPHONE	留声机
ZEGO_AUDIO_REVERB_TYPE_KTV2	KTV2
ZEGO_AUDIO_REVERB_TYPE_ROCK2	摇滚2
ZEGO_AUDIO_REVERB_TYPE_MISTY2	飘渺（空旷）2

Function Documentation

◆ EnableReverb()

ZEGOAVKIT_API bool ZEGO::AUDIOPROCESSING::EnableReverb	(	bool	bEnable,
		ZegoAVAPIAudioReverbMode	mode
	)

设置音频混响

Parameters

enable	true 开启，false 关闭
mode	混响模式，参考 ZegoAVAPIAudioReverbMode

Returns: true 成功，false 失败 @discussion 必须在初始化 SDK 后调用，推流成功后动态设置不同的 mode 都会生效

Deprecated:: 请使用 SetReverbPreset(ZegoAVAPIVoiceReverbType)

◆ EnableSpeechEnhance()

ZEGOAVKIT_API bool ZEGO::AUDIOPROCESSING::EnableSpeechEnhance	(	bool	enable,
		int	level
	)

设置人声增强

Parameters

enable	true 开启，false 关闭
level	人声增强等级, 取值范围 [0, 10]

Note: 支持版本：6.19.0 及以上。; 在 InitSDK 之后调用有效。在KTV外放场景中，由于3A损伤/距离原因，会导致人声较弱/虚/不清晰，需要通过人声增强技术提升外放体验。; 支持动态修改，重复调用本接口，使用最后一次调用的设置。; 在 UninitSDK 后，设置才会失效。

◆ EnableVirtualStereo()

ZEGOAVKIT_API bool ZEGO::AUDIOPROCESSING::EnableVirtualStereo	(	bool	bEnable,
		int	angle
	)

设置虚拟立体声

Parameters

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

Returns: true 成功，false 失败 @discussion 必须在初始化 SDK 后调用，并且需要设置双声道 ZEGO::LIVEROOM::SetAudioChannelCount, 推流成功后动态设置不同的 angle 都会生效

◆ SetAdvancedReverbParam()

ZEGOAVKIT_API bool ZEGO::AUDIOPROCESSING::SetAdvancedReverbParam	(	bool	bEnable,
		ZegoAVAPIAdvancedReverbParams	config
	)

设置音频混响高级参数

Parameters

bEnable	true 开启混响功能; false 关闭混响功能, 此时会忽略 config 参数
config	混响参数，各变量含义参考 ZegoAVAPIAdvancedReverbParams 定义

Returns: true 设置成功，false 设置失败 @discussion 必须在初始化 SDK 后调用，推流成功后可动态修改参数值 @discussion 理论上所有混响效果都可以通过调整此参数的组合值得到

◆ SetAudioEqualizerGain()

ZEGOAVKIT_API bool ZEGO::AUDIOPROCESSING::SetAudioEqualizerGain	(	int	bandIndex,
		float	bandGain
	)

调整音效均衡器参数

Parameters

bandIndex	取值范围[0, 9]。分别对应 10 个频带，其中各频带对应的频点分别是 [31, 62, 125, 250, 500, 1K, 2K, 4K, 8K, 16K]Hz
bandGain	取值范围[-15, 15]。默认值是 0，如果所有频带的增益值全部为 0，则会关闭EQ功能

Note: 在 InitSDK 之后调用有效。使用此接口前请与即构技术支持联系确认是否支持此功能

◆ SetElectronicEffects()

ZEGOAVKIT_API bool ZEGO::AUDIOPROCESSING::SetElectronicEffects	(	bool	enable,
		ZegoAVAPIElectronicEffectsMode	mode,
		int	tonal
	)

设置电音配置

Parameters

enable	true 开启，false 关闭
mode	电音的调式，参考ZegoAVAPIElectronicEffectsMode，默认大调
tonal	电音在某个调式下的起始音高，代表声音一个八度的12个半音，取值范围 [0, 11], 默认0

Note: 支持版本：6.4.0 及以上。; 在 InitSDK 之后调用有效。使用此接口前请与即构技术支持联系确认是否支持此功能

◆ SetReverbEchoParam()

ZEGOAVKIT_API bool ZEGO::AUDIOPROCESSING::SetReverbEchoParam ( ZegoAVAPIReverbEchoParams params )

设置音频回声参数

Parameters

params 音频回声参数，参考ZegoAVAPIReverbEchoParams

Returns: true 成功，false 失败 @discussion 必须在初始化 SDK 后调用，支持推流成功后动态设置

◆ SetReverbParam() [1/2]

ZEGOAVKIT_API bool ZEGO::AUDIOPROCESSING::SetReverbParam	(	float	roomSize,
		float	dryWetRatio
	)

设置音频混响参数

Parameters

roomSize	房间大小，取值范围 0.0 ~ 1.0。值越大说明混响时间越长，产生的混响拖尾效应越大
dryWetRatio	干湿比，取值范围 >= 0.0。干湿比的值越小，wet的值越大，产生的混响效果越大

Returns: true 成功，false 失败 @discussion 任意一个参数设置为0.0时，混响关闭 @discussion 必须在初始化 SDK 后调用，推流成功后动态设置不同的 mode 都会生效

Deprecated:: 请使用 SetAdvancedReverbParam(bool, ZegoAVAPIAdvancedReverbParams)

◆ SetReverbParam() [2/2]

ZEGOAVKIT_API bool ZEGO::AUDIOPROCESSING::SetReverbParam ( ZegoAVAPIReverbParams params )

设置音频混响参数

Parameters

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

Returns: true 成功，false 失败 @discussion 必须在初始化 SDK 后调用，推流成功后可动态修改

◆ SetReverbPreset()

ZEGOAVKIT_API bool ZEGO::AUDIOPROCESSING::SetReverbPreset ( ZegoAVAPIVoiceReverbType type )

预设混响效果

Parameters

type	预设的混响效果，参考 ZegoAVAPIVoiceReverbType 定义

Returns: true 设置成功，false 设置失败 @discussion 必须在初始化 SDK 后调用，推流成功后可动态修改混响效果

◆ SetVoiceChangerParam()

ZEGOAVKIT_API bool ZEGO::AUDIOPROCESSING::SetVoiceChangerParam ( float param )

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

Parameters

param 变声器参数

Returns: true 成功，false 失败 @discussion 必须在初始化 SDK 后调用 @discussion 变声音效只针对采集的声音有效 @discussion 取值[-12.0, 12.0]，几种典型的变声音效(男变女，女变男等)定义见上文

◆ SetVoicePreset()

ZEGOAVKIT_API bool ZEGO::AUDIOPROCESSING::SetVoicePreset ( ZegoAVAPIVoiceChangerType type )

预设变声配置

Parameters

type	变声器类型，参考ZegoAVAPIVoiceChangerType

Returns: true 成功，false 失败 @discussion 必须在初始化 SDK 后调用 @discussion 变声音效只针对采集的声音有效 @discussion 该接口的效果可由SetReverbParam、SetVoiceChangerParam、SetReverbEchoParam组合实现，调用该接口后，若想有单独调用上述接口的效果，需先调用 SetVoicePreset(ZEGO_VOICE_CHANGER_TYPE_CHANGER_OFF)还原配置

Variable Documentation

◆ ZEGO_VOICE_CHANGER_MEN_TO_CHILD

const float ZEGO::AUDIOPROCESSING::ZEGO_VOICE_CHANGER_MEN_TO_CHILD

extern

男声变童声值: 8.0

Deprecated:: see ZegoAVAPIVoiceChangerType::ZEGO_VOICE_CHANGER_TYPE_MEN_TO_CHILD

◆ ZEGO_VOICE_CHANGER_MEN_TO_WOMEN

const float ZEGO::AUDIOPROCESSING::ZEGO_VOICE_CHANGER_MEN_TO_WOMEN

extern

男声变女声值: 4.0

Deprecated:: see ZegoAVAPIVoiceChangerType::ZEGO_VOICE_CHANGER_TYPE_MEN_TO_WOMEN

◆ ZEGO_VOICE_CHANGER_NONE

const float ZEGO::AUDIOPROCESSING::ZEGO_VOICE_CHANGER_NONE

extern

无变声音效值: 0.0

Deprecated:: see ZegoAVAPIVoiceChangerType::ZEGO_VOICE_CHANGER_TYPE_CHANGER_OFF

◆ ZEGO_VOICE_CHANGER_WOMEN_TO_CHILD

const float ZEGO::AUDIOPROCESSING::ZEGO_VOICE_CHANGER_WOMEN_TO_CHILD

extern

女声变童声值: 6.0

Deprecated:: see ZegoAVAPIVoiceChangerType::ZEGO_VOICE_CHANGER_TYPE_WOMEN_TO_CHILD

◆ ZEGO_VOICE_CHANGER_WOMEN_TO_MEN

const float ZEGO::AUDIOPROCESSING::ZEGO_VOICE_CHANGER_WOMEN_TO_MEN

extern

女声变男声值: -3.0

Deprecated:: see ZegoAVAPIVoiceChangerType::ZEGO_VOICE_CHANGER_TYPE_WOMEN_TO_MEN

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ ZegoAVAPIAudioReverbMode

◆ ZegoAVAPIElectronicEffectsMode

◆ ZegoAVAPIVoiceChangerType

◆ ZegoAVAPIVoiceReverbType

Function Documentation

◆ EnableReverb()

◆ EnableSpeechEnhance()

◆ EnableVirtualStereo()

◆ SetAdvancedReverbParam()

◆ SetAudioEqualizerGain()

◆ SetElectronicEffects()

◆ SetReverbEchoParam()

◆ SetReverbParam() [1/2]

◆ SetReverbParam() [2/2]

◆ SetReverbPreset()

◆ SetVoiceChangerParam()

◆ SetVoicePreset()

Variable Documentation

◆ ZEGO_VOICE_CHANGER_MEN_TO_CHILD

◆ ZEGO_VOICE_CHANGER_MEN_TO_WOMEN

◆ ZEGO_VOICE_CHANGER_NONE

◆ ZEGO_VOICE_CHANGER_WOMEN_TO_CHILD

◆ ZEGO_VOICE_CHANGER_WOMEN_TO_MEN