InnerAudioContext

title: InnerAudioContext

sidebar_label: InnerAudioContext

The InnerAudioContext instance can be obtained through the API Taro.createInnerAudioContext.

Supported Formats

Reference

Methods

play

Plays an audio file.

() => void

pause

Pauses the audio playback. The playback is resumed at the point where it was paused.

() => void

stop

Stops the audio playback. The playback starts from the beginning if the file is played again.

() => void

seek

Jumps to the specific position.

(position: number) => void

destroy

Terminates the current instance.

() => void

onCanplay

Listens on the event that an audio file is ready for playback. A smooth playback is not guaranteed.

(callback?: () => void) => void

onPlay

Listens on the audio playback event.

(callback?: () => void) => void

onPause

Listens on the audio pause event.

(callback?: () => void) => void

onStop

Listens on the event of stopping audio playback.

(callback?: () => void) => void

onEnded

Listens on the event of playing an audio file to the end without interruption.

(callback?: () => void) => void

onTimeUpdate

Listens on the event of updating audio playback progress.

(callback?: () => void) => void

onError

Listens on the audio playback error event.

(callback?: (res: onErrorDetail) => void) => void

onWaiting

Listens on the audio loading event. It is triggered when the playback of an audio file stops to load the file due to insufficient data.

(callback?: () => void) => void

onSeeking

Listens on the event of jumping to a specific position in the audio file.

(callback?: () => void) => void

onSeeked

Listens on the event of finishing the jump to a specific position in the audio file.

(callback?: () => void) => void

offCanplay

Un-listens on the event that an audio file is ready for playback.

(callback?: () => void) => void

offPlay

Un-listens on the audio playback event.

(callback?: () => void) => void

offPause

Un-listens on the audio pause event.

(callback?: () => void) => void

offStop

Un-listens on the event of stopping audio playback.

(callback?: () => void) => void

offEnded

Un-listens on the event of playing an audio file to the end without interruption.

(callback?: () => void) => void

offTimeUpdate

Un-listens on the event of updating audio playback progress.

(callback?: () => void) => void

offError

Un-listens on the audio playback error event.

(callback?: () => void) => void

offWaiting

Un-listens on the audio loading event.

(callback?: () => void) => void

offSeeking

Un-listens on the event of jumping to a specific position in the audio file.

(callback?: () => void) => void

offSeeked

Un-listens on the event of finishing the jump to a specific position in the audio file.

(callback?: () => void) => void

Parameters

onErrorDetail

onErrorDetailErrCode

Valid values of errCode

Sample Code

const innerAudioContext = Taro.createInnerAudioContext()
innerAudioContext.autoplay = true
innerAudioContext.src = 'https://ws.stream.qqmusic.qq.com/M500001VfvsJ21xFqb.mp3?guid=ffffffff82def4af4b12b3cd9337d5e7&uin=346897220&vkey=6292F51E1E384E061FF02C31F716658E5C81F5594D561F2E88B854E81CAAB7806D5E4F103E55D33C16F3FAC506D1AB172DE8600B37E43FAD&fromtag=46'
innerAudioContext.onPlay(() => {
  console.log('Start playback')
})
innerAudioContext.onError((res) => {
  console.log(res.errMsg)
  console.log(res.errCode)
})

API Support