soundPlayer

来自于:APICloud立即使用

概述

soundPlayer 模块可以播放短促音效,支持多个音效同时播放。 iOS系统播放的音效持续时间不能超过30秒,音频数据必须是PCM或IMA4(IMA/ADPCM)格式 ,音效文件必须打包成.caf、.aif、.wav或.aac格式

playSound

开始播放音效。

playSound(params)

params

paths:

  • 类型:JSON类型
  • 描述:音效文件的路径json集合,以路径作为key,每个key对应一段属性,可以同时播放多个路径文件,支持本地路径(fs://, widget://)
  • 注意:如果每个key的属性都选默认值,请以{}代替,避免json格式出错
  • 内部字段:
paths :{
    key(指音效文件地址fs,widget): 
    {  
        leftVolume:     //数字类型;(可选项)左声道音量的大小,取值范围在0.0~1.0之间,默认值0.8
        rightVolume:    //数字类型;(可选项)右声道音量的大小,取值范围在0.0~1.0之间,默认值0.8
        priority:       //数字类型;(可选项)优先级,值越大优先级越高,0的优先级最低,默认值1
        loop:           //数字类型;(可选项) 是否需要循环播放;负数表示无穷循环,(官方建议,如果无穷循环,用-1,当然-2、-3等也行),非负数表示循环次数,比如0表示循环0次,也就是播放一次就不再循环了,总共就只播放一次;1则表示循环1次(总共播放2次)
        rate:          //数字类型;(可选项) 播放速率;取值0.5f - 2.0f,其中0.5表示播放速度为正常的0.5倍。1表示正常速率播放;默认值;1
    }
}

alert:

  • 类型:布尔类型
  • 描述:(可选项)播放音效时手机是否震动,暂仅支持iOS平台
  • 默认值:false

示例代码

var soundPlayer = api.require('soundPlayer');
soundPlayer.playSound({
                       alert: true,
                       paths:{
                              'fs://1.mp3':{
                                      leftVolume:0.8, 
                                      rightVolume:0.8, 
                                      priority:1, 
                                      loop:-1, 
                                      rate:1
                                  },
                            'fs://2.mp3':{
                                leftVolume:0.8, 
                                rightVolume:0.8, 
                                priority:1, 
                                loop:0, 
                                rate:1
                            },
                            'fs://3.mp3':{
                                leftVolume:0.8, 
                                rightVolume:0.8, 
                                priority:1, 
                                loop:0, rate:1
                            },

                       }
                   });

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

play

开始播放音效。

play(params)

params

paths:

  • 类型:数组类型
  • 描述:音效文件的路径json集合,以路径作为key,每个key对应一段属性,可以同时播放多个路径文件,支持本地路径(fs://, widget://)
  • 内部字段:
paths :[

    {  
        path:'',        //字符串;(必选项)指音效文件地址fs,widget
        leftVolume:     //数字类型;(可选项)左声道音量的大小,取值范围在0.0~1.0之间,默认值0.8
        rightVolume:    //数字类型;(可选项)右声道音量的大小,取值范围在0.0~1.0之间,默认值0.8
        priority:       //数字类型;(可选项)优先级,值越大优先级越高,0的优先级最低,默认值1
        loop:           //数字类型;(可选项) 是否需要循环播放;负数表示无穷循环,(官方建议,如果无穷循环,用-1,当然-2、-3等也行),非负数表示循环次数,比如0表示循环0次,也就是播放一次就不再循环了,总共就只播放一次;1则表示循环1次(总共播放2次)
        rate:          //数字类型;(可选项) 播放速率;取值0.5f - 2.0f,其中0.5表示播放速度为正常的0.5倍。1表示正常速率播放;默认值;1
    }
]

alert:

  • 类型:布尔类型
  • 描述:(可选项)播放音效时手机是否震动,暂仅支持iOS平台
  • 默认值:false

示例代码

var soundPlayer = api.require('soundPlayer');
soundPlayer.play({
                       alert: true,
                       paths:[
                              {
                                      path:'fs://1.mp3',
                                      leftVolume:0.8, 
                                      rightVolume:0.8, 
                                      priority:1, 
                                      loop:-1, 
                                      rate:1
                                  },
                                {
                                path:'fs://2.mp3'
                                leftVolume:0.8, 
                                rightVolume:0.8, 
                                priority:1, 
                                loop:0, 
                                rate:1
                            },
                            {
                                path:'fs://3.mp3'
                                leftVolume:0.8, 
                                rightVolume:0.8, 
                                priority:1, 
                                loop:0, rate:1
                            },

                       ]
                   });

可用性

iOS系统,android系统

可提供的1.0.1及更高版本

stopSound

停止播放音效。

stopSound(params)

params

paths:

  • 类型:数组类型
  • 描述:音效文件路径,支持本地路径(fs://, widget://)

示例代码

var soundPlayer = api.require('soundPlayer');
soundPlayer.stopSound({
                            paths:[fs://1.wav]
                        });

可用性

iOS系统, android系统

可提供的1.0.0及更高版本