音频

接口定义

qg.createInnerAudioContext()

• 描述

  获取一个音频对象用于播放音频，播放的时候会返回一个audioID，可以通过此audioID操作对应的音频对象。每次调用create会创建一个新的实例对象，目前最多同时支持5个播放音频的对象。

• 属性
  展开

  属性	说明
  string src	音频资源的地址，用于直接播放。
  number startTime	开始播放的位置（单位：s），默认为 0。
  boolean autoplay	是否自动开始播放，默认为 false。
  boolean loop	是否循环播放，默认为 false。
  boolean obeyMuteSwitch	是否遵循系统静音开关，默认为true。当此参数为false时，即使用户打开了静音开关，也能继续发出声音。
  number volume	音量。范围 0 ~ 1。默认为 1。
  number duration	当前音频的长度（单位 s）。只有在当前有合法的src时返回（只读）。
  number currentTime	当前音频的播放位置（单位 s）。只有在当前有合法的src时返回，时间保留小数点后6位（只读）。
  boolean paused	当前是否为暂停或停止状态（只读）。
  number buffered	音频缓冲的时间点，仅保证当前播放时间点到此时间点内容已缓冲（只读）。

• 示例代码
  收起

  自动换行

  深色代码主题

  复制

  const innerAudioContext = qg.createInnerAudioContext()
  innerAudioContext.loop = true;
  innerAudioContext.src = "https://47.98.62.68/cocos-runtime-demo/media/StreamAudio.mp3";
  innerAudioContext.startTime = 0;
  innerAudioContext.onPlay(() => {
          console.log('开始播放')
  })
  innerAudioContext.onPause(() => {
          console.log('暂停播放')
  })
  innerAudioContext.onStop(() => {
          console.log('停止播放')
  })
  innerAudioContext.onCanplay(() => {
          console.log('进入可播放状态')
  })
  innerAudioContext.onWaiting(() => {
          console.log('等待音频数据加载')
  })
  innerAudioContext.onEnded(() => {
          console.log('播放结束')
  })
  innerAudioContext.onSeeking(() => {
          console.log('触发音频跳转操作事件')
  })
  innerAudioContext.onSeeked(() => {
          console.log('完成音频跳转事件')
  })
  innerAudioContext.onError((res) => {
          console.log(res.errMsg)
          console.log(res.errCode)
  })
  innerAudioContext.play();

InnerAudioContext.play()

• 描述

  播放。

InnerAudioContext.pause()

• 描述

  暂停。暂停后的音频再播放会从暂停处开始播放。

InnerAudioContext.stop()

• 描述

  停止。停止后的音频再播放会从头开始播放。

InnerAudioContext.seek(number position)

• 描述

  跳转到指定位置。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  position	number	M	跳转的时间，单位 s。精确到小数点后3位，即支持 ms 级别精确度。

InnerAudioContext.destroy()

• 描述

  销毁当前实例。

InnerAudioContext.onTimeUpdate(function callback)

• 描述

  监听音频播放进度更新事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频播放进度更新事件的监听函数。

InnerAudioContext.offTimeUpdate(function callback)

• 描述

  取消监听音频播放进度更新事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	onTimeUpdate传入的监听函数。

• 示例代码
  收起

  自动换行

  深色代码主题

  复制

  const listener = function() { console.log('onTimeUpdate') }
  InnerAudioContext.onTimeUpdate(listener)
  InnerAudioContext.offTimeUpdate(listener) // 需传入与监听时同一个的函数对象

InnerAudioContext.onEnded(function callback)

• 描述

  监听音频自然播放至结束的事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频自然播放至结束的事件的回调函数。

InnerAudioContext.offEnded(function callback)

• 描述

  取消监听音频自然播放至结束的事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频自然播放至结束的事件的回调函数。

InnerAudioContext.onPlay(function callback)

• 描述

  监听音频播放事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频播放事件的回调函数。

InnerAudioContext.offPlay(function callback)

• 描述

  取消监听音频播放事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频播放事件的回调函数。

InnerAudioContext.onPause(function callback)

• 描述

  监听音频暂停事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频暂停事件的回调函数。

InnerAudioContext.offPause(function callback)

• 描述

  取消监听音频暂停事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频暂停事件的回调函数。

InnerAudioContext.onStop(function callback)

• 描述

  监听音频停止事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频停止事件的回调函数。

InnerAudioContext.offStop(function callback)

• 描述

  取消监听音频停止事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频停止事件的回调函数。

InnerAudioContext.onError(function callback)

• 描述

  监听音频播放错误事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频播放错误事件的回调函数。

  • callback回调函数参数
    展开

    参数	类型	说明
    errCode	number	音频播放错误事件的错误码，详细请参见“错误码说明”。

• 错误码
  展开

  错误码	说明
  10001	系统错误。
  10002	网络错误。
  10003	文件错误。
  10004	格式错误。
  -1	未知错误。

InnerAudioContext.offError(function callback)

• 描述

  取消监听音频播放错误事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频播放错误事件的回调函数。

InnerAudioContext.onCanplay(function callback)

• 描述

  监听音频进入可以播放状态的事件，但不保证后面可以流畅播放。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频进入可以播放状态的事件的回调函数。

InnerAudioContext.offCanplay(function callback)

• 描述

  取消监听音频进入可以播放状态的事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频进入可以播放状态的事件的回调函数。

InnerAudioContext.onWaiting(function callback)

• 描述

  监听音频加载中事件。当音频因为数据不足，需要停下来加载时会触发。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频加载中事件的回调函数。

InnerAudioContext.offWaiting(function callback)

• 描述

  取消监听音频加载中事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频加载中事件的回调函数。

InnerAudioContext.onSeeking(function callback)

• 描述

  监听音频进行跳转操作的事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频进行跳转操作事件的回调函数。

InnerAudioContext.offSeeking(function callback)

• 描述

  取消监听音频进行跳转操作的事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频进行跳转操作事件的回调函数。

InnerAudioContext.onSeeked(function callback)

• 描述

  监听音频完成跳转操作的事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频完成跳转操作事件的回调函数。

InnerAudioContext.offSeeked(function callback)

• 描述

  取消监听音频完成跳转操作的事件。

• 参数
  展开

  参数	类型	必填(M)/选填(O)	说明
  callback	function	M	音频完成跳转操作事件的回调函数。