Development Guidelines on Audio Playback

• When to Use
• Available APIs

When to Use

You use audio playback APIs to convert audio data into audible analog signals, play the audio signals using output devices, and manage playback tasks.

Figure 1 Playback status

Available APIs

Table 1 media

Table 2 AudioPlayer

1. Create an audio player.

   var player = media.createAudioPlayer();

2. Set the listeners.

   player.on('play', (err, action) => {
       if (err) {
           console.log(`err returned in play() callback`);
           return;
        }
        console.info('Current Song duration: '+duration);
        console.log(`In play callback current time: ${player.currentTime}`);
        console.info('Current Player Status: '+player.state);
        console.info('Pause Mp3');
        player.pause();
   });
   player.on('pause', (err, action) => {
        if (err) {
            console.log(`err returned in pause() callback`);
            return;
         }
         console.log(`pause callback, state: ${player.state}`);
         console.info('Current Player Status: '+player.state);
         var currentTime = player.currenTime;
         console.info('Current Player Time: '+currentTime);
         player.seek(30000); //seek for 30 seconds
   });
   player.on('stop', (err, action) => {
       if (err) {
           console.log(`err returned in stop() callback`);
           return;
       }
       console.log(`stop callback, state: ${player.state}`);
   });
   player.on('dataLoad', (err, action) => {
       if (err) {
           console.log(`err returned in dataLoad() callback`);
           return;
       }
        console.log(`dataLoad callback is called, current time: ${player.currentTime}`);
        console.log(`Duration of the source: ${player.duration}`);
   });
   player.on('finish', (err, action) => {
        if (err) {
           console.log(`err returned in finish() callback`);
           return;
        }
        console.log(`Player finish callback is called`);
   });
   player.on('timeUpdate', (err, action) => {
       if (err) {
           console.log(`err returned in timeUpdate() callback`);
           return;
       }
       console.log(`In timeupdate callback current time: ${player.currentTime}`);
       var newTime = player.currentTime;
       if(newTime = 30000) {
           console.info('Seek success, new time : '+newTime);
       } else {
           console.info('Seek Failed');
        }
           player.stop();
   });
   player.on('durationchange', (err, action) => {
        if (err) {
            console.log(`err returned in durationchange callback`);
            return;
        }
        console.log(`Durationchange callback is called`);
   });
   player.on('error', (err) => {
        console.error(`player error: ${err.message}`);
   });
   

3. Start playback.

   var audioSourceMp3 = 'file://test.mp3';
   player.src = audioSourceMp3;
   player.loop = true;
   player.play();