Tencent Cloud Super App as a Service
- Release Notes and Announcements
- Purchasing Guide
- Plan Management
- Branded Configurations
- Introduction to Platform Functions
- Commercialization
- Virtual Payment
- Guidelines for Code Integration
- Android
- Android SDK Description
- Android API
- Mini Program Management APIs
- Custom Mini Program Capabilities
- Custom SDK Capabilities
- iOS
- iOS SDK Description
- iOS API
- Mini Program Management APIs
- Customize Mini Program Capabilities
- Customised SDK Capabilities
- Flutter
- Flutter SDK Description
- Flutter API
- Mini Program Management API
- Mini Program Capabilities Customization
- Plugin Customization
- App Server
- Payment Development Notes
- Mini Program Payment: Parameter Application and Configuration
- Mini Game Payment: Parameter Application and Configuration
- Mini Program Payment: Signature and Verification
- Guildlines for Mini Program Development
- Mini Program Code Composition
- Guidance
- Learn About Mini Programs
- Configuring Mini Program
- Mini Program Framework
- Basic Competencies
- Open Capabilities
- Framework
- Mini Program Configuration
- Framework Interface
- WXML Syntax Reference
- WXS Syntax Reference
- Components
- API
- Interface
- Media
- Device
- JS SDK
- IDE Operation Instructions
- Guildlines for Mini Game Development
- Guide
- Game Engine
- Basic Capability
- Open Capabilities
- API
- Interface
- Rendering
- Device
- Practice Tutorial
- API Documentation
- Making API Requests
- User Management APIs
- Team Management APIs
- Sensitive API-Related APIs
- Role Management APIs
- Platform Management APIs
- Other Console APIs
- Mini Program APIs
- Management-Sensitive APIs
- Global Domain Management APIs
- Application APIs
DocumentationTencent Cloud Super App as a ServiceGuildlines for Mini Program DevelopmentAPIMediaAudio
Audio
Last updated: 2025-02-24 17:10:36
stopVoice
This API is called using wx.stopVoice(Object object).
Note:
This API is supported in mini programs but not in mini games.
Feature description:Stops the voice playback.
Parameter and description:Object object.
Property | Type | Default value | Required | Description |
success | function | - | False | Callback function for successful API calls. |
fail | function | - | False | Callback function for failed API calls. |
complete | function | - | False | Callback function executed after API call ends (regardless of success or failure). |
Example:
wx.startRecord({success (res) {const tempFilePath = res.tempFilePathwx.playVoice({filePath: tempFilePath,})setTimeout(() => { wx.stopVoice() }, 5000)}})
playVoice
This API is called using wx.playVoice(Object object).
Note:
This API is supported in mini programs but not in mini games.
Feature description:Starts the voice playback. Only one voice file can be played at a time. If a previous voice file is still playing, it will be interrupted.
Parameter and description:
Property | Type | Default value | Required | Description |
filePath | string | - | True | The file path of the voice file to be played (local path). |
duration | number | 60 | False | Specifies the duration of playback in seconds. Playback will stop automatically after this duration. |
success | function | - | False | Callback function for successful API calls. |
fail | function | - | False | Callback function for failed API calls. |
complete | function | - | False | Callback function executed after API call ends (regardless of success or failure). |
Example:
wx.startRecord({success (res) {const tempFilePath = res.tempFilePathwx.playVoice({filePath: tempFilePath,complete () { }})}})
pauseVoice
This API is called using wx.pauseVoice(Object object).
Note:
This API is supported in mini programs but not in mini games.
Feature description:Pauses the voice playback. When you call wx.playVoice to play the same file again, it starts from where the file was paused. If you want to play from the beginning, you first need to call wx.stopVoice.
Parameter and description:Object object.
Property | Type | Default value | Required | Description |
success | function | - | False | Callback function for successful API calls. |
fail | function | - | False | Callback function for failed API calls. |
complete | function | - | False | Callback function executed after API call ends (regardless of success or failure). |
Example:
wx.startRecord({success (res) {const tempFilePath = res.tempFilePathwx.playVoice({filePath: tempFilePath})setTimeout(() => { wx.pauseVoice() }, 5000)}})
setInnerAudioOption
This API is called using wx.setInnerAudioOption(Object object).
Feature description:Sets the playback options for InnerAudioContext, and applies globally to the current mini program.
Parameter: Object object.
Property | Type | Default value | Required | Description |
mixWithOther | boolean | true | False | Whether to mix with other audio. If set to true, it won't stop other app's music. |
obeyMuteSwitch | boolean | true | False | (iOS only) Whether to follow the mute switch. If set to false, it can play sound even in silent mode. |
speakerOn | boolean | true | False | true means using the speaker, false means using the handset. Default is true. |
success | function | - | False | Callback function for successful API calls. |
fail | function | - | False | Callback function for failed API calls. |
complete | function | - | False | Callback function executed after API call ends (regardless of success or failure). |
getAvailableAudioSources
Note:
This API is supported in mini programs but not in mini games.
This API is called using wx.getAvailableAudioSources(Object object).
Feature description:Gets the supported audio input sources.
Parameter and description:Object object.
Property | Type | Default value | Required | Description |
success | function | - | False | Callback function for successful API calls. |
fail | function | - | False | Callback function for failed API calls. |
complete | function | - | False | Callback function executed after API call ends (regardless of success or failure). |
object.success callback function parameter: Object res.
Property | Type | Description |
audioSources | Array.<string> |
AudioSources valid values
Value | Description |
auto | Automatically set. Uses phone mic by default, switches to headset mic when plugged in. Applicable to all platforms. |
buildInMic | Phone microphone, iOS only. |
headsetMic | Headset microphone, iOS only. |
mic | Microphone (phone mic when no headset, headset mic when plugged in), Android only. |
camcorder | Same as mic, suitable for recording audio/video content, Android only. |
voice_communication | Same as mic, suitable for real-time communication, Android only. |
voice_recognition | Same as mic, suitable for voice recognition, Android only. |
createAudioContext
This API is called using AudioContext wx.createAudioContext(string id, Object this).
Note:
This API is supported in mini programs but not in mini games.
Feature description:Creates an AudioContext object.
Parameter and description:String id: The ID of the audio component. Object this: In custom components, this refers to the current component instance to operate on the audio component within.
Return value:AudioContext
AudioContext
Note:
This API is supported in mini programs but not in mini games.
An AudioContext instance that can be obtained using wx.createAudioContext. It binds to an audio component via its ID and allows operations on the corresponding audio component.
pause
This method is called using AudioContext.pause().
Feature description:Pauses the audio.
play
This method is called using AudioContext.play ().
Feature description:Plays the audio.
seek
This method is called using AudioContext.seek(number position).
Feature description:Jumps to the specified position in the audio.
Parameter and description: number position. The position to jump to, in seconds.
setSrc
This method is called using AudioContext.setSrc(string src).
Feature description:Sets the audio source URL.
Parameter and description:string src: The audio source URL.
createInnerAudioContext
This API is called using InnerAudioContext wx.createInnerAudioContext(Object object).
Feature description:Creates an internal
audio context, i.e., an InnerAudioContext object.Return value:InnerAudioContext.
Note:InnerAudioContext audio resources are not automatically released. If the audio is no longer needed, call InnerAudioContext.destroy() to release resources and avoid memory leaks.
Example:
const innerAudioContext = wx.createInnerAudioContext()innerAudioContext.src = 'http://ws.stream.qqmusic.qq.com/M500001VfvsJ21xFqb.mp3?guid=ffffffff82def4af4b12b3cd9337d5e7&uin=346897220&vkey=6292F51E1E384E061FF02C31F716658E5C81F5594D561F2E88B854E81CAAB7806D5E4F103E55D33C16F3FAC506D1AB172DE8600B37E43FAD&fromtag=46'innerAudioContext.play() // Play the audioinnerAudioContext.pause () // Pause the audioinnerAudioContext.stop () // Stop the audioinnerAudioContext.destroy () // Release audio resources
InnerAudioContext
Property
string src: The URL of the audio resource to play.
number startTime: The position to start playing from (in seconds), default is 0.
boolean autoplay: Whether to start playing automatically, default is false.
boolean loop: Whether to loop the audio, default is false.
number volume: The volume level, ranging from 0 to 1. Default is 1.
number duration: The length of the current audio (in seconds). Returns only if there is a valid src (read-only).
number currentTime: The current playback position (in seconds). Returns only if there is a valid src, with time accurate to 6 decimal places (read-only).
boolean paused: Whether the audio is currently paused or stopped (read-only).
number buffered: The time point up to which the audio has been buffered. Only guarantees that the content from the current playback time to this time point has been buffered (read-only).
Supported formats
Format | iOS | Android |
flac | x | √ |
m4a | √ | √ |
ogg | x | √ |
ape | x | √ |
amr | x | √ |
wma | x | √ |
wav | √ | √ |
mp3 | √ | √ |
mp4 | x | √ |
aac | √ | √ |
aiff | √ | x |
caf | √ | x |
Example
const innerAudioContext = wx.createInnerAudioContext()innerAudioContext.autoplay = trueinnerAudioContext.src = 'https://ws.stream.qqmusic.qq.com/M500001VfvsJ21xFqb.mp3?guid=ffffffff82def4af4b12b3cd9337d5e7&uin=346897220&vkey=6292F51E1E384E061FF02C31F716658E5C81F5594D561F2E88B854E81CAAB7806D5E4F103E55D33C16F3FAC506D1AB172DE8600B37E43FAD&fromtag=46'innerAudioContext.onPlay(() => {console.log('Starts to play')})innerAudioContext.onError((res) => {console.log(res.errMsg)console.log(res.errCode)})
Methods collection
play
This method is called using InnerAudioContext.play ().
Feature description:Plays the audio.
pause
This method is called using InnerAudioContext.pause().
Feature description:Pauses the audio. When played again, it will resume from the paused position.
stop
This method is called using InnerAudioContext.stop().
Feature description:Stops the audio. When played again, it will start from the beginning.
seek
This method is called using InnerAudioContext.seek(number position).
Feature description:Jumps to the specified position in the audio.
destroy
This method is called using InnerAudioContext.destroy ().
Feature description:Terminates the current instance.
onCanplay
This method is called using InnerAudioContext.onCanplay(function listener).
Feature description:Listens for the event when the audio can start playing. This does not guarantee smooth playback.
Parameter and description:function listener.The listener for the event when the audio can start playing.
offCanplay
This method is called using InnerAudioContext.offCanplay(function listener).
Feature description:Removes the listener for the event when the audio can start playing.
Parameter and description:function listener. The listener passed to onCanplay. If not provided, all listeners will be removed.
Example:
const listener = function (res) { console.log(res) }InnerAudioContext.onCanplay(listener)InnerAudioContext.offCanplay(listener) // Must pass the same function object used in onCanplay
onPlay
This method is called using InnerAudioContext.onPlay(function listener).
Feature description:Listens for audio play event.
Parameter and description:function listener. The listener for audio play event.
offPlay
This method is called using InnerAudioContext.offPlay(function listener).
Feature description:Removes the listener for audio play event.
Parameter and description:function listener. The listener passed to onPlay. If not provided, all listeners will be removed.
Example:
const listener = function (res) { console.log(res) }InnerAudioContext.onPlay(listener)InnerAudioContext.offPlay(listener) // Must pass the same function object used in onPlay
onPause
This method is called using InnerAudioContext.onPause(function listener).
Feature description:Listens for audio pause event.
Parameter and description:function listener. The listener for the audio pause event.
offPause
This method is called using InnerAudioContext.offPause(function listener).
Feature description:Removes the listener for the audio pause event.
Parameter and description:function listener. The listener passed to onPause. If not provided, all listeners will be removed.
Example:
const listener = function (res) { console.log(res) }InnerAudioContext.onPause(listener)InnerAudioContext.offPause(listener) // Must pass the same function object used in onPause
onStop
This method is called using InnerAudioContext.onStop(function listener).
Feature description:Listens for audio stop event.
Parameter and description:function listener. The listener for audio stop event.
offStop
This method is called using InnerAudioContext.offStop(function listener).
Feature description:Removes the listener for audio stop event.
Parameter and description:function listener. The listener passed to onStop. If not provided, all listeners will be removed.
Example:
const listener = function (res) { console.log(res) }InnerAudioContext.onStop(listener)InnerAudioContext.offStop(listener) // Must pass the same function object used in onStop
onEnded
This method is called using InnerAudioContext.onEnded(function listener).
Feature description:Listens for the event when the audio naturally ends.
Parameter and description:function listener. The listener for the event when the audio naturally ends.
offEnded
This method is called using InnerAudioContext.offEnded(function listener).
Feature description:Removes the listener for the event when the audio naturally ends.
Parameter and description:function listener. The listener passed to onEnded. If not provided, all listeners will be removed.
Example:
const listener = function (res) { console.log(res) }InnerAudioContext.onEnded(listener)InnerAudioContext.offEnded(listener) // Must pass the same function object used in onEnded
onTimeUpdate
This method is called using InnerAudioContext.onTimeUpdate(function listener).
Feature description:Listens for audio playback progress update event.
Parameter and description:function listener. The listener for audio playback progress update events.
offTimeUpdate
This method is called using InnerAudioContext.offTimeUpdate(function listener).
Feature description:Removes the listener for audio playback progress update event.
Parameter and description:function listener. The listener passed to onTimeUpdate. If not provided, all listeners will be removed.
Example:
const listener = function (res) { console.log(res) }InnerAudioContext.onTimeUpdate(listener)InnerAudioContext.offTimeUpdate(listener) // Must pass the same function object used in onTimeUpdate
onError
This method is called using InnerAudioContext.onError(function listener).
Feature description:Listens for audio playback error event.
Parameter and description:function listener. The listener for audio playback error event.
Object res
Property | Type | Description |
errMsg | string | |
errCode | number | |
errCode valid values
Value | Description |
10001 | System error. |
10002 | Network error. |
10003 | File error. |
10004 | Format error. |
-1 | Unknown error. |
Tips：
When errCode=100001, if errMsg contains INNERCODE -11828, check whether Content-Length is missing in the response header.
When errCode=100001, if errMsg contains systemErrCode: 200333420, check whether the file encoding format is consistent with fileExtension.
offError
This method is called using InnerAudioContext.offError(function listener).
Feature description: Removes the listener for audio playback error event.
Parameter and description: function listener. The listener passed to onError. If not provided, all listeners will be removed.
Example:
const listener = function (res) { console.log(res) }InnerAudioContext.onError(listener)InnerAudioContext.offError(listener) // Must pass the same function object used in onError
onWaiting
This method is called using InnerAudioContext.onWaiting(function listener).
Feature description:Listens for audio loading event. It will be triggered when the audio needs to stop and load due to insufficient data.
Parameter and description:function listener. The listener for audio loading event.
offWaiting
This method is called using InnerAudioContext.offWaiting(function listener).
Feature description:Removes the listener for audio loading event.
Parameter and description:function listener. The listener passed to onWaiting. If not provided, all listeners will be removed.
Example:
const listener = function (res) { console.log(res) }InnerAudioContext.onWaiting(listener)InnerAudioContext.offWaiting(listener) // Must pass the same function object used in onWaiting
onSeeking
This method is called using InnerAudioContext.onSeeking(function listener).
Feature description:Listens for audio seeking event.
Parameter and description:function listener. The listener for audio seeking event.
offSeeking
This method is called using InnerAudioContext.offSeeking(function listener).
Feature description:Removes the listener for audio seeking event.
Parameter and description:function listener. The listener passed to onSeeking. If not provided, all listeners will be removed.
Example:
const listener = function (res) { console.log(res) }InnerAudioContext.onSeeking(listener)InnerAudioContext.offSeeking(listener) // Must pass the same function object used in onSeeking
onSeeked
This method is called using InnerAudioContext.onSeeked(function listener).
Feature description:Listens for the event when audio seeking is completed.
Parameter and description:function listener. The listener for the event when audio seeking is completed.
offSeeked
This method is called using InnerAudioContext.offSeeked(function listener).
Feature description:Removes the listener for the event when audio seeking is completed.
Parameter and description:function listener. The listener passed to onSeeked. If not provided, all listeners will be removed.
Example:
const listener = function (res) { console.log(res) }InnerAudioContext.onSeeked(listener)InnerAudioContext.offSeeked(listener) // Must pass the same function object used in onSeeked
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No