soundPlayer

来自于：APICloud立即使用

playSound stopSound play

概述

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

playSound

开始播放音效。

playSound(params)

params

paths:

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

alert:

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

示例代码

  1. var soundPlayer = api.require('soundPlayer');
  2. soundPlayer.playSound({
  3.                        alert: true,
  4.                        paths:{
  5.                               'fs://1.mp3':{
  6.                                       leftVolume:0.8, 
  7.                                       rightVolume:0.8, 
  8.                                       priority:1, 
  9.                                       loop:-1, 
  10.                                       rate:1
  11.                                   },
  12.                             'fs://2.mp3':{
  13.                                 leftVolume:0.8, 
  14.                                 rightVolume:0.8, 
  15.                                 priority:1, 
  16.                                 loop:0, 
  17.                                 rate:1
  18.                             },
  19.                             'fs://3.mp3':{
  20.                                 leftVolume:0.8, 
  21.                                 rightVolume:0.8, 
  22.                                 priority:1, 
  23.                                 loop:0, rate:1
  24.                             },
  26.                        }
  27.                    });

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

play

开始播放音效。

play(params)

params

paths:

  • 类型：数组类型
  • 描述：音效文件的路径json集合，以路径作为key，每个key对应一段属性，可以同时播放多个路径文件，支持本地路径(fs://, widget://)
  • 内部字段：
  1. paths :[
  3.     {  
  4.         path:'',        //字符串；(必选项)指音效文件地址fs,widget
  5.         leftVolume:     //数字类型；(可选项)左声道音量的大小，取值范围在0.0~1.0之间，默认值0.8
  6.         rightVolume:    //数字类型；(可选项)右声道音量的大小，取值范围在0.0~1.0之间，默认值0.8
  7.         priority:       //数字类型；(可选项)优先级，值越大优先级越高，0的优先级最低，默认值1
  8.         loop:           //数字类型；(可选项) 是否需要循环播放；负数表示无穷循环，（官方建议，如果无穷循环，用-1，当然-2、-3等也行），非负数表示循环次数，比如0表示循环0次，也就是播放一次就不再循环了，总共就只播放一次；1则表示循环1次（总共播放2次）
  9.         rate:          //数字类型；(可选项) 播放速率；取值0.5f - 2.0f，其中0.5表示播放速度为正常的0.5倍。1表示正常速率播放；默认值；1
  10.     }
  11. ]

alert:

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

示例代码

  1. var soundPlayer = api.require('soundPlayer');
  2. soundPlayer.play({
  3.                        alert: true,
  4.                        paths:[
  5.                               {
  6.                                       path:'fs://1.mp3',
  7.                                       leftVolume:0.8, 
  8.                                       rightVolume:0.8, 
  9.                                       priority:1, 
  10.                                       loop:-1, 
  11.                                       rate:1
  12.                                   },
  13.                                 {
  14.                                 path:'fs://2.mp3'
  15.                                 leftVolume:0.8, 
  16.                                 rightVolume:0.8, 
  17.                                 priority:1, 
  18.                                 loop:0, 
  19.                                 rate:1
  20.                             },
  21.                             {
  22.                                 path:'fs://3.mp3'
  23.                                 leftVolume:0.8, 
  24.                                 rightVolume:0.8, 
  25.                                 priority:1, 
  26.                                 loop:0, rate:1
  27.                             },
  29.                        ]
  30.                    });

可用性

iOS系统，android系统

可提供的1.0.1及更高版本

stopSound

停止播放音效。

stopSound(params)

params

paths：

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

示例代码

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

可用性

iOS系统， android系统

可提供的1.0.0及更高版本