AppCan插件API功能扩展之uexAudio

iOS Android
1、简介
音频播放插件 1.1、说明 播放背景音乐和效果音乐,本插件只支持播放本地音乐。 1.2、UI 展示
1.3、开源源码: 插件测试用例与源码下载:点击 插件中心至插件详情页 (插件测试用例与插件源码已经提 供)
2、API 概览
2.1、方法 open 打开音频文件 uexAudio.open(path) 说明: 后台播放,iOS 支持 MP3、WAV、CAF、AMR 格式,Android 支持 MP3、WAV、AMR、 MIDI 格式。 参数:
uexAudio

1、简介 1.1、说明 1.2、UI 展示 1.3、开源源码: 2、API 概览

2.1、方法 open 打开音频文件 play 播放 pause 暂停 replay 重播 stop 停止 volumeUp 音量+ volumeDown 音量openPlayer 打开音乐播放器 closePlayer 关闭播放器 startBackgroundRecord 开始后台录音 stopBackgroundRecord 停止后台录音 record 打开录音界面 openSoundPool 打开音效池 addSound 向音效池添加音效 playFromSoundPool 播放音效
1.
参数名称 id
平台支持: Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例:
参数类型 String
是否必选 是
说明 唯一标识符
1.
uexAudio.stopFromSoundPool("2") closeSoundPool 关闭音效池 uexAudio.closeSoundPool() 说明: 关闭音效池 参数: 无 平台支持: Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例: uexAudio.closeSoundPool()； setPlayMode 设置播放模式 uexAudio.setPlayMode(jsonStr) 说明: 设置声音播放模式 参数:
参数名称 opId
参数类型 Number
是否必选 是
说明 操作 ID,在此函数中不起作用,可忽略 数据类型,详见 CONSTENT 中 Callback 方法数据类型 文件路径
dataType
Number
是
data
版本支持: 3.0.0+ 示例:
String
是
1. 2. 3. 4. 5. 6.
functioncbBackgroundRecord(opId,dataType,data){ alert(data); } window.uexOnload=function(){ uexAudio.cbBackgroundRecord=cbBackgroundRecord; } cbOpenSoundPool 打开音效池的回调方法 uexAudio.cbOpenSoundPool(opId,dataType,data) 参数:
fileName
String
是
平台支持: Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例: uexAudio.record(1,"20153343443") openSoundPool 打开音效池
1.
uexAudio.openSoundPool() 说明: 打开音效池 回调方法 cbOpenSoundPool 参数: 无 平台支持: Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例: uexAudio.openSoundPool()； addSound 向音效池添加音效 uexAudio.addSound(soundID,path) 说明: iOS 支持 WAV、AMR、AIF、CAF 格式。Android 支持 WAV、MIDI、AMR 格式。 参数:
1.
参数名称
参数类 型
是否必 选
说明
要录音格式,0:AMR 格式,1:CAF 格 mode Number 是 式,2:MP3 格式。Android 只支持 AMR 格式,MP3 格式。 文件名称,默认以当前时间作为文件 名
fileName
String
是
平台支持:
Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例: uexAudio.startBackgroundRecord(1,document.getElementById('RecordName').valu e); stopBackgroundRecord 停止后台录音 uexAudio.stopBackgroundRecord() 说明: 停止后台录音 回调方法 cbBackgroundRecord 参数: 无 平台支持: Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例: uexAudio.stopBackgroundRecord();
参数名 称
参数类 型
是否必 选
说明
音频文件路径,路径协议详见 CONSTANT 中 PathTypes 音频文件路 径,路径协议详见 CONSTANT 中 PathTypes
平台支持: Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例: uexAudio.open(url); play 播放 uexAudio.play(repeats) 说明: 播放音频 参数:
示例: uexAudio.pause(); replay 重播 uexAudio.replay() 说明: 重播 参数: 无 平台支持: Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例: uexAudio.replay(); stop 停止 uexAudio.stop() 说明: 停止 参数:
1.
参数名称
参数类型
是否必选
说明 要播放的所有音频路径,路径
paths
String
是
协议详见 CONSTANT 中 PathTypes,以逗号分隔
index
平台支持: Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例:
Number
是
索引
1. 2.
var paths=newArray("res://1.mp3","res://2.mp3"); uexAudio.openPlayer(paths,"0"); closePlayer 关闭播放器 uexAudio.closePlayer() 说明: 关闭播放器 参数: 无 平台支持:
1.Biblioteka 参数名称 jsonStr参数类型 String
是否必选 是
说明 设置声音播放模式
1. 2. 3.
varparams={ playMode:'0' }
各字段含义如下:
参数名称 playMode
平台支持: Android2.2+ 版本支持: Android 3.0.6+ 示例: varparam={ playMode:'1' };
1.
1.
uexAudio.volumeUp() volumeDown 音量uexAudio.volumeDown() 说明: 音量参数: 无 平台支持: Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例: uexAudio.volumeDown() openPlayer 打开音乐播放器 uexAudio.openPlayer(paths,index) 说明: 打开音乐播放器 参数:
1.
1.
record 打开录音界面 uexAudio.record(mode,fileName) 说明: 打开录音界面 回调方法 cbRecord 参数:
参数名称
参数类 型
是否必 选
说明
录音格式,0:AMR 格式,1:CAF 格 mode Number 是 式,2:MP3 格式。Android 只支 持 AMR 格式,MP3 格式。 文件名称,默认以当前时间作为 文件名
1.
参数名称 soundID
参数类型 String
是否必选 是
说明 唯一标识符
参数名称
参数类型
是否必选
说明 音效文件路径,路径协
path
String
是
议详见 CONSTANT 中 PathTypes
平台支持: Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例: uexAudio.addSound("2","res://1.mp3") playFromSoundPool 播放音效 uexAudio.playFromSoundPool(id) 说明: 播放音效 参数:
Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例: uexAudio.closePlayer(); startBackgroundRecord 开始后台录音 uexAudio.startBackgroundRecord(mode,fileName) 说明: 开始后台录音 参数:

stopFromSoundPool 停止音效 closeSoundPool 关闭音效池 setPlayMode 设置播放模式 2.2、回调方法 cbRecord 打开录音界面的回调方法 cbBackgroundRecord 停止后台录音的回调方法 cbOpenSoundPool 打开音效池的回调方法 onPlayFinished 播放完成后的监听方法 3、更新历史
参数名称 opId
参数类型 Number
是否必选 是
说明 操作 ID,在此函数中不起作用,可忽略
参数名称
参数类型
是否必选
说明 数据类型,详见 CONSTENT 中 Callback 方法数据类型 唯一标识符
dataType
参数名称 opId
参数类型 Number
是否必选 是
说明 操作 ID,在此函数中不起作用,可忽略 数据类型,详见 CONSTENT 中 Callback 方法数据类型 文件路径
dataType
Number
是
data
版本支持: 3.0.0+ 示例:
String
是
1. 2. 3. 4. 5. 6.
functioncbRecord(opId,dataType,data){ alert(data); } window.uexOnload=function(){ uexAudio.cbRecord=cbRecord; } cbBackgroundRecord 停止后台录音的回调方法 uexAudio.cbBackgroundRecord(opId,dataType,data) 参数:
参数类型 String
是否必选 是
说明 播放模式:0 为正常扩音器模式;1 为听筒模式;
1. 2. 3. 4. 5.
param=JSON.stringify(param); uexAudio.setPlayMode(param)； 2.2、回调方法
cbRecord 打开录音界面的回调方法 uexAudio.cbRecord(opId,dataType,data) 参数:
1.
参数名称 id
平台支持:
参数类型 String
是否必选 是
说明 唯一标识符
Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例: uexAudio.playFromSoundPool("2") stopFromSoundPool 停止音效 uexAudio.stopFromSoundPool(id) 说明: 停止音效 参数:
1.
1.
无 平台支持: Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例: uexAudio.stop() volumeUp 音量+ uexAudio.volumeUp() 说明: 音量+ 参数: 无 平台支持: Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例:
path
String
是
1.
参数名称
参数类型
是否必选
说明
参数名称 repeats
平台支持: Android2.2+ iOS6.0+ 版本支持: 3.0.0+ 示例:
参数类型 Number
是否必选 是
说明 重复次数,-1:无限循环,0:不循环
1.
uexAudio.play(0); pause 暂停 uexAudio.pause() 说明: 暂停 参数: 无 平台支持: Android2.2+ iOS6.0+ 版本支持: 3.0.0+