1# AudioVolume 2 3 4## **概述** 5 6AudioVolume音频音量接口。 7 8提供音频播放（Render）或录音（Capture）需要的公共音量驱动能力，包括静音操作、设置音量、设置增益等。 9 10**Since：** 11 121.0 13 14**Version：** 15 161.0 17 18**相关模块:** 19 20[Audio](_audio.md) 21 22 23## **汇总** 24 25 26### Public 属性 27 28 | 名称 | 描述 | 29| -------- | -------- | 30| ([SetMute](#setmute))(AudioHandle handle, bool mute) | 设置音频的静音状态 | 31| ([GetMute](#getmute))(AudioHandle handle, bool \*mute) | 获取音频的静音状态 | 32| ([SetVolume](#setvolume))(AudioHandle handle, float volume) | 设置一个音频流的音量 | 33| ([GetVolume](#getvolume))(AudioHandle handle, float \*volume) | 获取一个音频流的音量 | 34| ([GetGainThreshold](#getgainthreshold))(AudioHandle handle, float \*min, float \*max) | 获取音频流增益的阈值 | 35| ([GetGain](#getgain))(AudioHandle handle, float \*gain) | 获取音频流的增益 | 36| ([SetGain](#setgain))(AudioHandle handle, float gain) | 设置音频流的增益 | 37 38 39## **类成员变量说明** 40 41 42### GetGain 43 44 45``` 46int32_t(* AudioVolume::GetGain) (AudioHandle handle, float *gain) 47``` 48 49**描述：** 50 51获取音频流的增益。 52 53**参数:** 54 55 | 名称 | 描述 | 56| -------- | -------- | 57| handle | 输入参数，待操作的音频句柄。 | 58| gain | 输出参数，保存当前获取到的增益到gain中。 | 59 60**返回:** 61 62成功返回值0，失败返回负值。 63 64**参见:** 65 66[GetGainThreshold](#getgainthreshold) 67 68[SetGain](#setgain) 69 70 71### GetGainThreshold 72 73 74``` 75int32_t(* AudioVolume::GetGainThreshold) (AudioHandle handle, float *min, float *max) 76``` 77 78**描述：** 79 80获取音频流增益的阈值。 81 82在具体的功能实现中，可以根据芯片平台的实际情况来进行处理： 83 84- 可以使用实际的增益值，例如增益的范围为-50db ~ 6db。 85 86- 也可以将增益范围设定为0.0~1.0，如果增益的范围为-50db ~ 6db， 则增益的映射关系为0.0表示静音，1.0表示最大增益（6db）。 87 88**参数:** 89 90 | 名称 | 描述 | 91| -------- | -------- | 92| handle | 输入参数，待操作的音频句柄。 | 93| min | 输出参数，获取的音频增益的阈值下限保存到min中。 | 94| max | 输出参数，获取的音频增益的阈值上限保存到max中。 | 95 96**返回:** 97 98成功返回值0，失败返回负值。 99 100**参见:** 101 102[GetGain](#getgain) 103 104[SetGain](#setgain) 105 106 107### GetMute 108 109 110``` 111int32_t(* AudioVolume::GetMute) (AudioHandle handle, bool *mute) 112``` 113 114**描述：** 115 116获取音频的静音状态。 117 118**参数:** 119 120 | 名称 | 描述 | 121| -------- | -------- | 122| handle | 输入参数，待操作的音频句柄。 | 123| mute | 输出参数，获取的静音状态保存到mute中，true表示静音操作，false表示取消静音操作。 | 124 125**返回:** 126 127成功返回值0，失败返回负值。 128 129**参见:** 130 131[SetMute](#setmute) 132 133 134### GetVolume 135 136 137``` 138int32_t(* AudioVolume::GetVolume) (AudioHandle handle, float *volume) 139``` 140 141**描述：** 142 143获取一个音频流的音量。 144 145**参数:** 146 147 | 名称 | 描述 | 148| -------- | -------- | 149| handle | 输入参数，待操作的音频句柄。 | 150| volume | 输出参数，获取的音量保存到volume中，范围0.0~1.0。 | 151 152**返回:** 153 154成功返回值0，失败返回负值。 155 156**参见:** 157 158[SetVolume](#setvolume) 159 160 161### SetGain 162 163 164``` 165int32_t(* AudioVolume::SetGain) (AudioHandle handle, float gain) 166``` 167 168**描述：** 169 170设置音频流的增益。 171 172**参数:** 173 174 | 名称 | 描述 | 175| -------- | -------- | 176| handle | 输入参数，待操作的音频句柄。 | 177| gain | 输入参数，待设置的增益。 | 178 179**返回:** 180 181成功返回值0，失败返回负值。 182 183**参见:** 184 185[GetGainThreshold](#getgainthreshold) 186 187[GetGain](#getgain) 188 189 190### SetMute 191 192 193``` 194int32_t(* AudioVolume::SetMute) (AudioHandle handle, bool mute) 195``` 196 197**描述：** 198 199设置音频的静音状态。 200 201**参数:** 202 203 | 名称 | 描述 | 204| -------- | -------- | 205| handle | 输入参数，待操作的音频句柄。 | 206| mute | 输入参数，待设置的静音状态，true表示静音操作，false表示取消静音操作。 | 207 208**返回:** 209 210成功返回值0，失败返回负值。 211 212**参见:** 213 214[GetMute](#getmute) 215 216 217### SetVolume 218 219 220``` 221int32_t(* AudioVolume::SetVolume) (AudioHandle handle, float volume) 222``` 223 224**描述：** 225 226设置一个音频流的音量。 227 228音量的取值范围是0.0~1.0，如果音频服务中的音量等级为15级（0 ~ 15），则音量的映射关系为0.0表示静音，1.0表示最大音量等级（15）。 229 230**参数:** 231 232 | 名称 | 描述 | 233| -------- | -------- | 234| handle | 输入参数，待操作的音频句柄。 | 235| volume | 输入参数，待设置的音量，范围0.0~1.0。 | 236 237**返回:** 238 239成功返回值0，失败返回负值。 240