Deprecated Interface (AudioPlayer, deprecated)

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use AVPlayer instead.

AudioPlayer is a class for audio playback management. It provides APIs to manage and play audio. Before calling any API in AudioPlayer, you must use createAudioPlayer() to create an AudioPlayer instance.

Modules to Import

import { media } from '@kit.MediaKit';

Properties^(deprecated)

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Name	Type	Read-Only	Optional	Description
src	string	No	No	Audio file URI. The mainstream audio formats (M4A, AAC, MP3, OGG, WAV, and AMR) are supported. Example of supported URLs: 1. FD: fd://xx 2. HTTP: http://xx 3. HTTPS: https://xx 4. HLS: http://xx or https://xx Required permissions: ohos.permission.READ_MEDIA or ohos.permission.INTERNET
fdSrc⁹⁺	AVFileDescriptor	No	No	Description of the audio file. This property is required when audio assets of an application are continuously stored in a file. Example: Assume that a music file that stores continuous music assets consists of the following: Music 1 (address offset: 0, byte length: 100) Music 2 (address offset: 101; byte length: 50) Music 3 (address offset: 151, byte length: 150) 1. To play music 1: AVFileDescriptor { fd = resource handle; offset = 0; length = 100; } 2. To play music 2: AVFileDescriptor { fd = resource handle; offset = 101; length = 50; } 3. To play music 3: AVFileDescriptor { fd = resource handle; offset = 151; length = 150; } To play an independent music file, use src=fd://xx.
loop	boolean	No	No	Whether to loop audio playback. true to loop, false otherwise.
audioInterruptMode⁹⁺	audio.InterruptMode	No	Yes	Audio interruption mode.
currentTime	number	Yes	No	Current audio playback position, in ms.
duration	number	Yes	No	Audio duration, in ms.
state	AudioState	Yes	No	Audio playback state. This state cannot be used as the condition for triggering the call of play(), pause(), or stop().

play^(deprecated)

play(): void

Starts to play an audio asset. This API can be called only after the 'dataLoad' event is triggered.

NOTE This API is supported since API version 6 and deprecated since API version 9. You are advised to use AVPlayer.play instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Example

audioPlayer.on('play', () => {    // Set the 'play' event callback.
  console.info('audio play called');
});
audioPlayer.play();

pause^(deprecated)

pause(): void

Pauses audio playback.

NOTE This API is supported since API version 6 and deprecated since API version 9. You are advised to use AVPlayer.pause instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Example

audioPlayer.on('pause', () => {    // Set the 'pause' event callback.
  console.info('audio pause called');
});
audioPlayer.pause();

stop^(deprecated)

stop(): void

Stops audio playback.

NOTE This API is supported since API version 6 and deprecated since API version 9. You are advised to use AVPlayer.stop instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Example

audioPlayer.on('stop', () => {    // Set the 'stop' event callback.
  console.info('audio stop called');
});
audioPlayer.stop();

reset^(deprecated)

reset(): void

Resets the audio asset to be played.

NOTE This API is supported since API version 7 and deprecated since API version 9. You are advised to use AVPlayer.reset instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Example

audioPlayer.on('reset', () => {    // Set the 'reset' event callback.
  console.info('audio reset called');
});
audioPlayer.reset();

seek^(deprecated)

seek(timeMs: number): void

Seeks to the specified playback position.

NOTE This API is supported since API version 6 and deprecated since API version 9. You are advised to use AVPlayer.seek instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Name	Type	Mandatory	Description
timeMs	number	Yes	Position to seek to, in ms. The value range is [0, duration].

Example

audioPlayer.on('timeUpdate', (seekDoneTime: number) => {    // Set the 'timeUpdate' event callback.
  if (seekDoneTime == null) {
    console.error('Failed to seek');
    return;
  }
  console.info('Succeeded in seek. seekDoneTime: ' + seekDoneTime);
});
audioPlayer.seek(30000);    // Seek to 30000 ms.

setVolume^(deprecated)

setVolume(vol: number): void

Sets the volume.

NOTE This API is supported since API version 6 and deprecated since API version 9. You are advised to use AVPlayer.setVolume instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Name	Type	Mandatory	Description
vol	number	Yes	Relative volume. The value ranges from 0.00 to 1.00. The value 1.00 indicates the maximum volume (100%).

Example

audioPlayer.on('volumeChange', () => {    // Set the 'volumeChange' event callback.
  console.info('audio volumeChange called');
});
audioPlayer.setVolume(1);    // Set the volume to 100%.

release^(deprecated)

release(): void

Releases the audio playback resources.

NOTE This API is supported since API version 6 and deprecated since API version 9. You are advised to use AVPlayer.release instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Example

audioPlayer.release();
audioPlayer = undefined;

getTrackDescription^(deprecated)

getTrackDescription(callback: AsyncCallback<Array<MediaDescription>>): void

Obtains the audio track information. It can be called only after the 'dataLoad' event is triggered. This API uses an asynchronous callback to return the result.

NOTE This API is supported since API version 8 and deprecated since API version 9. You are advised to use AVPlayer.getTrackDescription instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Array<MediaDescription>>	Yes	Callback used to return the result. If the operation is successful, err is undefined and data is the MediaDescription array obtained; otherwise, err is an error object.

Example

import { BusinessError } from '@kit.BasicServicesKit';

audioPlayer.getTrackDescription((error: BusinessError, arrList: Array<media.MediaDescription>) => {
  if (arrList != null) {
    console.info('Succeeded in getting TrackDescription');
  } else {
    console.error(`Failed to get TrackDescription, error:${error}`);
  }
});

getTrackDescription^(deprecated)

getTrackDescription(): Promise<Array<MediaDescription>>

Obtains the audio track information. It can be called only after the 'dataLoad' event is triggered. This API uses a promise to return the result.

NOTE This API is supported since API version 8 and deprecated since API version 9. You are advised to use AVPlayer.getTrackDescription instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Return value

Type	Description
Promise<Array<MediaDescription>>	Promise used to return a MediaDescription array, which records the audio track information.

Example

import { BusinessError } from '@kit.BasicServicesKit';

audioPlayer.getTrackDescription().then((arrList: Array<media.MediaDescription>) => {
  console.info('Succeeded in getting TrackDescription');
}).catch((error: BusinessError) => {
  console.error(`Failed to get TrackDescription, error:${error}`);
});

on('bufferingUpdate')^(deprecated)

on(type: 'bufferingUpdate', callback: (infoType: BufferingInfoType, value: number) => void): void

Subscribes to the audio buffering update event. This API works only under online playback.

NOTE This API is supported since API version 8 and deprecated since API version 9. You are advised to use AVPlayer.on('bufferingUpdate') instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'bufferingUpdate' in this case.
callback	function	Yes	Callback invoked when the event is triggered. The value of BufferingInfoType is fixed at 0.

Example

audioPlayer.on('bufferingUpdate', (infoType: media.BufferingInfoType, value: number) => {
  console.info('audio bufferingInfo type: ' + infoType);
  console.info('audio bufferingInfo value: ' + value);
});

on('play'|'pause'|'stop'|'reset'|'dataLoad'|'finish'|'volumeChange')^(deprecated)

Subscribes to the audio playback events.

NOTE This API is supported since API version 6 and deprecated since API version 9. You are advised to use AVPlayer.on('stateChange') instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Type of the playback event to listen for. The following events are supported: play, pause, stop, reset, dataLoad, finish, and volumeChange. - 'play': triggered when the play() API is called and audio playback starts. - 'pause': triggered when the pause() API is called and audio playback is paused. - 'stop': triggered when the stop() API is called and audio playback stops. - 'reset': triggered when the reset() API is called and audio playback is reset. - 'dataLoad': triggered when the audio data is loaded, that is, when the src property is configured. - 'finish': triggered when the audio playback is finished. - 'volumeChange': triggered when the setVolume() API is called and the playback volume is changed.
callback	() => void	Yes	Callback invoked when the event is triggered.

Example

import { fileIo } from '@kit.CoreFileKit';
import { BusinessError } from '@kit.BasicServicesKit';

let audioPlayer: media.AudioPlayer = media.createAudioPlayer();  // Create an AudioPlayer instance.
audioPlayer.on('dataLoad', () => {            // Set the 'dataLoad' event callback, which is triggered when the src property is set successfully.
  console.info('audio set source called');
  audioPlayer.play();                       // Start the playback and trigger the 'play' event callback.
});
audioPlayer.on('play', () => {                // Set the 'play' event callback.
  console.info('audio play called');
  audioPlayer.seek(30000);                  // Call the seek() API and trigger the 'timeUpdate' event callback.
});
audioPlayer.on('pause', () => {               // Set the 'pause' event callback.
  console.info('audio pause called');
  audioPlayer.stop();                       // Stop the playback and trigger the 'stop' event callback.
});
audioPlayer.on('reset', () => {               // Set the 'reset' event callback.
  console.info('audio reset called');
  audioPlayer.release();                    // Release the AudioPlayer instance.
  audioPlayer = undefined;
});
audioPlayer.on('timeUpdate', (seekDoneTime: number) => {  // Set the 'timeUpdate' event callback.
  if (seekDoneTime == null) {
    console.error('Failed to seek');
    return;
  }
  console.info('Succeeded in seek, and seek time is ' + seekDoneTime);
  audioPlayer.setVolume(0.5);                // Set the volume to 50% and trigger the 'volumeChange' event callback.
});
audioPlayer.on('volumeChange', () => {         // Set the 'volumeChange' event callback.
  console.info('audio volumeChange called');
  audioPlayer.pause();                       // Pause the playback and trigger the 'pause' event callback.
});
audioPlayer.on('finish', () => {               // Set the 'finish' event callback.
  console.info('audio play finish');
  audioPlayer.stop();                        // Stop the playback and trigger the 'stop' event callback.
});
audioPlayer.on('error', (error: BusinessError) => {  // Set the 'error' event callback.
  console.error(`audio error called, error: ${error}`);
});

// Set the FD (local playback) of the audio file selected by the user.
let fdPath = '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.
let path = '/data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp3';
fileIo.open(path).then((file) => {
  fdPath = fdPath + '' + file.fd;
  console.info('Succeeded in opening fd, fd is' + fdPath);
  audioPlayer.src = fdPath;  // Set the src property and trigger the 'dataLoad' event callback.
}, (err: BusinessError) => {
  console.error('Failed to open fd, err is' + err);
}).catch((err: BusinessError) => {
  console.error('Failed to open fd, err is' + err);
});

on('timeUpdate')^(deprecated)

on(type: 'timeUpdate', callback: Callback<number>): void

Subscribes to the 'timeUpdate' event. This event is reported every second when the audio playback is in progress.

NOTE This API is supported since API version 6 and deprecated since API version 9. You are advised to use AVPlayer.on('timeUpdate') instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'timeUpdate' in this case. The 'timeUpdate' event is triggered when the audio playback starts after an audio playback timestamp update.
callback	Callback<number>	Yes	Callback invoked when the event is triggered. The input parameter is the updated timestamp.

Example

audioPlayer.on('timeUpdate', (newTime: number) => {    // Set the 'timeUpdate' event callback.
  if (newTime == null) {
    console.error('Failed to do timeUpdate');
    return;
  }
  console.info('Succeeded in doing timeUpdate. seekDoneTime: ' + newTime);
});
audioPlayer.play();    // The 'timeUpdate' event is triggered when the playback starts.

on('audioInterrupt')^(deprecated)

on(type: 'audioInterrupt', callback: (info: audio.InterruptEvent) => void): void

Subscribes to the audio interruption event. For details, see audio.InterruptEvent.

NOTE This API is supported since API version 9 and deprecated since API version 9. You are advised to use AVPlayer.on('audioInterrupt') instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'audioInterrupt' in this case.
callback	function	Yes	Callback invoked when the event is triggered.

Example

import { audio } from '@kit.AudioKit';

audioPlayer.on('audioInterrupt', (info: audio.InterruptEvent) => {
  console.info('audioInterrupt called,and InterruptEvent info is:' + info);
});

on('error')^(deprecated)

on(type: 'error', callback: ErrorCallback): void

Subscribes to audio playback error events. After an error event is reported, you must handle the event and exit the playback.

NOTE This API is supported since API version 6 and deprecated since API version 9. You are advised to use AVPlayer.on('error') instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'error' in this case. This event is triggered when an error occurs during audio playback.
callback	ErrorCallback	Yes	Callback invoked when the event is triggered.

Example

import { BusinessError } from '@kit.BasicServicesKit';

audioPlayer.on('error', (error: BusinessError) => {  // Set the 'error' event callback.
  console.error(`audio error called, error: ${error}`);
});
audioPlayer.setVolume(3);  // Set volume to an invalid value to trigger the 'error' event.

你可能感兴趣的鸿蒙文章

openharmony 鸿蒙 capi-avrecorder-oh-avrecorder-range

openharmony 鸿蒙 errorcode-media

openharmony 鸿蒙 capi-avplayer

openharmony 鸿蒙 capi-avplayer-base-h

openharmony 鸿蒙 capi-avimage-generator-h

openharmony 鸿蒙 capi-avscreencapture-oh-rect

openharmony 鸿蒙 capi-videoprocessing-videoprocessing-callback

openharmony 鸿蒙 capi-avsinkbase

openharmony 鸿蒙 capi-avmetadataextractor

openharmony 鸿蒙 capi-avscreencapture-oh-multidisplaycapability

openharmony 鸿蒙 arkts-apis-media-AudioPlayer

Deprecated Interface (AudioPlayer, deprecated)

Modules to Import

Properties^(deprecated)

play^(deprecated)

pause^(deprecated)

stop^(deprecated)

reset^(deprecated)

seek^(deprecated)

setVolume^(deprecated)

release^(deprecated)

getTrackDescription^(deprecated)

getTrackDescription^(deprecated)

on('bufferingUpdate')^(deprecated)

on('play'|'pause'|'stop'|'reset'|'dataLoad'|'finish'|'volumeChange')^(deprecated)

on('timeUpdate')^(deprecated)

on('audioInterrupt')^(deprecated)

on('error')^(deprecated)

你可能感兴趣的鸿蒙文章

标签云

最热博客

最新博客

Deprecated Interface (AudioPlayer, deprecated)

Modules to Import

Properties(deprecated)

play(deprecated)

pause(deprecated)

stop(deprecated)

reset(deprecated)

seek(deprecated)

setVolume(deprecated)

release(deprecated)

getTrackDescription(deprecated)

getTrackDescription(deprecated)

on('bufferingUpdate')(deprecated)

on('play'|'pause'|'stop'|'reset'|'dataLoad'|'finish'|'volumeChange')(deprecated)

on('timeUpdate')(deprecated)

on('audioInterrupt')(deprecated)

on('error')(deprecated)

你可能感兴趣的鸿蒙文章

标签云

最热博客

最新博客

Properties^(deprecated)

play^(deprecated)

pause^(deprecated)

stop^(deprecated)

reset^(deprecated)

seek^(deprecated)

setVolume^(deprecated)

release^(deprecated)

getTrackDescription^(deprecated)

getTrackDescription^(deprecated)

on('bufferingUpdate')^(deprecated)

on('play'|'pause'|'stop'|'reset'|'dataLoad'|'finish'|'volumeChange')^(deprecated)

on('timeUpdate')^(deprecated)

on('audioInterrupt')^(deprecated)

on('error')^(deprecated)