ZegoLiveRoom
Classes | Enumerations | Functions | Variables
ZEGO::AUDIOPROCESSING Namespace Reference

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
}
 
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
}
 

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)
 

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

音频混响模式

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 

大教堂模式

◆ 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 

嘹亮

◆ 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 

留声机

Function Documentation

◆ EnableReverb()

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

设置音频混响

Parameters
enabletrue 开启,false 关闭
mode混响模式,参考 ZegoAVAPIAudioReverbMode
Returns
true 成功,false 失败 @discussion 必须在初始化 SDK 后调用,推流成功后动态设置不同的 mode 都会生效
Deprecated:
请使用 SetReverbPreset(ZegoAVAPIVoiceReverbType)

◆ EnableVirtualStereo()

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

设置虚拟立体声

Parameters
enabletrue 开启,false 关闭
angle虚拟立体声中声源的角度,范围为0~180,90为正前方,0和180分别对应最右边和最左边
Returns
true 成功,false 失败 @discussion 必须在初始化 SDK 后调用,并且需要设置双声道 ZEGO::LIVEROOM::SetAudioChannelCount, 推流成功后动态设置不同的 angle 都会生效

◆ SetAdvancedReverbParam()

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

设置音频混响高级参数

Parameters
bEnabletrue 开启混响功能; 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 之后调用有效。使用此接口前请与即构技术支持联系确认是否支持此功能

◆ 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 取值[-8.0, 8.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

男声变童声 值: 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

男声变女声 值: 4.0

Deprecated:
see ZegoAVAPIVoiceChangerType::ZEGO_VOICE_CHANGER_TYPE_MEN_TO_WOMEN

◆ ZEGO_VOICE_CHANGER_NONE

const float ZEGO::AUDIOPROCESSING::ZEGO_VOICE_CHANGER_NONE

无变声音效 值: 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

女声变童声 值: 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

女声变男声 值: -3.0

Deprecated:
see ZegoAVAPIVoiceChangerType::ZEGO_VOICE_CHANGER_TYPE_WOMEN_TO_MEN