headphone

来自于:APICloud立即使用

概述

headphone用于监听耳机插拔事件和设置音量和获取各种类型的音量。耳机插拔事件,在耳机插入或拔出时触发。在iphone设备上可以设置音量的大小和获取当前音量的值。在安卓设备上可以设置和获取各种类型的音量,比如:系统音量,通话音量,铃声音量,音乐音量和提示声音音量。

addHeadphonePluggedListener

设置耳机插拔事件监听者

addHeadphonePluggedListener(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    state: true        //布尔类型;true耳机插入,false耳机拔出

}

示例代码

var headphone = api.require('headphone');
headphone.addHeadphonePluggedListener(
function(ret) {
     alert(JSON.stringify(ret));
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setVolume

设置音量

setVolume({params})

params

volume:

  • 类型:数字
  • 描述:(可选项)音量大小,取值范围:0-1
  • 默认值:0

type:

  • 类型:字符串类型
  • 描述:(可选项)音量类型 (在 iOS 平台本参数无效
  • 取值范围:SYSTEM,VOICE_CALL,RING,MUSIC,ALARM
  • 默认值:SYSTEM

示例代码

var headphone = api.require('headphone');
headphone.setVolume({
    type: 'MUSIC',
    volume: 0.6
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

getVolume

获取当前音量

getVolume({params}, callback(ret, err))

params

type:

  • 类型:字符串类型
  • 描述:(可选项)音量类型 (在 iOS 平台本参数无效
  • 取值范围:SYSTEM,VOICE_CALL,RING,MUSIC,ALARM
  • 默认值:SYSTEM

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    volume:            //数字类型;当前音量值
}

示例代码

var headphone = api.require('headphone');
headphone.getVolume({
        type: 'MUSIC'
    },function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本