TUILiveKit 产品动态
云直播推拉流 SDK 产品动态
音效（iOS）
本篇文档旨在指导您如何使用
AtomicXCore 框架中的 AudioEffectStore 和 DeviceStore 模块，为您的直播应用快速集成音效控制功能，包括麦克风音量、耳返监听，并添加多种趣味变声效果和混响效果。
核心功能
通过组合
AudioEffectStore 和 DeviceStore，您将能实现以下核心功能：人声音量调节：控制本地音频上行的采集音量大小，即观众听到的您的声音大小。
耳返功能：允许主播或连麦用户通过耳机实时听到自己的声音，用于监听和矫正发音。
变声效果：提供多种趣味变声选项，例如萝莉、大叔、熊孩子等。
混响效果：模拟不同环境的声场效果，例如 KTV、金属声、低沉、洪亮等。
核心概念
核心概念 | 类型 | 核心职责与描述 |
AudioChangerType | enum | 变声效果枚举，例如，“小孩”，“男人”等。 |
AudioReverbType | enum | 混响效果枚举，例如，“ktv”，“礼堂”等。 |
AudioEffectState | struct | 代表音效模块的当前状态，通常用于UI渲染。包括变声状态、混响状态、耳返开启状态、耳返音量。 |
AudioEffectStore | class | 代表音效模块单例数据管理类。通过它您可以调用修改音效接口，当您调用接口后，相应的 state属性会自动更新，可以通过订阅这个state响应式数据来接收和监听状态更新。 |
DeviceState | struct | 代表设备模块的当前状态，通常用于UI渲染。核心属性包括摄像头、麦克风的设备状态。 |
DeviceStore | class | 代表设备模块单例数据管理类。通过它您可以调用操作摄像头、麦克风接口，当您调用接口后，相应的 state属性会自动更新，可以通过订阅这个state响应式数据来接收和监听状态更新。 |
实现步骤
步骤1：组件集成
视频直播：请参考 快速接入 集成 AtomicXCore，完成接入。
语聊房：请参考 快速接入 集成 AtomicXCore，完成接入。
步骤2：获取 Store 实例
AudioEffectStore 和 DeviceStore是单例对象，您可以直接通过 shared 属性在项目的任何位置获取实例。您也可以参考 TUILiveKit 开源UI demo项目中的 AudioEffectView.swift 文件来了解完整的实现逻辑。import UIKitimport AtomicXCoreimport Combinelet audioEffectStore = AudioEffectStore.sharedlet deviceStore = DeviceStore.shared
步骤3：实现耳返功能
耳返功能允许用户实时监听自己的麦克风声音，可以通过调用本节介绍的接口管理耳返功能。
注意：
耳返功能通常需要连接耳机才能正常工作。
实现方式:
1. 开关耳返：您可以使用
UISwitch控件实现开关耳返功能。2. 设置耳返音量值：您可以使用
UISlider 控件实现左右拖动滑块来调节音量的功能，并将 UISlider 的值映射成音量值，调用setVoiceEarMonitorVolume(volume:)。请注意，该接口接收的参数范围是 [0, 150]，所以您需要将 UI 控件的值（例如 UISlider 的 0 - 1.0）映射到 0 - 150 的范围。3. 监听状态更新 UI：您可以订阅实时的耳返状态值更新 UI。
代码示例:
// 1. 开启耳返audioEffectStore.setVoiceEarMonitorEnable(enable: true)// 2. 调节耳返音量audioEffectStore.setVoiceEarMonitorVolume(volume: 80)// 3. 关闭耳返audioEffectStore.setVoiceEarMonitorEnable(enable: false)// 4. 监听状态audioEffectStore.state.subscribe(StatePublisherSelector(keyPath: \\AudioEffectState.earMonitorVolume)).removeDuplicates().sink { currentVolume inprint("耳返音量: \\(currentVolume)")valueLabel.text = "\\(currentVolume)" //更新UILabel显示数值}.store(in: &cancellables)
setVoiceEarMonitorEnable 接口参数
参数名 | 类型 | 描述 |
enable | Bool | 是否开启耳返。 true：开启 false：关闭 |
setVoiceEarMonitorVolume 接口参数
参数名 | 类型 | 描述 |
volume | Int | 耳返音量大小。 取值范围： [0, 150] 默认值：100 |
步骤4：实现人声音量调节
当主播希望调节自己的上行采集音量大小时，调用
DeviceStore的setCaptureVolume(volume: )方法传入音量值即可。实现方式:
1. 设置采集音量值：您可以使用
UISlider 控件实现左右拖动滑块来调节音量的功能，并将 UISlider 的值映射成音量值后调用setCaptureVolume(volume: 80)。请注意，该接口接收的参数范围是 [0, 150]，所以您需要将 UI 控件的值（例如 UISlider 的 0 - 1.0）映射到 0 - 150 的范围。2. 监听状态更新 UI：您可以订阅实时的音量状态值更新 UI。
示例代码：
// 1. 调节音量deviceStore.setCaptureVolume(volume: 80)// 2. 监听状态deviceStore.state.subscribe(StatePublisherSelector(keyPath: \\DeviceState.captureVolume)).removeDuplicates().sink { captureVolume inprint("采集音量: \\(captureVolume)")valueLabel.text = "\\(captureVolume)" //更新UILabel显示数值}.store(in: &cancellables)
setCaptureVolume 接口参数
参数名 | 类型 | 描述 |
volume | Int | 采集音量大小。 取值范围： [0, 150] 默认值：100 |
步骤5：实现变声效果
当主播希望改变自己的声音时，您可以调用
setAudioChangerType(type:)方法，传入相应的Type 枚举值即可切换效果。示例代码：
// 示例：将变声效果设置为“小孩”audioEffectStore.setAudioChangerType(type: .child)// 示例：关闭变声效果audioEffectStore.setAudioChangerType(type: .none)
setAudioChangerType 接口参数
参数名 | 类型 | 描述 |
type | AudioChangerType | 变声效果枚举。 |
步骤6：实现混响效果
当主播希望给自己的声音添加混响效果时，您可以调用
setAudioReverbType(type:) 方法，传入相应的Type 枚举值即可切换效果。// 示例：设置为“KTV”混响效果audioEffectStore.setAudioReverbType(type: .ktv)// 示例：关闭混响效果audioEffectStore.setAudioReverbType(type: .none)
setAudioReverbType 接口参数
参数名 | 类型 | 描述 |
type | AudioReverbType | 混响效果枚举。 |
步骤7：重置音效设置
重要：
AudioEffectStore和DeviceStore是单例，这意味着音效和设备设置是全局生效的，如果您在当前直播间的设置不想影响到您创建的其他直播间，就需要在当前直播间结束的时候重置音效和设备设置。
以下两种情况您可能需要重置音效设置：
1. 当前直播间结束时，需要重置音效设置。
2. 您需要提供“一键恢复”的功能，可以通过调用 store的
reset() 方法实现。class YourMainViewController: UIViewController {func reset() {AudioEffectStore.shared.reset()DeviceStore.shared.reset()}}
API 文档
常见问题
音效和设备接口的调用时机有没有要求？
没有限制。
AudioEffectStore和DeviceStore 的设置是全局生效的，您可以在进入直播间之前或之后随时调用相关接口（例如设置变声、混响或耳返），设置会立即生效并被保留。“人声音量” 和“耳返音量” 有什么区别？
这是一个非常重要且易混淆的概念，区别如下：
人声音量 (CaptureVolume)：通过
DeviceStore.setCaptureVolume() 设置。它决定了观众能听到的您的声音大小。耳返音量 (EarMonitorVolume)：通过
AudioEffectStore.setVoiceEarMonitorVolume() 设置。它只决定了您自己在耳机里听到的声音大小，不会影响观众。新创建的直播间为什么直接就有音效、或者出现音量很大、很小等问题？
AudioEffectStore和DeviceStore是单例，这意味着音效和设备设置是全局生效的，出现这种情况很可能是因为您之前设置过音效但是没有重置，需要在合适的地方调用reset()方法重置。为什么我开启了“耳返”，但是听不到自己的声音？
请您按照以下步骤检查：
1. 是否插入耳机：耳返功能绝大多数情况下依赖耳机才能生效，请确保已连接有线或蓝牙耳机。
2. 音量是否为0：检查“耳返音量”是否被设置为了 0。
3. 麦克风是否开启：确认
DeviceStore 中的麦克风是开启状态（即已调用 openLocalMicrophone）。变声效果 和混响效果 可以同时生效吗？
可以。
AudioChangerType 和 AudioReverbType 是可以叠加生效的。例如，您可以同时设置 .littleGirl 变声和 .ktv 混响。
文档反馈