Audio

Definition

[h2]qg.createInnerAudioContext()

• Description

  Obtains an audio object for audio playback. During the playback, an audioID is returned, which can be used to operate the corresponding audio object. Each time create is called, a new object is created. Currently, up to five audio playback objects are supported at the same time.

• Attributes

  Attribute	Description
  string src	URI of the audio to be played.
  number startTime	Position from which audio playback starts, in seconds. The default value is 0.
  boolean autoplay	Indicates whether the audio should play automatically. The default value is false.
  boolean loop	Indicates whether the audio should play cyclically. The default value is false.
  boolean obeyMuteSwitch	Indicates whether to respect the system mute switch. The default value is true. When this parameter is set to false, the audio is still on even if the system mute switch is enabled.
  number volume	Volume. The value ranges from 0 to 1. The default value is 1.
  number duration	Duration of the current audio, in seconds. A value is returned only when src is valid. The value is read-only.
  number currentTime	Current audio playback position, in seconds. A value is returned only when src is valid. The value is read-only and contains up to six decimal places.
  boolean paused	Indicates whether the audio playback is paused or stopped. The value is read-only.
  number buffered	Buffered end position of the audio. It ensures that only the content from the current playback position to the end point has been buffered. The value is read-only.

• Sample code

  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('Playback started.')
  })
  innerAudioContext.onPause(() => {
          console.log('Playback paused.')
  })
  innerAudioContext.onStop(() => {
          console.log('Playback stopped.')
  })
  innerAudioContext.onCanplay(() => {
          console.log('Audio is ready to play.')
  })
  innerAudioContext.onWaiting(() => {
          console.log('Waiting for audio data to load.')
  })
  innerAudioContext.onEnded(() => {
          console.log('Playback ended.')
  })
  innerAudioContext.onSeeking(() => {
          console.log('Seeking operation triggered.')
  })
  innerAudioContext.onSeeked(() => {
          console.log('Seeking operation completed.')
  })
  innerAudioContext.onError((res) => {
          console.log(res.errMsg)
          console.log(res.errCode)
  })
  innerAudioContext.play();

[h2]InnerAudioContext.play()

• Description

  Plays an audio file.

[h2]InnerAudioContext.pause()

• Description

  Pauses the audio playback. When resumed, playback continues from the position where it was paused.

[h2]InnerAudioContext.stop()

• Description

  Stops the audio playback. When playback starts again, it begins from the start of the audio.

[h2]InnerAudioContext.seek(number position)

• Description

  Goes to a specified position.

• Parameters

  Parameter	Type	Mandatory	Description
  position	number	Yes	Playback position to seek to, in seconds. The value is accurate to three decimal places, that is, millisecond-level precision.

[h2]InnerAudioContext.destroy()

• Description

  Destroys the current instance.

[h2]InnerAudioContext.onTimeUpdate(function callback)

• Description

  Listens for audio playback progress update events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Listener function for audio playback progress update events.

[h2]InnerAudioContext.offTimeUpdate(function callback)

• Description

  Stops listening for audio playback progress update events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Listener function passed to onTimeUpdate.

• Sample code

  const listener = function() { console.log('onTimeUpdate') }
  InnerAudioContext.onTimeUpdate(listener)
  InnerAudioContext.offTimeUpdate(listener) // The function object must be the same as that used during listening.

[h2]InnerAudioContext.onEnded(function callback)

• Description

  Listens for the event that the audio finishes playing.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio playback end events.

[h2]InnerAudioContext.offEnded(function callback)

• Description

  Stops listening for the event that the audio finishes playing.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio playback end events.

[h2]InnerAudioContext.onPlay(function callback)

• Description

  Listens for audio playback events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio playback events.

[h2]InnerAudioContext.offPlay(function callback)

• Description

  Stops listening for audio playback events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio playback events.

[h2]InnerAudioContext.onPause(function callback)

• Description

  Listens for audio pause events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio pause events.

[h2]InnerAudioContext.offPause(function callback)

• Description

  Stops listening for audio pause events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio pause events.

[h2]InnerAudioContext.onStop(function callback)

• Description

  Listens for audio stop events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio stop events.

[h2]InnerAudioContext.offStop(function callback)

• Description

  Stops listening for audio stop events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio stop events.

[h2]InnerAudioContext.onError(function callback)

• Description

  Listens for audio playback error events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio playback error events.

  • Parameters in callback

    Parameter	Type	Description
    errCode	number	Result code for audio playback error events. For details, please refer to the description.

• Result codes

  Result Code	Description
  10001	System error.
  10002	Network error.
  10003	Incorrect file.
  10004	Incorrect format.
  -1	Unknown error.

[h2]InnerAudioContext.offError(function callback)

• Description

  Stops listening for audio playback error events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio playback error events.

[h2]InnerAudioContext.onCanplay(function callback)

• Description

  Listens for the event that the audio becomes ready to play. This event does not guarantee smooth playback.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for the event that the audio becomes ready to play.

[h2]InnerAudioContext.offCanplay(function callback)

• Description

  Stops listening for the event that the audio becomes ready to play.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for the event that the audio becomes ready to play.

[h2]InnerAudioContext.onWaiting(function callback)

• Description

  Listens for audio loading events. This event occurs when audio playback is interrupted due to insufficient data and buffering is required.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio loading events.

[h2]InnerAudioContext.offWaiting(function callback)

• Description

  Stops listening for audio loading events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio loading events.

[h2]InnerAudioContext.onSeeking(function callback)

• Description

  Listens for audio seek events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio seek events.

[h2]InnerAudioContext.offSeeking(function callback)

• Description

  Stops listening for audio seek events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio seek events.

[h2]InnerAudioContext.onSeeked(function callback)

• Description

  Listens for audio seek completion events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio seek completion events.

[h2]InnerAudioContext.offSeeked(function callback)

• Description

  Stops listening for audio seek completion events.

• Parameters

  Parameter	Type	Mandatory	Description
  callback	function	Yes	Callback function for audio seek completion events.