Media

NOTE

The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.

The multimedia subsystem provides a set of simple and easy-to-use APIs for you to access the system and use media resources.

This subsystem offers various media services covering audio and video, which provide the following capabilities:

• Audio playback (AudioPlayer)
• Video playback (VideoPlayer)
• Audio recording (AudioRecorder)

The following capabilities will be provided in later versions: data source audio/video playback, audio/video encoding and decoding, container encapsulation and decapsulation, and media capability query.

Modules to Import

import media from '@ohos.multimedia.media';

media.createAudioPlayer

createAudioPlayer(): AudioPlayer

Creates an AudioPlayer instance in synchronous mode.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Return value

Example

let audioPlayer = media.createAudioPlayer();

media.createVideoPlayer⁸⁺

createVideoPlayer(callback: AsyncCallback<VideoPlayer>): void

Creates a VideoPlayer instance in asynchronous mode. This API uses a callback to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

let videoPlayer

media.createVideoPlayer((error, video) => {
   if (video != null) {
       videoPlayer = video;
       console.info('video createVideoPlayer success');
   } else {
       console.info(`video createVideoPlayer fail, error:${error.message}`);
   }
});

media.createVideoPlayer⁸⁺

createVideoPlayer(): Promise<VideoPlayer>

Creates a VideoPlayer instance in asynchronous mode. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Return value

Example

let videoPlayer

media.createVideoPlayer().then((video) => {
   if (video != null) {
       videoPlayer = video;
       console.info('video createVideoPlayer success');
   } else {
       console.info('video createVideoPlayer fail');
   }
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});

media.createAudioRecorder

createAudioRecorder(): AudioRecorder

Creates an AudioRecorder instance to control audio recording. Only one AudioRecorder instance can be created per device.

System capability: SystemCapability.Multimedia.Media.AudioRecorder

Return value

Example

let audioRecorder = media.createAudioRecorder();

MediaErrorCode⁸⁺

Enumerates the media error codes.

System capability: SystemCapability.Multimedia.Media.Core

MediaType⁸⁺

Enumerates the media types.

System capability: SystemCapability.Multimedia.Media.Core

CodecMimeType⁸⁺

Enumerates the codec MIME types.

System capability: SystemCapability.Multimedia.Media.Core

MediaDescriptionKey⁸⁺

Enumerates the media description keys.

System capability: SystemCapability.Multimedia.Media.Core

BufferingInfoType⁸⁺

Enumerates the buffering event types.

System capability: SystemCapability.Multimedia.Media.Core

AudioPlayer

Provides APIs to manage and play audio. Before calling an API of AudioPlayer, you must use createAudioPlayer() to create an AudioPlayer instance.

For details about the audio playback demo, see Audio Playback Development.

Attributes

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Name	Type	Readable	Writable	Description
src	string	Yes	Yes	Audio file URI. The mainstream audio formats (MPEG-4, MPEG-TS, WebM, and MKV) are supported. Examples of supported URI schemes: 1. FD: fd://xx 2. HTTP: http://xx 3. HTTPS: https://xx 4. HLS: http://xx or https://xx NOTE To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly.
loop	boolean	Yes	Yes	Whether to loop audio playback. The value true means to loop audio playback, and false means the opposite.
currentTime	number	Yes	No	Current audio playback position.
duration	number	Yes	No	Audio duration.
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

play(): void

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

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Example

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

pause

pause(): void

Pauses audio playback.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Example

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

stop

stop(): void

Stops audio playback.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Example

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

reset⁷⁺

reset(): void

Switches the audio resource to be played.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Example

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

seek

seek(timeMs: number): void

Seeks to the specified playback position.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Example

audioPlayer.on('timeUpdate', (seekDoneTime) => {    // Set the 'timeUpdate' event callback.
    if (seekDoneTime == null) {
        console.info('audio seek fail');
        return;
    }
    console.log('audio seek success. seekDoneTime: ' + seekDoneTime);
});
audioPlayer.seek(30000); // Seek to 30000 ms.

setVolume

setVolume(vol: number): void

Sets the volume.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Example

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

release

release(): void

Releases the audio playback resource.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Example

audioPlayer.release();
audioPlayer = undefined;

getTrackDescription⁸⁺

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

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

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Example

function printfDescription(obj) {
    for (let item in obj) {
        let property = obj[item];
        console.info('audio key is ' + item);
        console.info('audio value is ' + property);
    }
}

audioPlayer.getTrackDescription((error, arrlist) => {
    if (arrlist != null) {
        for (let i = 0; i < arrlist.length; i++) {
            printfDescription(arrlist[i]);
        }
    } else {
        console.log(`audio getTrackDescription fail, error:${error.message}`);
    }
});

getTrackDescription⁸⁺

getTrackDescription(): Promise<Array<MediaDescription>>

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

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Return value

Example

function printfDescription(obj) {
    for (let item in obj) {
        let property = obj[item];
        console.info('audio key is ' + item);
        console.info('audio value is ' + property);
    }
}

audioPlayer.getTrackDescription().then((arrlist) => {
    if (arrlist != null) {
        arrayDescription = arrlist;
    } else {
        console.log('audio getTrackDescription fail');
    }
}).catch((error) => {
   console.info(`audio catchCallback, error:${error.message}`);
});

for (let i = 0; i < arrayDescription.length; i++) {
    printfDescription(arrayDescription[i]);
}

on('bufferingUpdate')⁸⁺

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

Subscribes to the audio buffering update event.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Example

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

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

on(type: 'play' | 'pause' | 'stop' | 'reset' | 'dataLoad' | 'finish' | 'volumeChange', callback: () => void): void

Subscribes to the audio playback events.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Example

let audioPlayer = media.createAudioPlayer();  // Create an AudioPlayer instance.
audioPlayer.on('dataLoad', () => {            // Set the 'dataLoad' event callback, which is triggered when the src attribute is set successfully.
    console.info('audio set source success');
    audioPlayer.play();                       // Start the playback and trigger the 'play' event callback.
});
audioPlayer.on('play', () => {                // Set the 'play' event callback.
    console.info('audio play success');
    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 success');
    audioPlayer.stop();                       // Stop the playback and trigger the 'stop' event callback.
});
audioPlayer.on('reset', () => {               // Set the 'reset' event callback.
    console.info('audio reset success');
    audioPlayer.release();                    // Release the AudioPlayer instance.
    audioPlayer = undefined;
});
audioPlayer.on('timeUpdate', (seekDoneTime) => {  // Set the 'timeUpdate' event callback.
    if (seekDoneTime == null) {
        console.info('audio seek fail');
        return;
    }
    console.info('audio seek success, 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 success');
    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) => {           // 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}`);
});

// Set the FD (local playback) of the video 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(fdNumber) => {
   fdPath = fdPath + '' + fdNumber;
   console.info('open fd success fd is' + fdPath);
}, (err) => {
   console.info('open fd failed err is' + err);
}).catch((err) => {
   console.info('open fd failed err is' + err);
});
audioPlayer.src = fdPath;  // Set the src attribute and trigger the 'dataLoad' event callback.

on('timeUpdate')

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

Subscribes to the 'timeUpdate' event.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Example

audioPlayer.on('timeUpdate', (seekDoneTime) => {    // Set the 'timeUpdate' event callback.
    if (seekDoneTime == null) {
        console.info('audio seek fail');
        return;
    }
    console.log('audio seek success. seekDoneTime: ' + seekDoneTime);
});
audioPlayer.seek(30000); // Seek to 30000 ms.

on('error')

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

Subscribes to audio playback error events.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Parameters

Example

audioPlayer.on('error', (error) => {      // Set the error event callback.
    console.info(`audio error called, errName is ${error.name}`);      // Print the error name.
    console.info(`audio error called, errCode is ${error.code}`);      // Print the error code.
    console.info(`audio error called, errMessage is ${error.message}`);// Print the detailed description of the error type.
});
audioPlayer.setVolume(3); // Set volume to an invalid value to trigger the 'error' event.

AudioState

Enumerates the audio playback states. You can obtain the state through the state attribute.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

VideoPlayer⁸⁺

Provides APIs to manage and play video. Before calling an API of VideoPlayer, you must call createVideoPlayer() to create a VideoPlayer instance.

For details about the video playback demo, see Video Playback Development.

Attributes

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Name	Type	Readable	Writable	Description
url8+	string	Yes	Yes	Video media URL. The mainstream video formats (MPEG-4, MPEG-TS, WebM, and MKV) are supported. Example of supported URIs: 1. FD: fd://xx 2. HTTP: http://xx 3. HTTPS: https://xx 4. HLS: http://xx or https://xx NOTE To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly.
loop8+	boolean	Yes	Yes	Whether to loop video playback. The value true means to loop video playback, and false means the opposite.
currentTime8+	number	Yes	No	Current video playback position.
duration8+	number	Yes	No	Video duration. The value -1 indicates the live mode.
state8+	VideoPlayState	Yes	No	Video playback state.
width8+	number	Yes	No	Video width.
height8+	number	Yes	No	Video height.

setDisplaySurface⁸⁺

setDisplaySurface(surfaceId: string, callback: AsyncCallback<void>): void

Sets SurfaceId. This API uses a callback to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.setDisplaySurface(surfaceId, (err) => {
    if (err == null) {
        console.info('setDisplaySurface success!');
    } else {
        console.info('setDisplaySurface fail!');
    }
});

setDisplaySurface⁸⁺

setDisplaySurface(surfaceId: string): Promise<void>

Sets SurfaceId. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Return value

Example

videoPlayer.setDisplaySurface(surfaceId).then(() => {
    console.info('setDisplaySurface success');
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});

prepare⁸⁺

prepare(callback: AsyncCallback<void>): void

Prepares for video playback. This API uses a callback to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.prepare((err) => {
    if (err == null) {
        console.info('prepare success!');
    } else {
        console.info('prepare fail!');
    }
});

prepare⁸⁺

prepare(): Promise<void>

Prepares for video playback. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Return value

Example

videoPlayer.prepare().then(() => {
    console.info('prepare success');
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});

play⁸⁺

play(callback: AsyncCallback<void>): void;

Starts to play video resources. This API uses a callback to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.play((err) => {
    if (err == null) {
        console.info('play success!');
    } else {
        console.info('play fail!');
    }
});

play⁸⁺

play(): Promise<void>;

Starts to play video resources. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Return value

Example

videoPlayer.play().then(() => {
    console.info('play success');
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});

pause⁸⁺

pause(callback: AsyncCallback<void>): void

Pauses video playback. This API uses a callback to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.pause((err) => {
    if (err == null) {
        console.info('pause success!');
    } else {
        console.info('pause fail!');
    }
});

pause⁸⁺

pause(): Promise<void>

Pauses video playback. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Return value

Example

videoPlayer.pause().then(() => {
    console.info('pause success');
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});

stop⁸⁺

stop(callback: AsyncCallback<void>): void

Stops video playback. This API uses a callback to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.stop((err) => {
    if (err == null) {
        console.info('stop success!');
    } else {
        console.info('stop fail!');
    }
});

stop⁸⁺

stop(): Promise<void>

Stops video playback. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Return value

Example

videoPlayer.stop().then(() => {
    console.info('stop success');
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});

reset⁸⁺

reset(callback: AsyncCallback<void>): void

Switches the video resource to be played. This API uses a callback to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.reset((err) => {
    if (err == null) {
        console.info('reset success!');
    } else {
        console.info('reset fail!');
    }
});

reset⁸⁺

reset(): Promise<void>

Switches the video resource to be played. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Return value

Example

videoPlayer.reset().then(() => {
    console.info('reset success');
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});

seek⁸⁺

seek(timeMs: number, callback: AsyncCallback<number>): void

Seeks to the specified playback position. The next key frame at the specified position is played. This API uses a callback to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.seek((seekTime, err) => {
    if (err == null) {
        console.info('seek success!');
    } else {
        console.info('seek fail!');
    }
});

seek⁸⁺

seek(timeMs: number, mode:SeekMode, callback: AsyncCallback<number>): void

Seeks to the specified playback position. This API uses a callback to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.seek((seekTime, seekMode, err) => {
    if (err == null) {
        console.info('seek success!');
    } else {
        console.info('seek fail!');
    }
});

seek⁸⁺

seek(timeMs: number, mode?:SeekMode): Promise<number>

Seeks to the specified playback position. If mode is not specified, the next key frame at the specified position is played. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Return value

Example

videoPlayer.seek(seekTime).then((seekDoneTime) => { // seekDoneTime indicates the position after the seek operation is complete.
    console.info('seek success');
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});

videoPlayer.seek(seekTime, seekMode).then((seekDoneTime) => {
    console.info('seek success');
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});

setVolume⁸⁺

setVolume(vol: number, callback: AsyncCallback<void>): void

Sets the volume. This API uses a callback to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.setVolume((vol, err) => {
    if (err == null) {
        console.info('setVolume success!');
    } else {
        console.info('setVolume fail!');
    }
});

setVolume⁸⁺

setVolume(vol: number): Promise<void>

Sets the volume. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Return value

Example

videoPlayer.setVolume(vol).then() => {
    console.info('setVolume success');
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});

release⁸⁺

release(callback: AsyncCallback<void>): void

Releases the video playback resource. This API uses a callback to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.release((err) => {
    if (err == null) {
        console.info('release success!');
    } else {
        console.info('release fail!');
    }
});

release⁸⁺

release(): Promise<void>

Releases the video playback resource. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Return value

Example

videoPlayer.release().then() => {
    console.info('release success');
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});

getTrackDescription⁸⁺

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

Obtains the video track information. This API uses a callback to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

function printfDescription(obj) {
    for (let item in obj) {
        let property = obj[item];
        console.info('video key is ' + item);
        console.info('video value is ' + property);
    }
}

videoPlayer.getTrackDescription((error, arrlist) => {
    if (arrlist != null) {
        for (let i = 0; i < arrlist.length; i++) {
            printfDescription(arrlist[i]);
        }
    } else {
        console.log(`video getTrackDescription fail, error:${error.message}`);
    }
});

getTrackDescription⁸⁺

getTrackDescription(): Promise<Array<MediaDescription>>

Obtains the video track information. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Return value

Example

function printfDescription(obj) {
    for (let item in obj) {
        let property = obj[item];
        console.info('video key is ' + item);
        console.info('video value is ' + property);
    }
}

let arrayDescription;
videoPlayer.getTrackDescription().then((arrlist) => {
    if (arrlist != null) {
        arrayDescription = arrlist;
    } else {
        console.log('video getTrackDescription fail');
    }
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});
for (let i = 0; i < arrayDescription.length; i++) {
    printfDescription(arrayDescription[i]);
}

setSpeed⁸⁺

setSpeed(speed:number, callback: AsyncCallback<number>): void

Sets the video playback speed. This API uses a callback to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.setSpeed((speed:number, err) => {
    if (err == null) {
        console.info('setSpeed success!');
    } else {
        console.info('setSpeed fail!');
    }
});

setSpeed⁸⁺

setSpeed(speed:number): Promise<number>

Sets the video playback speed. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Return value

Example

videoPlayer.setSpeed(speed).then() => {
    console.info('setSpeed success');
}).catch((error) => {
   console.info(`video catchCallback, error:${error.message}`);
});

on('playbackCompleted')⁸⁺

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

Subscribes to the video playback completion event.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.on('playbackCompleted', () => {
    console.info('playbackCompleted success!');
});

on('bufferingUpdate')⁸⁺

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

Subscribes to the video buffering update event.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.on('bufferingUpdate', (infoType, value) => {
    console.log('video bufferingInfo type: ' + infoType);
    console.log('video bufferingInfo value: ' + value);
});

on('startRenderFrame')⁸⁺

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

Subscribes to the frame rendering start event.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.on('startRenderFrame', () => {
    console.info('startRenderFrame success!');
});

on('videoSizeChanged')⁸⁺

on(type: 'videoSizeChanged', callback: (width: number, height: number) => void): void

Subscribes to the video width and height change event.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.on('videoSizeChanged', (width, height) => {
    console.log('video width is: ' + width);
    console.log('video height is: ' + height);
});

on('error')⁸⁺

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

Subscribes to video playback error events.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

videoPlayer.on('error', (error) => {      // Set the 'error' event callback.
    console.info(`video error called, errName is ${error.name}`);      // Print the error name.
    console.info(`video error called, errCode is ${error.code}`);      // Print the error code.
    console.info(`video error called, errMessage is ${error.message}`);// Print the detailed description of the error type.
});
videoPlayer.setVolume(3);  //  Set volume to an invalid value to trigger the 'error' event.

VideoPlayState⁸⁺

Enumerates the video playback states. You can obtain the state through the state attribute.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

SeekMode⁸⁺

Enumerates the video playback seek modes, which can be passed in the seek API.

System capability: SystemCapability.Multimedia.Media.Core

PlaybackSpeed⁸⁺

Enumerates the video playback speeds, which can be passed in the setSpeed API.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

MediaDescription⁸⁺

[key : string] : Object

Defines media information in key-value mode.

System capability: SystemCapability.Multimedia.Media.Core

Example

function printfItemDescription(obj, key) {
    let property = obj[key];
    console.info('audio key is ' + key);
    console.info('audio value is ' + property);
}

audioPlayer.getTrackDescription((error, arrlist) => {
    if (arrlist != null) {
        for (let i = 0; i < arrlist.length; i++) {
            printfItemDescription(arrlist[i], MD_KEY_TRACK_TYPE);  // Print the MD_KEY_TRACK_TYPE value of each track.
        }
    } else {
        console.log(`audio getTrackDescription fail, error:${error.message}`);
    }
});

AudioRecorder

Implements audio recording. Before calling an API of AudioRecorder, you must call createAudioRecorder() to create an AudioRecorder instance.

For details about the audio recording demo, see Audio Recording Development.

prepare

prepare(config: AudioRecorderConfig): void

Prepares for recording.

Required permissions: ohos.permission.MICROPHONE

System capability: SystemCapability.Multimedia.Media.AudioRecorder

Parameters

Example

let audioRecorderConfig = {
    audioEncoder : media.AudioEncoder.AAC_LC,
    audioEncodeBitRate : 22050,
    audioSampleRate : 22050,
    numberOfChannels : 2,
    format : media.AudioOutputFormat.AAC_ADTS,
    uri : 'fd://1',       // The file must be created by the caller and granted with proper permissions.
    location : { latitude : 30, longitude : 130},
}
audioRecorder.on('prepare', () => {    // Set the 'prepare' event callback.
    console.log('prepare success');
});
audioRecorder.prepare(audioRecorderConfig);

start

start(): void

Starts audio recording. This API can be called only after the prepare event is triggered.

System capability: SystemCapability.Multimedia.Media.AudioRecorder

Example

audioRecorder.on('start', () => {    // Set the 'start' event callback.
    console.log('audio recorder start success');
});
audioRecorder.start();

pause

pause():void

Pauses audio recording. This API can be called only after the start event is triggered.

System capability: SystemCapability.Multimedia.Media.AudioRecorder

Example

audioRecorder.on('pause', () => {    // Set the 'pause' event callback.
    console.log('audio recorder pause success');
});
audioRecorder.pause();

resume

resume():void

Resumes audio recording. This API can be called only after the pause event is triggered.

System capability: SystemCapability.Multimedia.Media.AudioRecorder

Example

audioRecorder.on('resume', () => { // Set the 'resume' event callback.
    console.log('audio recorder resume success');
});
audioRecorder.resume();

stop

stop(): void

Stops audio recording.

System capability: SystemCapability.Multimedia.Media.AudioRecorder

Example

audioRecorder.on('stop', () => {    // Set the 'stop' event callback.
    console.log('audio recorder stop success');
});
audioRecorder.stop();

release

release(): void

Releases the audio recording resource.

System capability: SystemCapability.Multimedia.Media.AudioRecorder

Example

audioRecorder.on('release', () => {    // Set the 'release' event callback.
    console.log('audio recorder release success');
});
audioRecorder.release();
audioRecorder = undefined;

reset

reset(): void

Resets audio recording.

Before resetting audio recording, you must call stop() to stop recording. After audio recording is reset, you must call prepare() to set the recording parameters for another recording.

System capability: SystemCapability.Multimedia.Media.AudioRecorder

Example

audioRecorder.on('reset', () => {    // Set the 'reset' event callback.
    console.log('audio recorder reset success');
});
audioRecorder.reset();

on('prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset')

on(type: 'prepare' | 'start' | 'pause' | 'resume' | 'stop' | 'release' | 'reset', callback: () => void): void

Subscribes to the audio recording events.

System capability: SystemCapability.Multimedia.Media.AudioRecorder

Parameters

Example

let audiorecorder = media.createAudioRecorder();                                  // Create an AudioRecorder instance.
let audioRecorderConfig = {
    audioEncoder : media.AudioEncoder.AAC_LC, ,
    audioEncodeBitRate : 22050,
    audioSampleRate : 22050,
    numberOfChannels : 2,
    format : media.AudioOutputFormat.AAC_ADTS,
    uri : 'fd://xx',                                                            // The file must be created by the caller and granted with proper permissions.
    location : { latitude : 30, longitude : 130},
}
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}`);
});
audioRecorder.on('prepare', () => {                                              // Set the 'prepare' event callback.
    console.log('prepare success');
    audioRecorder.start();                                                       // Start recording and trigger the 'start' event callback.
});
audioRecorder.on('start', () => {                                                 // Set the 'start' event callback.
    console.log('audio recorder start success');
});
audioRecorder.on('pause', () => {                                                 // Set the 'pause' event callback.
    console.log('audio recorder pause success');
});
audioRecorder.on('resume', () => {                                                 // Set the 'resume' event callback.
    console.log('audio recorder resume success');
});
audioRecorder.on('stop', () => {                                                 // Set the 'stop' event callback.
    console.log('audio recorder stop success');
});
audioRecorder.on('release', () => {                                                 // Set the 'release' event callback.
    console.log('audio recorder release success');
});
audioRecorder.on('reset', () => {                                                 // Set the 'reset' event callback.
    console.log('audio recorder reset success');
});
audioRecorder.prepare(audioRecorderConfig)                                       // Set recording parameters and trigger the 'prepare' event callback.

on('error')

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

Subscribes to audio recording error events.

System capability: SystemCapability.Multimedia.Media.AudioRecorder

Parameters

Example

audioRecorder.on('error', (error) => {                                  // Set the 'error' event callback.
    console.info(`audio error called, errName is ${error.name}`);       // Print the error name.
    console.info(`audio error called, errCode is ${error.code}`);       // Print the error code.
    console.info(`audio error called, errMessage is ${error.message}`); // Print the detailed description of the error type.
});
audioRecorder.prepare();                                                  // Do no set any parameter in prepare and trigger the 'error' event callback.

AudioRecorderConfig

Describes audio recording configurations.

System capability: SystemCapability.Multimedia.Media.AudioRecorder

Name	Type	Mandatory	Description
audioEncoder(deprecated)	AudioEncoder	No	Audio encoding format. The default value is AAC_LC. Note: This parameter is deprecated since API version 8. Use audioEncoderMime instead.
audioEncodeBitRate	number	No	Audio encoding bit rate. The default value is 48000.
audioSampleRate	number	No	Audio sampling rate. The default value is 48000.
numberOfChannels	number	No	Number of audio channels. The default value is 2.
format(deprecated)	AudioOutputFormat	No	Audio output format. The default value is MPEG_4. Note: This parameter is deprecated since API version 8. Use fileFormat instead.
location	Location	No	Geographical location of the recorded audio.
uri	string	Yes	Audio output URI. Supported: fd://xx (fd number) The file must be created by the caller and granted with proper permissions.
audioEncoderMime8+	CodecMimeType	No	Audio encoding format.
fileFormat8+	ContainerFormatType	No	Audio encoding format.

AudioEncoder^(deprecated)

NOTE This API is deprecated since API version 8. You are advised to use CodecMimeType instead.

Enumerates the audio encoding formats.

System capability: SystemCapability.Multimedia.Media.AudioRecorder

AudioOutputFormat^(deprecated)

NOTE This API is deprecated since API version 8. You are advised to use ContainerFormatType instead.

Enumerates the audio output formats.

System capability: SystemCapability.Multimedia.Media.AudioRecorder

ContainerFormatType⁸⁺

Enumerates the container format types (CFTs).

System capability: SystemCapability.Multimedia.Media.Core

Location

Describes the geographical location of the recorded video.

System capability: SystemCapability.Multimedia.Media.Core