# Audio Playback
- [Modules to Import](#en-us_topic_0000001103383404_s56d19203690d4782bfc74069abb6bd71)
- [Required Permissions](#en-us_topic_0000001103383404_section11257113618419)
- [Methods](#en-us_topic_0000001103383404_section125675489541)
- [createAudioPlayer\(\)](#en-us_topic_0000001103383404_section582314017253)
- [Appendixes](#en-us_topic_0000001103383404_section1933416317165)
- [AudioPlayer](#en-us_topic_0000001103383404_section5174142818365)
- [Attributes](#en-us_topic_0000001103383404_section4947115405)
- [play\(\)](#en-us_topic_0000001103383404_section964512672913)
- [pause\(\)](#en-us_topic_0000001103383404_section78173258296)
- [stop\(\)](#en-us_topic_0000001103383404_section122114334296)
- [seek\(number\)](#en-us_topic_0000001103383404_section1387113816298)
- [setVolume\(number\)](#en-us_topic_0000001103383404_section164235176552)
- [release\(\)](#en-us_topic_0000001103383404_section9224621145512)
- [Events](#en-us_topic_0000001103383404_section5453721192911)
- [play](#en-us_topic_0000001103383404_section87307411494)
- [pause](#en-us_topic_0000001103383404_section198217471590)
- [stop](#en-us_topic_0000001103383404_section437616531910)
- [dataLoad](#en-us_topic_0000001103383404_section982114219106)
- [timeUpdate](#en-us_topic_0000001103383404_section13687114181014)
- [volumeChange](#en-us_topic_0000001103383404_section139227715717)
- [finish](#en-us_topic_0000001103383404_section15181321181018)
- [error](#en-us_topic_0000001103383404_section5593132921016)
- [AudioState](#en-us_topic_0000001103383404_section5181155710523)
## Modules to Import
```
import audio from '@ohos.multimedia.media';
```
## Required Permissions
None
## Methods
## createAudioPlayer\(\)
Creates an **AudioPlayer** instance to control audio playback.
**Return Values**
Type
|
Description
|
AudioPlayer
|
Returns the AudioPlayer instance if the operation is successful; returns null otherwise.
|
**Example**
```
var audioplayer = audio.createAudioPlayer();
```
## Appendixes
## AudioPlayer
Represents an audio player.
### Attributes
Name
|
Type
|
Readable
|
Writable
|
Description
|
src
|
string
|
Yes
|
Yes
|
URI of the audio resources
|
loop
|
boolean
|
Yes
|
Yes
|
Whether to loop audio playback
|
currentTime
|
number
|
Yes
|
No
|
Current playback position
|
duration
|
number
|
Yes
|
No
|
Playback duration
|
state
|
AudioState
|
Yes
|
No
|
Playback status
|
### play\(\)
Starts audio playback.
**Example**
```
audioplayer.src = 'common/mydream.mp3';
audioplayer.on('play', (err, action) => {
if (err) {
console.log(`err returned in play() callback`);
return;
}
console.log('start to play');
audioplayer.pause();
};
audioplayer.play();
```
### pause\(\)
Pauses audio playback.
**Example**
```
audioplayer.src = 'common/mydream.mp3';
audioplayer.on('pause', (err, action) => {
if (err) {
console.log(`err returned in pause() callback`);
return;
}
console.log('playback pause');
};
audioplayer.pause();
```
### stop\(\)
Stops audio playback.
**Example**
```
audioplayer.src = 'common/mydream.mp3';
audioplayer.on('stop',(err, action) => {
if (err) {
console.log(`err returned in stop() callback`);
return;
}
console.log('playback stop');
};
audioplayer.stop();
```
### seek\(number\)
Goes to a specified playback position.
**Parameters**
Name
|
Type
|
Mandatory
|
Description
|
timeMs
|
number
|
Yes
|
Target playback position
|
**Example**
```
audioplayer.src = 'common/mydream.mp3';
audioplayer.on('timeupdate', (err, action) => {
if (err) {
console.log(`err returned in seek() callback`);
return;
}
var newTime = audioplayer.currenTime;
if(newTime = 30000) {
console.info('Seek success, new time : ' + newTime);
} else {
console.info('Seek Failed');
}
};
audioplayer.seek(30000);
```
### setVolume\(number\)
Sets the volume.
**Parameters**
Name
|
Type
|
Mandatory
|
Description
|
vol
|
number
|
Yes
|
Volume to set
|
**Example**
```
audioplayer.src = 'common/mydream.mp3';
audioplayer.on('volumeChange', (err, action) => {
if (err) {
console.log(`err returned in setVolume() callback`);
return;
}
console.log('playback volume change');
};
audioplayer.setVolume(30);
```
### release\(\)
Releases audio resources.
**Example**
```
audioplay.release();
```
### Events
### play
Triggered when **play\(\)** is called
### pause
Triggered when **pause\(\)** is called
### stop
Triggered when **stop\(\)** is called
### dataLoad
Triggered when audio data is loaded
### timeUpdate
Triggered when the playback position changes
### volumeChange
Triggered when playback volume changes
### finish
Triggered when playback is finished
### error
Triggered when a playback error occurs
Parameter
|
Type
|
Description
|
callback
|
ErrorCallback
|
Callback function for handling this event
|
## AudioState
Describes playback status.
Parameter
|
Description
|
playing
|
The audio is being played.
|
paused
|
Audio playback is paused.
|
stopped
|
Audio playback is stopped.
|