音频管理
更新时间：
接口声明
{ "name": "blueos.media.audio.audioManager" }复制代码
导入模块
import audiomanager from '@blueos.media.audio.audioManager' 或 const audiomanager = require('@blueos.media.audio.audioManager')复制代码
接口定义
audiomanager.setVolume(OBJECT)
设置音量
参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| volumeType | AudioVolumeType | 是 | 音量流类型 |
| volume | Number | 是 | 音量等级, 设置的音量，0.00-1.00 之间。 |
| success | Function | 否 | 成功回调 |
| fail | Function | 否 | 失败回调 |
| complete | Function | 否 | 执行结束后的回调 |
AudioVolumeType
枚举，音量流的类型
| 名称 | 说明 | 取值 |
|---|---|---|
| RING | 铃声 | ring |
| MEDIA | 媒体声音 | music |
返回值：
无
示例：
audiomanager.setVolume({
volumeType: 'music',
volume: 0.5,
success: function () {},
fail: function () {},
})复制代码
audiomanager.getVolume(OBJECT)
获取音量
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| volumeType | AudioVolumeType | 是 | 音量流类型 |
| success | Function | 否 | 成功回调 |
| fail | Function | 否 | 失败回调 |
| complete | Function | 否 | 执行结束后的回调 |
返回值：
| 类型 | 必填 | 说明 |
|---|---|---|
| Number | 是 | 音量等级, 设置的音量，0.00-1.00 之间。 |
示例
audiomanager.getVolume({
volumeType: 'music',
success: function (val) {
console.log(val)
},
fail: function () {},
})复制代码
audiomanager.getVolumeSync(Object)
同步获取音量
参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| volumeType | AudioVolumeType | 是 | 音量流类型 |
返回值
| 参数值 | 类型 | 说明 |
|---|---|---|
| value | Number | 音量等级, 设置的音量，0.00-1.00 之间。 |
示例
const value = audiomanager.getVolumeSync({
volumeType: 'music',
})复制代码
audiomanager.subscribe(OBJECT)
监听音量变化
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | volume：表示音量 |
| callback | Function | 是 | 监听音量变化数据回调函数的执行 |
| fail | Function | 否 | 失败回调 |
callback 返回值：
| 参数名 | 类型 | 说明 |
|---|---|---|
| volumeType | AudioVolumeType | 音量流类型 |
| value | Number | 音量等级, 设置的音量，0.00-1.00 之间 |
示例：
audiomanager.subscribe({
type: 'volume',
callback: function (data) {
console.log(`handling success, value = ${data.value} volumeType = ${data.volumeType}`)
},
fail: function (data, code) {
console.log(`handling fail, code = ${code}`)
},
})复制代码
audiomanager.unsubscribe()
取消监听音量变化
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | volume：表示音量 |
示例：
audiomanager.unsubscribe({
type: 'volume',
})复制代码
audiomanager.getMinVolume(OBJECT): Number
获取指定流的最小音量
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| volumeType | AudioVolumeType | 是 | 音量流类型 |
返回值：
| 类型 | 说明 |
|---|---|
| Number | 最小音量 |
示例：
const volume = audiomanager.getMinVolume({
volumeType: 'music',
})
console.log(volume)复制代码
audiomanager.getMaxVolume(OBJECT)
获取指定流的最大音量
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| volumeType | AudioVolumeType | 是 | 音量流类型 |
返回值：
| 类型 | 说明 |
|---|---|
| Number | 最大音量 |
示例：
const volume = audiomanager.getMaxVolume({
volumeType: 'music',
})
console.log(volume)复制代码
audiomanager.mute(OBJECT)
设置指定音量流静音或取消静音
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| volumeType | AudioVolumeType | 是 | 音量流类型 |
| isMute | Number | 是 | 是否将音量流静音（1:设置静音 ；0:设置取消静音 |
| success | Function | 否 | 成功回调 |
| fail | Function | 否 | 失败回调 |
| complete | Function | 否 | 执行结束后的回调 |
返回值：
无
示例：
audiomanager.mute({
volumeType: 'music',
isMute: 1,
success: function (val) {
console.log(val)
},
fail: function () {},
})复制代码
audiomanager.isMute(OBJECT)
获取指定音量流是否被静音
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| volumeType | AudioVolumeType | 是 | 音量流类型 |
| success | Function | 否 | 成功回调 |
| fail | Function | 否 | 失败回调 |
| complete | Function | 否 | 执行结束后的回调 |
返回值：
| 类型 | 必填 | 说明 |
|---|---|---|
| Number | 是 | 是否将音量流静音（1:设置静音 ；0:设置取消静音)。 |
示例
audiomanager.isMute({
volumeType: 'music',
success: function (val) {
console.log(val)
},
fail: function () {},
})复制代码
audiomanager.isMicrophoneMute(OBJECT)
获取麦克风是否为静音状态
参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 成功回调 |
| fail | Function | 否 | 失败回调 |
| complete | Function | 否 | 执行结束后的回调 |
返回值
| 类型 | 必填 | 说明 |
|---|---|---|
| Number | 是 | 是否将音量流静音（1:设置静音 ；0:设置取消静音)。 |
示例
audiomanager.isMicrophoneMute({
success: function (val) {
console.log(val)
},
fail: function () {},
})复制代码