人声音效
setAdvancedAudioOptions
设置音频的高级选项。
- (int)setAdvancedAudioOptions:(AgoraAdvancedAudioOptions * _Nonnull)options;
详情
如果你对音频处理有进阶需求,例如需要采集和发送立体声,可以调用该方法设置音频的高级选项。
参数
- options
- 音频的高级选项。详见 AgoraAdvancedAudioOptions。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setAINSMode
设置是否开启 AI 降噪功能并设置降噪模式。
- (int)setAINSMode:(BOOL)enabled mode:(AUDIO_AINS_MODE)mode NS_SWIFT_NAME(setAINSMode(_:mode:));
详情
- 电视机噪声
- 空调噪声
- 工厂机器噪声等
- 雷声
- 爆炸声
- 破裂声等
- 该方法依赖于 AI 降噪动态库
AgoraAiNoiseSuppressionExtension.xcframework
,如果删除该动态库会导致无法正常开启该功能。
适用场景
在语音连麦、在线教育、在线会议等场景中,如果周围环境比较嘈杂,AI 降噪功能可以在保证语音质量的前提下,识别并降低周围的稳态噪声和非稳态噪声,提高语音质量和体验。
参数
- enabled
- 是否开启 AI 降噪功能:
YES
:开启 AI 降噪功能。NO
:(默认)关闭 AI 降噪功能。
- mode
降噪模式,详见 AUDIO_AINS_MODE。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setAudioEffectParameters
设置 SDK 预设人声音效的参数。
- (int)setAudioEffectParameters:(AgoraAudioEffectPreset)preset param1:(int)param1 param2:(int)param2;
详情
- 3D 人声音效:设置 3D 人声音效的环绕周期。
- 电音音效:设置电音音效的基础调式和主音音高。为方便用户自行调节电音音效,建议你将基础调式和主音音高配置选项与应用的 UI 元素绑定。
设置后,频道内所有用户都能听到该效果。
- 调用 setAudioScenario 将音频场景设为高音质场景,即 AgoraAudioScenarioGameStreaming(3)。
- 调用 setAudioProfile [2/2] 将 profile 设为 AgoraAudioProfileMusicHighQuality(4) 或 AgoraAudioProfileMusicHighQualityStereo(5)。
- 该方法在加入频道前后都能调用。
- 请勿将 setAudioProfile [2/2] 的 profile 参数设置为 AgoraAudioProfileSpeechStandard(1),否则该方法不生效。
- 该方法对人声的处理效果最佳,不建议调用该方法处理含音乐的音频数据。
- 调用 setAudioEffectParameters 后,不建议调用以下方法,否则 setAudioEffectParameters 设置的效果会被覆盖:
参数
- preset
- SDK 预设的音效,支持以下设置:
- AgoraAudioEffectPresetRoomAcous3DVoice,3D 人声音效。
- 你需要在使用该枚举前将 setAudioProfile [2/2] 的 profile 参数设置 为 AgoraAudioProfileMusicStandardStereo(3) 或 AgoraAudioProfileMusicHighQualityStereo(5),否则该枚举设置无效。
- 启用 3D 人声后,用户需要使用支持双声道的音频播放设备才能听到预期效果。
- AgoraAudioEffectPresetPitchCorrection,电音音效。
- AgoraAudioEffectPresetRoomAcous3DVoice,3D 人声音效。
- param1
- 如果 preset 设为 AgoraAudioEffectPresetRoomAcous3DVoice ,则 param1 表示 3D 人声音效的环绕周期。取值范围为 [1,60],单位为秒。默认值为 10,表示人声会 10 秒环绕 360 度。
- 如果 preset 设为 AgoraAudioEffectPresetPitchCorrection,则 param1 表示电音音效的基础调式:
1
: (默认)自然大调。2
: 自然小调。3
: 和风小调。
- param2
- 如果 preset 设为 AgoraAudioEffectPresetRoomAcous3DVoice,你需要将 param2 设置为
0
。 - 如果 preset 设为 AgoraAudioEffectPresetPitchCorrection,则 param2 表示电音音效的主音音高:
1
: A2
: A#3
: B4
: (Default) C5
: C#6
: D7
: D#8
: E9
: F10
: F#11
: G12
: G#
- 如果 preset 设为 AgoraAudioEffectPresetRoomAcous3DVoice,你需要将 param2 设置为
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setAudioEffectPreset
设置 SDK 预设的人声音效。
- (int)setAudioEffectPreset:(AgoraAudioEffectPreset)preset;
详情
调用该方法可以为本地发流用户设置 SDK 预设的人声音效,且不会改变原声的性别特征。设置音效后,频道内所有用户都能听到该效果。
根据不同的场景,你可以为用户设置不同的音效,各音效的适用场景可参考设置人声效果。
- 调用 setAudioScenario 将音频场景设为高音质场景,即 AgoraAudioScenarioGameStreaming(3)。
- 调用 setAudioProfile [2/2] 将 profile 设为 AgoraAudioProfileMusicHighQuality(4) 或 AgoraAudioProfileMusicHighQualityStereo(5)。
- 该方法在加入频道前后都能调用。
- 请勿将 setAudioProfile [2/2] 的 profile 参数设置为 AgoraAudioProfileSpeechStandard(1),否则该方法不生效。
- 如果调用 setAudioEffectPreset 并设置除 AgoraAudioEffectPresetRoomAcous3DVoice 或 AgoraAudioEffectPresetPitchCorrection 外的枚举,请勿再调用 setAudioEffectParameters,否则 setAudioEffectPreset 设置的效果会被覆盖。
- 调用 setAudioEffectPreset 后,不建议调用以下方法,否则 setAudioEffectPreset 设置的效果会被覆盖:
- 该方法依赖于美声动态库
AgoraAudioBeautyExtension.xcframework
,如果删除该动态库会导致无法正常开启该功能。
参数
- preset
- 预设的音效选项,详见 AgoraAudioEffectPreset。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setLocalVoiceEqualizationOfBandFrequency
设置本地语音音效均衡。
- (int)setLocalVoiceEqualizationOfBandFrequency:(AgoraAudioEqualizationBandFrequency)bandFrequency
withGain:(NSInteger)gain;
详情
参数
- bandFrequency
- 频谱子带索引。取值范围是 [0,9],分别代表音效的 10 个频带。对应的中心频率为 [31,62,125,250,500,1k,2k,4k,8k,16k] Hz。详见 AgoraAudioEqualizationBandFrequency 。
- gain
- 每个 band 的增益,单位是 dB,每一个值的范围是 [-15,15],默认值为 0。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setLocalVoiceFormant
设置共振峰比率以改变语音的音色。
- (int)setLocalVoiceFormant:(double)formantRatio;
详情
共振峰比率是影响声音音色的一个参数,共振峰比率取值越小声音会更低沉,取值越大声音会更尖锐。
参数
- formantRatio
- 共振峰比率,取值范围为 [-1.0,1.0]。默认值为 0.0,即不改变原声的音色。信息声网推荐的取值范围为 [-0.4,0.6] ,超出此范围外音效听感可能不佳。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setLocalVoicePitch
setLocalVoiceReverbOfType
设置本地音效混响。
- (int)setLocalVoiceReverbOfType:(AgoraAudioReverbType)reverbType withValue:(NSInteger)value;
详情
SDK 提供一个使用更为简便的方法 setAudioEffectPreset,直接实现流行、R&B、KTV 等预置的混响效果。
参数
- reverbType
- 混响音效 Key。该方法共有 5 个混响音效 Key,详见 AgoraAudioReverbType。
- value
- 各混响音效 Key 所对应的值。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setVoiceBeautifierParameters
设置预设美声效果的参数。
- (int)setVoiceBeautifierParameters:(AgoraVoiceBeautifierPreset)preset param1:(int)param1 param2:(int)param2;
详情
调用该方法可以设置歌唱美声效果的性别特征和混响效果。该方法对本地发流用户进行设置。设置后,频道内所有用户都能听到该效果。
- 调用 setAudioScenario 将音频场景设为高音质场景,即 AgoraAudioScenarioGameStreaming(3)。
- 调用 setAudioProfile [2/2] 将 profile 设为 AgoraAudioProfileMusicHighQuality(4) 或 AgoraAudioProfileMusicHighQualityStereo(5)。
- 该方法在加入频道前后都能调用。
- 请勿将 setAudioProfile [2/2] 的 profile 参数设置为 AgoraAudioProfileSpeechStandard(1),否则该方法不生效。
- 该方法对人声的处理效果最佳,不建议调用该方法处理含音乐的音频数据。
- 调用 setVoiceBeautifierParameters,不建议调用以下方法,否则 setVoiceBeautifierParameters 设置的效果会被覆盖:
参数
- preset
- 预设的音效:
SINGING_BEAUTIFIER
: 歌唱美声。
- param1
- 歌声的性别特征:
1
: 男声。2
: 女声。
- param2
- 歌声的混响效果:
1
: 歌声在小房间的混响效果。2
: 歌声在大房间的混响效果。3
: 歌声在大厅的混响效果。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setVoiceBeautifierPreset
设置预设的美声效果。
- (int)setVoiceBeautifierPreset:(AgoraVoiceBeautifierPreset)preset;
详情
调用该方法可以为本地发流用户设置预设的人声美化效果。设置美声效果后,频道内所有用户都能听到该效果。根据不同的场景,你可以为用户设置不同的美声效果。各美声效果的适用场景可参考设置人声效果。
- 调用 setAudioScenario 将音频场景设为高音质场景,即 AgoraAudioScenarioGameStreaming(3)。
- 调用 setAudioProfile [2/2] 将 profile 设为 AgoraAudioProfileMusicHighQuality(4) 或 AgoraAudioProfileMusicHighQualityStereo(5)。
- 该方法在加入频道前后都能调用。
- 请勿将 setAudioProfile [2/2] 的 profile 参数设置为 AgoraAudioProfileSpeechStandard(1),否则该方法不生效。
- 该方法对人声的处理效果最佳,不建议调用该方法处理含音乐的音频数据。
- 调用 setVoiceBeautifierPreset,不建议调用以下方法,否则 setVoiceBeautifierPreset 设置的效果会被覆盖:
- 该方法依赖于美声动态库
AgoraAudioBeautyExtension.xcframework
,如果删除该动态库会导致无法正常开启该功能。
参数
- preset
预设的美声效果选项,详见 AgoraVoiceBeautifierPreset。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setVoiceConversionPreset
设置预设的变声效果。
- (int)setVoiceConversionPreset:(AgoraVoiceConversionPreset)preset;
详情
调用该方法可以为本地发流用户设置 SDK 预设的变声效果。设置变声效果后,频道内所有用户都能听到该效果。根据不同的场景,你可以为用户设置不同的变声效果。
各变声效果的适用场景可参考设置人声效果。
- 调用 setAudioScenario 将音频场景设为高音质场景,即 AgoraAudioScenarioGameStreaming(3)。
- 调用 setAudioProfile [2/2] 将 profile 设为 AgoraAudioProfileMusicHighQuality(4) 或 AgoraAudioProfileMusicHighQualityStereo(5)。
- 该方法在加入频道前后都能调用。
- 请勿将 setAudioProfile [2/2] 的 profile 参数设置为 AgoraAudioProfileSpeechStandard(1),否则该方法不生效。
- 该方法对人声的处理效果最佳,不建议调用该方法处理含音乐的音频数据。
- 调用 setVoiceConversionPreset 后,不建议调用以下方法,否则 setVoiceConversionPreset 设置的效果会被覆盖:
- 该方法依赖于美声动态库
AgoraAudioBeautyExtension.xcframework
,如果删除该动态库会导致无法正常开启该功能。
参数
- preset
预设的变声效果选项: AgoraVoiceConversionPreset。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。详见错误码了解详情和解决建议。