@@ -22,32 +22,43 @@ For details about the APIs, see [AudioPlayer in the Media API](../reference/apis
...
@@ -22,32 +22,43 @@ For details about the APIs, see [AudioPlayer in the Media API](../reference/apis
The full audio playback process includes creating an instance, setting the URI, playing audio, seeking to the playback position, setting the volume, pausing playback, obtaining track information, stopping playback, resetting the player, and releasing resources.
The full audio playback process includes creating an instance, setting the URI, playing audio, seeking to the playback position, setting the volume, pausing playback, obtaining track information, stopping playback, resetting the player, and releasing resources.
For details about the **src**media source input types supported by **AudioPlayer**, see the [src attribute](../reference/apis/js-apis-media.md#audioplayer_attributes).
For details about the **src** types supported by **AudioPlayer**, see the [src attribute](../reference/apis/js-apis-media.md#audioplayer_attributes).
```js
```js
importmediafrom'@ohos.multimedia.media'
importmediafrom'@ohos.multimedia.media'
importfileIOfrom'@ohos.fileio'
importfileIOfrom'@ohos.fileio'
functionSetCallBack(audioPlayer){
// Print the stream track information.
functionprintfDescription(obj){
for(letiteminobj){
letproperty=obj[item];
console.info('audio key is '+item);
console.info('audio value is '+property);
}
}
// Set the player callbacks.
functionsetCallBack(audioPlayer){
audioPlayer.on('dataLoad',()=>{// Set the 'dataLoad' event callback, which is triggered when the src attribute is set successfully.
audioPlayer.on('dataLoad',()=>{// Set the 'dataLoad' event callback, which is triggered when the src attribute is set successfully.
console.info('audio set source success');
console.info('audio set source success');
// The playback page is ready. You can click the Play button to start the playback.
audioPlayer.play();// The play() API can be invoked only after the 'dataLoad' event callback is complete. The 'play' event callback is then triggered.
});
});
audioPlayer.on('play',()=>{// Set the 'play' event callback.
audioPlayer.on('play',()=>{// Set the 'play' event callback.
console.info('audio play success');
console.info('audio play success');
// The Play button is changed to the pausable state.
audioPlayer.pause();// Trigger the 'pause' event callback and pause the playback.
});
});
audioPlayer.on('pause',()=>{// Set the 'pause' event callback.
audioPlayer.on('pause',()=>{// Set the 'pause' event callback.
console.info('audio pause success');
console.info('audio pause success');
// The Play button is changed to the playable state.
audioPlayer.seek(5000);// Trigger the 'timeUpdate' event callback, and seek to 5000 ms for playback.
});
});
audioPlayer.on('stop',()=>{// Set the 'stop' event callback.
audioPlayer.on('stop',()=>{// Set the 'stop' event callback.
console.info('audio stop success');
console.info('audio stop success');
// The playback stops, the playback progress bar returns to 0, and the Play button is changed to the playable state.
audioPlayer.reset();// Trigger the 'reset' event callback, and reconfigure the src attribute to switch to the next song.
});
});
audioPlayer.on('reset',()=>{// Set the 'reset' event callback.
audioPlayer.on('reset',()=>{// Set the 'reset' event callback.
console.info('audio reset success');
console.info('audio reset success');
// You can reconfigure the src attribute to play another audio file.
audioPlayer.release();// Release the AudioPlayer resources.
audioPlayer=undefined;
});
});
audioPlayer.on('timeUpdate',(seekDoneTime)=>{// Set the 'timeUpdate' event callback.
audioPlayer.on('timeUpdate',(seekDoneTime)=>{// Set the 'timeUpdate' event callback.
if(typeof(seekDoneTime)=='undefined'){
if(typeof(seekDoneTime)=='undefined'){
...
@@ -55,11 +66,20 @@ function SetCallBack(audioPlayer) {
...
@@ -55,11 +66,20 @@ function SetCallBack(audioPlayer) {
return;
return;
}
}
console.info('audio seek success, and seek time is '+seekDoneTime);
console.info('audio seek success, and seek time is '+seekDoneTime);
// The playback progress bar is updated to the seek position.
audioPlayer.setVolume(0.5);// Trigger the 'volumeChange' event callback.
});
});
audioPlayer.on('volumeChange',()=>{// Set the 'volumeChange' event callback.
audioPlayer.on('volumeChange',()=>{// Set the 'volumeChange' event callback.
console.info('audio volumeChange success');
console.info('audio volumeChange success');
// Display the updated volume.
audioPlayer.getTrackDescription((error,arrlist)=>{// Obtain the audio track information in callback mode.
audioPlayer.stop();// Trigger the 'stop' event callback to stop the playback.
});
});
});
audioPlayer.on('finish',()=>{// Set the 'finish' event callback, which is triggered when the playback is complete.
audioPlayer.on('finish',()=>{// Set the 'finish' event callback, which is triggered when the playback is complete.
console.info('audio play finish');
console.info('audio play finish');
...
@@ -71,56 +91,24 @@ function SetCallBack(audioPlayer) {
...
@@ -71,56 +91,24 @@ function SetCallBack(audioPlayer) {
});
});
}
}
functionprintfDescription(obj){
asyncfunctionaudioPlayerDemo(){
for(letiteminobj){
// 1. Create an audioPlayer instance.
letproperty=obj[item];
letaudioPlayer=media.createAudioPlayer();
console.info('audio key is '+item);
setCallBack(audioPlayer);// Set the event callbacks.
console.info('audio value is '+property);
// 2. Set the URI of the audio file selected by the user.
}
letfdPath='fd://'
}
// The stream in the path can be pushed to the device by running the "hdc file send D:\xxx\01.mp3 /data/app/el1/bundle/public/ohos.acts.multimedia.audio.audioplayer/ohos.acts.multimedia.audio.audioplayer/assets/entry/resources/rawfile" command.
audioPlayer.stop();// Trigger the 'stop' event callback.
// 9. Reset the player.
audioPlayer.reset();// Trigger the 'reset' event callback, and reconfigure the src attribute to switch to the next song.
// 10. Release the resource.
audioPlayer.release();// Release the AudioPlayer instance.
audioPlayer=undefined;
```
```
### Normal Playback Scenario
### Normal Playback Scenario
...
@@ -128,8 +116,9 @@ audioPlayer = undefined;
...
@@ -128,8 +116,9 @@ audioPlayer = undefined;
```js
```js
importmediafrom'@ohos.multimedia.media'
importmediafrom'@ohos.multimedia.media'
importfileIOfrom'@ohos.fileio'
importfileIOfrom'@ohos.fileio'
exportclassAudioDemo{
functionSetCallBack(audioPlayer){
// Set the player callbacks.
setCallBack(audioPlayer){
audioPlayer.on('dataLoad',()=>{// Set the 'dataLoad' event callback, which is triggered when the src attribute is set successfully.
audioPlayer.on('dataLoad',()=>{// Set the 'dataLoad' event callback, which is triggered when the src attribute is set successfully.
console.info('audio set source success');
console.info('audio set source success');
audioPlayer.play();// Call the play() API to start the playback and trigger the 'play' event callback.
audioPlayer.play();// Call the play() API to start the playback and trigger the 'play' event callback.
...
@@ -139,27 +128,28 @@ function SetCallBack(audioPlayer) {
...
@@ -139,27 +128,28 @@ function SetCallBack(audioPlayer) {
});
});
audioPlayer.on('finish',()=>{// Set the 'finish' event callback, which is triggered when the playback is complete.
audioPlayer.on('finish',()=>{// Set the 'finish' event callback, which is triggered when the playback is complete.
console.info('audio play finish');
console.info('audio play finish');
audioPlayer.release();// Release the AudioPlayer instance.
audioPlayer.release();// Release the AudioPlayer resources.
audioPlayer=undefined;
audioPlayer=undefined;
});
});
}
}
letaudioPlayer=media.createAudioPlayer();// Create an AudioPlayer instance.
asyncaudioPlayerDemo(){
SetCallBack(audioPlayer);// Set the event callbacks.
letaudioPlayer=media.createAudioPlayer();// Create an AudioPlayer instance.
/* Set the FD (local playback) of the audio file selected by the user. */
this.setCallBack(audioPlayer);// Set the event callbacks.
letfdPath='fd://'
letfdPath='fd://'
// The stream in the path can be pushed to the device by running the "hdc file send D:\xxx\01.mp3 /data/accounts/account_0/appdata" command.
// The stream in the path can be pushed to the device by running the "hdc file send D:\xxx\01.mp3 /data/app/el1/bundle/public/ohos.acts.multimedia.audio.audioplayer/ohos.acts.multimedia.audio.audioplayer/assets/entry/resources/rawfile" command.
audioPlayer.src=fdPath;// Set the src attribute and trigger the 'dataLoad' event callback.
audioPlayer.src=fdPath;// Set the src attribute and trigger the 'dataLoad' event callback.
}
}
```
```
### Switching to the Next Song
### Switching to the Next Song
...
@@ -167,54 +157,62 @@ audioPlayer.src = fdPath; // Set the src attribute and
...
@@ -167,54 +157,62 @@ audioPlayer.src = fdPath; // Set the src attribute and
```js
```js
importmediafrom'@ohos.multimedia.media'
importmediafrom'@ohos.multimedia.media'
importfileIOfrom'@ohos.fileio'
importfileIOfrom'@ohos.fileio'
exportclassAudioDemo{
functionSetCallBack(audioPlayer){
// Set the player callbacks.
privateisNextMusic=false;
setCallBack(audioPlayer){
audioPlayer.on('dataLoad',()=>{// Set the 'dataLoad' event callback, which is triggered when the src attribute is set successfully.
audioPlayer.on('dataLoad',()=>{// Set the 'dataLoad' event callback, which is triggered when the src attribute is set successfully.
console.info('audio set source success');
console.info('audio set source success');
audioPlayer.play();// Call the play() API to start the playback and trigger the 'play' event callback.
audioPlayer.play();// Call the play() API to start the playback and trigger the 'play' event callback.
});
});
audioPlayer.on('play',()=>{// Set the 'play' event callback.
audioPlayer.on('play',()=>{// Set the 'play' event callback.
console.info('audio play success');
console.info('audio play success');
audioPlayer.reset();// Call the reset() API and trigger the 'reset' event callback.
});
});
audioPlayer.on('finish',()=>{// Set the 'finish' event callback, which is triggered when the playback is complete.
audioPlayer.on('reset',()=>{// Set the 'reset' event callback.
console.info('audio play finish');
console.info('audio play success');
if(!this.isNextMusic){// When isNextMusic is false, changing songs is implemented.
this.nextMusic(audioPlayer);// Changing songs is implemented.
}else{
audioPlayer.release();// Release the AudioPlayer instance.
audioPlayer.release();// Release the AudioPlayer instance.
audioPlayer=undefined;
audioPlayer=undefined;
}
});
});
}
}
letaudioPlayer=media.createAudioPlayer();// Create an AudioPlayer instance.
asyncnextMusic(audioPlayer){
SetCallBack(audioPlayer);// Set the event callbacks.
this.isNextMusic=true;
/* Set the FD (local playback) of the audio file selected by the user. */
letnextFdPath='fd://'
letfdPath='fd://'
// The stream in the path can be pushed to the device by running the "hdc file send D:\xxx\02.mp3 /data/app/el1/bundle/public/ohos.acts.multimedia.audio.audioplayer/ohos.acts.multimedia.audio.audioplayer/assets/entry/resources/rawfile" command.
// The stream in the path can be pushed to the device by running the "hdc file send D:\xxx\01.mp3 /data/accounts/account_0/appdata" command.
// The stream in the path can be pushed to the device by running the "hdc file send D:\xxx\01.mp3 /data/app/el1/bundle/public/ohos.acts.multimedia.audio.audioplayer/ohos.acts.multimedia.audio.audioplayer/assets/entry/resources/rawfile" command.
// The stream in the path can be pushed to the device by running the "hdc file send D:\xxx\01.mp3 /data/app/el1/bundle/public/ohos.acts.multimedia.audio.audioplayer/ohos.acts.multimedia.audio.audioplayer/assets/entry/resources/rawfile" command.
audioPlayer.src=fdPath;// Set the src attribute and trigger the 'dataLoad' event callback.
audioPlayer.src=fdPath;// Set the src attribute and trigger the 'dataLoad' event callback.
}
audioPlayer.loop=true;// Set the loop playback attribute.
}
```
```
## Samples
## Samples
...
@@ -263,7 +257,6 @@ audioPlayer.loop = true; // Set the loop playback att
...
@@ -263,7 +257,6 @@ audioPlayer.loop = true; // Set the loop playback att
The following samples are provided to help you better understand how to develop audio playback:
The following samples are provided to help you better understand how to develop audio playback:
-[`JsDistributedMusicPlayer`: Distributed Music Player (JS) (API7)](https://gitee.com/openharmony/app_samples/tree/master/ability/JsDistributedMusicPlayer)
-[`JsDistributedMusicPlayer`: Distributed Music Player (JS) (API7)](https://gitee.com/openharmony/app_samples/tree/master/ability/JsDistributedMusicPlayer)
-[`JsAudioPlayer`: Audio Playback and Management (JS, API 7)](https://gitee.com/openharmony/app_samples/tree/master/media/JsAudioPlayer)
-[`JsAudioPlayer`: Audio Playback and Management (JS) (API7)](https://gitee.com/openharmony/app_samples/tree/master/media/JsAudioPlayer)
-[`eTsAudioPlayer`: Audio Player (eTS)](https://gitee.com/openharmony/app_samples/blob/master/media/Recorder/entry/src/main/ets/MainAbility/pages/Play.ets)
privatetestFdNumber;// Used to save the FD address.
lettestFdNumber;
// Set the callbacks related to audio recording.
setCallBack(audioRecorder){
functionSetCallBack(audioRecorder){
audioRecorder.on('prepare',()=>{// Set the 'prepare' event callback.
audioRecorder.on('prepare',()=>{// Set the 'prepare' event callback.
console.log('prepare success');
console.log('prepare success');
// The recording page is ready. You can click the Record button to start recording.
audioRecorder.start();// Call the start API to start recording and trigger the 'start' event callback.
});
});
audioRecorder.on('start',()=>{// Set the 'start' event callback.
audioRecorder.on('start',()=>{// Set the 'start' event callback.
console.log('audio recorder start success');
console.log('audio recorder start success');
// The Record button is changed to the pausable state.
audioRecorder.pause();// Call the pause API to pause recording and trigger the 'pause' event callback.
});
});
audioRecorder.on('pause',()=>{// Set the 'pause' event callback.
audioRecorder.on('pause',()=>{// Set the 'pause' event callback.
console.log('audio recorder pause success');
console.log('audio recorder pause success');
// The Record button is changed to the recordable state.
audioRecorder.resume();// Call the resume API to resume recording and trigger the 'resume' event callback.
});
});
audioRecorder.on('resume',()=>{// Set the 'resume' event callback.
audioRecorder.on('resume',()=>{// Set the 'resume' event callback.
console.log('audio recorder resume success');
console.log('audio recorder resume success');
// The Record button is changed to the pausable state.
audioRecorder.stop();// Call the stop API to stop recording and trigger the 'stop' event callback.
});
});
audioRecorder.on('stop',()=>{// Set the 'stop' event callback.
audioRecorder.on('stop',()=>{// Set the 'stop' event callback.
console.log('audio recorder stop success');
console.log('audio recorder stop success');
});
audioRecorder.reset();// Call the reset API to reset the recorder and trigger the 'reset' event callback.
audioRecorder.on('release',()=>{// Set the 'release' event callback.
console.log('audio recorder release success');
});
});
audioRecorder.on('reset',()=>{// Set the 'reset' event callback.
audioRecorder.on('reset',()=>{// Set the 'reset' event callback.
console.log('audio recorder reset success');
console.log('audio recorder reset success');
// You need to reset the recording parameters for another recording.
audioRecorder.release();// Call the release API to release resources and trigger the 'release' event callback.
});
audioRecorder.on('release',()=>{// Set the 'release' event callback.
console.log('audio recorder release success');
audioRecorder=undefined;
});
});
audioRecorder.on('error',(error)=>{// Set the 'error' event callback.
audioRecorder.on('error',(error)=>{// Set the 'error' event callback.
console.info(`audio error called, errName is ${error.name}`);
console.info(`audio error called, errName is ${error.name}`);
console.info(`audio error called, errCode is ${error.code}`);
console.info(`audio error called, errCode is ${error.code}`);
console.info(`audio error called, errMessage is ${error.message}`);
console.info(`audio error called, errMessage is ${error.message}`);
});
});
}
}
// pathName indicates the passed recording file name, for example, 01.mp3. The generated file address is /storage/media/100/local/files/Movies/01.mp3.
// pathName indicates the passed recording file name, for example, 01.mp3. The generated file address is /storage/media/100/local/files/Video/01.mp3.
// To use the media library, declare the following permissions: ohos.permission.MEDIA_LOCATION, ohos.permission.WRITE_MEDIA, and ohos.permission.READ_MEDIA.
// To use the media library, declare the following permissions: ohos.permission.MEDIA_LOCATION, ohos.permission.WRITE_MEDIA, and ohos.permission.READ_MEDIA.
asyncfunctiongetFd(pathName){
asyncgetFd(pathName){
letdisplayName=pathName;
letdisplayName=pathName;
constmediaTest=mediaLibrary.getMediaLibrary();
constmediaTest=mediaLibrary.getMediaLibrary();
letfileKeyObj=mediaLibrary.FileKey;
letfileKeyObj=mediaLibrary.FileKey;
...
@@ -80,41 +83,29 @@ async function getFd(pathName) {
...
@@ -80,41 +83,29 @@ async function getFd(pathName) {
privatetestFdNumber;// Used to save the FD address.
lettestFdNumber;
// Set the callbacks related to audio recording.
setCallBack(audioRecorder){
functionSetCallBack(audioRecorder){
audioRecorder.on('prepare',()=>{// Set the 'prepare' event callback.
audioRecorder.on('prepare',()=>{// Set the 'prepare' event callback.
console.log('prepare success');
console.log('prepare success');
// The recording page is ready. You can click the Record button to start recording.
audioRecorder.start();// Call the start API to start recording and trigger the 'start' event callback.
});
});
audioRecorder.on('start',()=>{// Set the 'start' event callback.
audioRecorder.on('start',()=>{// Set the 'start' event callback.
console.log('audio recorder start success');
console.log('audio recorder start success');
// The Record button is changed to the pausable state.
audioRecorder.stop();// Call the stop API to stop recording and trigger the 'stop' event callback.
});
});
audioRecorder.on('stop',()=>{// Set the 'stop' event callback.
audioRecorder.on('stop',()=>{// Set the 'stop' event callback.
console.log('audio recorder stop success');
console.log('audio recorder stop success');
audioRecorder.release();// Call the release API to release resources and trigger the 'release' event callback.
});
});
audioRecorder.on('release',()=>{// Set the 'release' event callback.
audioRecorder.on('release',()=>{// Set the 'release' event callback.
console.log('audio recorder release success');
console.log('audio recorder release success');
audioRecorder=undefined;
});
});
}
audioRecorder.on('error',(error)=>{// Set the 'error' event callback.
console.info(`audio error called, errName is ${error.name}`);
console.info(`audio error called, errCode is ${error.code}`);
console.info(`audio error called, errMessage is ${error.message}`);
});
}
// pathName indicates the passed recording file name, for example, 01.mp3. The generated file address is /storage/media/100/local/files/Movies/01.mp3.
// pathName indicates the passed recording file name, for example, 01.mp3. The generated file address is /storage/media/100/local/files/Video/01.mp3.
// To use the media library, declare the following permissions: ohos.permission.MEDIA_LOCATION, ohos.permission.WRITE_MEDIA, and ohos.permission.READ_MEDIA.
// To use the media library, declare the following permissions: ohos.permission.MEDIA_LOCATION, ohos.permission.WRITE_MEDIA, and ohos.permission.READ_MEDIA.
asyncfunctiongetFd(pathName){
asyncgetFd(pathName){
letdisplayName=pathName;
letdisplayName=pathName;
constmediaTest=mediaLibrary.getMediaLibrary();
constmediaTest=mediaLibrary.getMediaLibrary();
letfileKeyObj=mediaLibrary.FileKey;
letfileKeyObj=mediaLibrary.FileKey;
...
@@ -162,33 +161,35 @@ async function getFd(pathName) {
...
@@ -162,33 +161,35 @@ async function getFd(pathName) {
awaitthis.getFd('01.mp3');// Call the getFd method to obtain the FD address of the file to be recorded.
audioEncoder:media.AudioEncoder.AAC_LC,
// 3. Set the recording parameters.
letaudioRecorderConfig={
audioEncodeBitRate:22050,
audioEncodeBitRate:22050,
audioSampleRate:22050,
audioSampleRate:22050,
numberOfChannels:2,
numberOfChannels:2,
format:media.AudioOutputFormat.AAC_ADTS,
uri:this.testFdNumber,// testFdNumber is generated by getFd.
uri:testFdNumber,// testFdNumber is generated by getFd.
location:{latitude:30,longitude:130},
location:{latitude:30,longitude:130},
audioEncoderMime:media.CodecMimeType.AUDIO_AAC,
fileFormat:media.ContainerFormatType.CFT_MPEG_4A,
}
audioRecorder.prepare(audioRecorderConfig);// Call the prepare method to trigger the 'prepare' event callback.
}
}
}
audioRecorder.prepare(audioRecorderConfig)
// 4. Start recording.
audioRecorder.start();// The start API can be called to trigger the 'start' event callback only after the 'prepare' event callback is complete.
// 5. Stop recording.
audioRecorder.stop();// The stop API can be called to trigger the 'stop' event callback only after the 'start' or 'resume' event callback is complete.
// 6. Release resources.
audioRecorder.release();// The AudioRecorder resource is destroyed.
audioRecorder=undefined;
```
```
## Samples
The following samples are provided to help you better understand how to develop audio recording:
-[`Recorder`: Recorder (eTS, API 8)](https://gitee.com/openharmony/app_samples/tree/master/media/Recorder)
-[`eTsAudioPlayer`: Audio Player (eTS)](https://gitee.com/openharmony/app_samples/blob/master/media/Recorder/entry/src/main/ets/MainAbility/pages/Play.ets)
@@ -16,21 +16,20 @@ During video recording, audio and video signals are captured, encoded, and saved
...
@@ -16,21 +16,20 @@ During video recording, audio and video signals are captured, encoded, and saved
## How to Develop
## How to Develop
For details about the APIs used for video recording, see [VideoRecorder in the Media API](../reference/apis/js-apis-media.md).
For details about the APIs, see [VideoRecorder in the Media API](../reference/apis/js-apis-media.md).
### Full-Process Scenario
### Full-Process Scenario
The full video recording process includes creating an instance, setting recording parameters, recording video, pausing, resuming, and stopping recording, and releasing resources.
The full video recording process includes creating an instance, setting recording parameters, starting, pausing, resuming, and stopping recording, and releasing resources.
privatetestFdNumber;// Used to save the FD address.
// pathName indicates the passed recording file name, for example, 01.mp4. The generated file address is /storage/media/100/local/files/Video/01.mp4.
// pathName indicates the passed recording file name, for example, 01.mp4. The generated file address is /storage/media/100/local/files/Movies/01.mp4.
// To use the media library, declare the following permissions: ohos.permission.MEDIA_LOCATION, ohos.permission.WRITE_MEDIA, and ohos.permission.READ_MEDIA.
// To use the media library, declare the following permissions: ohos.permission.MEDIA_LOCATION, ohos.permission.WRITE_MEDIA, and ohos.permission.READ_MEDIA.
asyncgetFd(pathName){
asyncfunctiongetFd(pathName){
letdisplayName=pathName;
letdisplayName=pathName;
constmediaTest=mediaLibrary.getMediaLibrary();
constmediaTest=mediaLibrary.getMediaLibrary();
letfileKeyObj=mediaLibrary.FileKey;
letfileKeyObj=mediaLibrary.FileKey;
...
@@ -46,14 +45,31 @@ async function getFd(pathName) {
...
@@ -46,14 +45,31 @@ async function getFd(pathName) {
// Video recording depends on camera-related interfaces. The following operations can be performed only after the video output start interface is invoked.
// Start video recording.
// Video recording depends on camera-related APIs. The following operations can be performed only after the video output start API is invoked. For details about how to call the camera APIs, see the samples.