cmp.audio 类

语音组件
该类提供了对移动设备的语音接口的调用，包括：

  • 开始录音（startRecord）
  • 停止录音（stopRecord）
  • 播放录音（playVoice）
  • 停止播放（stopVoice）
  • 获取播放时间（getDuration）
  • 提供有UI界面的录、播一套的组件
  • 提供有UI界面的播放录音的界面

注：录音时，需要将记录的文件名以.wav的格式进行录制

方法

checkPermission

checkPermission
(
  • [cfg]
)

定义于 doc\doc\cmp_doc_all\cmp-audio-doc.js:36

录音权限判断

参数:

名称类型标识描述
[cfg] Object 可选

回调函数对象配置

名称类型标识描述
[success] Function 可选

成功回调函数

[error] Function 可选

失败回调函数

示例:

文件导入路径：
M3App端
 <link rel="stylesheet" href="http://cmp/v/css/cmp.css"></link>
 <link rel="stylesheet" href="http://cmp/v/css/cmp-audio.css"></link>
 <script  src="http://cmp/v1.0.0/js/cordova/__CMPSHELL_PLATFORM__/cordova.js"></script>
 <script  src="http://cmp/v1.0.0/js/cordova/cordova-plugins.js"></script>
 <script  src="http://cmp/v/js/cmp.js"></script>
 <script  src="http://cmp/v/js/cmp-audio.js"></script>
 ===========================================================================================
 微协同端：不支持
 =========================================================================================
 调用组件
<script>
    cmp.audio.checkPermission({
         success:function(src){
                 //成功后直接调用开发者的成功回调
         },
        error:function(e){
            //会弹出去设置权限的提示
        }
    });
</script>

getDuration

getDuration
(
  • url
)
Number

定义于 doc\doc\cmp_doc_all\cmp-audio-doc.js:217

获取播放时间

参数:

名称类型标识描述
url Object 必选

播放文件地址

返回值:

[Number]

播放时间

init

init
(
  • [options]
)

定义于 doc\doc\cmp_doc_all\cmp-audio-doc.js:225

录、播UI界面

参数:

名称类型标识描述
[options] Object 可选

调用配置参数

名称类型标识描述
[text] String 可选

UI组件标题

[callback] Function 可选

点击使用按钮回调函数，将录音结果的文件地址返回给回调

[cancelCallback] Function 可选

点击取消按钮的回调

示例:

文件导入路径：
M3App端
 <link rel="stylesheet" href="http://cmp/v/css/cmp.css"></link>
 <link rel="stylesheet" href="http://cmp/v/css/cmp-audio.css"></link>
 <script  src="http://cmp/v1.0.0/js/cordova/__CMPSHELL_PLATFORM__/cordova.js"></script>
 <script  src="http://cmp/v1.0.0/js/cordova/cordova-plugins.js"></script>
 <script  src="http://cmp/v/js/cmp.js"></script>
 <script  src="http://cmp/v/js/cmp-audio.js"></script>
 ===========================================================================================
 微协同端：不支持
 =========================================================================================
 调用组件
<script>
    cmp.audio.init({
         text:"标题",
         callback:function(src){
              //返回录音生成的文件路径
             //如果是android系统，src的上传路径是cordova.file.externalRootDirectory+src
             //如果是ios系统，src即为上传路径
         },
         cancelCallback:function(){

         }
    });
</script>

play

play
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-audio-doc.js:262

播放录音UI界面

参数:

名称类型标识描述
options Object 必选

调用配置参数

名称类型标识描述
filepath String 必选

录音文件的地址

filename String 必选

录音文件的名称

[cancelCallback] Function 可选

点击取消按钮的回调

示例:

文件导入路径：
M3App端
 <link rel="stylesheet" href="http://cmp/v/css/cmp.css"></link>
 <link rel="stylesheet" href="http://cmp/v/css/cmp-audio.css"></link>
 <script  src="http://cmp/v1.0.0/js/cordova/__CMPSHELL_PLATFORM__/cordova.js"></script>
 <script  src="http://cmp/v1.0.0/js/cordova/cordova-plugins.js"></script>
 <script  src="http://cmp/v/js/cmp.js"></script>
 <script  src="http://cmp/v/js/cmp-audio.js"></script>
 ===========================================================================================
 微协同端：不支持
 =========================================================================================
 调用组件
<script>
    cmp.audio.play({
         filepath:cordova.file.externalRootDirectory+"/storage/emulated/0/m3/files/cmp_recording_sds12.wav"，
         filename:"cmp_recording_sds12.wav",
         cancelCallback:function(){
         }
    });
</script>

playVoice

playVoice
(
  • options
)

定义于 doc\doc\cmp_doc_all\cmp-audio-doc.js:141

播放录音

参数:

名称类型标识描述
options Object 必选

播放录音参数配置

名称类型标识描述
url String 必选

播放文件地址

[success] Function 可选

成功播放完毕回调函数

[error] Function 可选

失败回调函数

[initSuccess] Function 可选

成功开始播放的回调函数

示例:

文件导入路径：
M3App端
 <link rel="stylesheet" href="http://cmp/v/css/cmp.css"></link>
 <link rel="stylesheet" href="http://cmp/v/css/cmp-audio.css"></link>
 <script  src="http://cmp/v1.0.0/js/cordova/__CMPSHELL_PLATFORM__/cordova.js"></script>
 <script  src="http://cmp/v1.0.0/js/cordova/cordova-plugins.js"></script>
 <script  src="http://cmp/v/js/cmp.js"></script>
 <script  src="http://cmp/v/js/cmp-audio.js"></script>
 ===========================================================================================
 微协同端：不支持
 =========================================================================================
 调用组件
<script>
    cmp.audio.playVoice({
         url:"播放的路径"，
         initSuccess:function(){
               //do something
         },
         success:function(src){
              //返回录音生成的文件路径
             //如果是android系统，src的上传路径是cordova.file.externalRootDirectory+src
             //如果是ios系统，src即为上传路径
         },
        error:function(e){
            //请对照错误码进行处理
        }
    });
</script>

startRecord

startRecord
(
  • [cfg]
)
Object

定义于 doc\doc\cmp_doc_all\cmp-audio-doc.js:70

开始录音

参数:

名称类型标识描述
[cfg] Object 可选

回调函数对象配置

名称类型标识描述
[success] Function 可选

成功回调函数

[error] Function 可选

失败回调函数

返回值:

[Object]

媒体对象Media

示例:

文件导入路径：
M3App端
 <link rel="stylesheet" href="http://cmp/v/css/cmp.css"></link>
 <link rel="stylesheet" href="http://cmp/v/css/cmp-audio.css"></link>
 <script  src="http://cmp/v1.0.0/js/cordova/__CMPSHELL_PLATFORM__/cordova.js"></script>
 <script  src="http://cmp/v1.0.0/js/cordova/cordova-plugins.js"></script>
 <script  src="http://cmp/v/js/cmp.js"></script>
 <script  src="http://cmp/v/js/cmp-audio.js"></script>
 ===========================================================================================
 微协同端：不支持
 =========================================================================================
 调用组件
<script>
    cmp.audio.startRecord({
         success:function(src){
              //返回录音生成的文件路径
             //如果是android系统，src的上传路径是cordova.file.externalRootDirectory+src
             //如果是ios系统，src即为上传路径
         },
        error:function(e){
            //请对照错误码进行处理
        }
    });
</script>

stopRecord

stopRecord
(
  • [cfg]
)

定义于 doc\doc\cmp_doc_all\cmp-audio-doc.js:106

停止录音

参数:

名称类型标识描述
[cfg] Object 可选

回调函数对象配置

名称类型标识描述
[success] Function 可选

成功回调函数

示例:

文件导入路径：
M3App端
 <link rel="stylesheet" href="http://cmp/v/css/cmp.css"></link>
 <link rel="stylesheet" href="http://cmp/v/css/cmp-audio.css"></link>
 <script  src="http://cmp/v1.0.0/js/cordova/__CMPSHELL_PLATFORM__/cordova.js"></script>
 <script  src="http://cmp/v1.0.0/js/cordova/cordova-plugins.js"></script>
 <script  src="http://cmp/v/js/cmp.js"></script>
 <script  src="http://cmp/v/js/cmp-audio.js"></script>
 ===========================================================================================
 微协同端：不支持
 =========================================================================================
 调用组件
<script>
    cmp.audio.stopRecord({
         success:function(src){
              //返回录音生成的文件路径
             //如果是android系统，src的上传路径是cordova.file.externalRootDirectory+src
             //如果是ios系统，src即为上传路径
         },
        error:function(e){
            //请对照错误码进行处理
        }
    });
</script>

stopVoice

stopVoice
(
  • obj
)

定义于 doc\doc\cmp_doc_all\cmp-audio-doc.js:183

停止播放

参数:

名称类型标识描述
obj Object 必选

参数对象配置

名称类型标识描述
url String 必选

播放文件地址

[success] Function 可选

成功回调函数

示例:

文件导入路径：
M3App端
 <link rel="stylesheet" href="http://cmp/v/css/cmp.css"></link>
 <link rel="stylesheet" href="http://cmp/v/css/cmp-audio.css"></link>
 <script  src="http://cmp/v1.0.0/js/cordova/__CMPSHELL_PLATFORM__/cordova.js"></script>
 <script  src="http://cmp/v1.0.0/js/cordova/cordova-plugins.js"></script>
 <script  src="http://cmp/v/js/cmp.js"></script>
 <script  src="http://cmp/v/js/cmp-audio.js"></script>
 ===========================================================================================
 微协同端：不支持
 =========================================================================================
 调用组件
<script>
    cmp.audio.stopVoice({
         url:"停止播放的路径"，
         success:function(src){
              //返回录音生成的文件路径
             //如果是android系统，src的上传路径是cordova.file.externalRootDirectory+src
             //如果是ios系统，src即为上传路径
         }  //请对照错误码进行处理
    });
</script>
Top