@ohos.multimedia.media (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 the following audio and video services:

• Audio and video playback (AVPlayer⁹⁺)

• Audio and video recording AVRecorder⁹⁺)

• Obtaining audio and video metadata (AVMetadataExtractor¹¹⁺).

Modules to Import

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

media.createAVPlayer⁹⁺

createAVPlayer(callback: AsyncCallback<AVPlayer>): void

Creates an AVPlayer instance. This API uses an asynchronous callback to return the result.

NOTE

• A maximum of 13 instances can be created in video-only playback scenarios.
• A maximum of 16 instances can be created in both audio and video playback scenarios.
• The actual number of instances that can be created may be different. It depends on the specifications of the device chip in use. For example, in the case of RK3568, a maximum of 6 instances can be created in video-only playback scenarios.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

let avPlayer: media.AVPlayer;
media.createAVPlayer((error: BusinessError, video: media.AVPlayer) => {
  if (video != null) {
    avPlayer = video;
    console.info('createAVPlayer success');
  } else {
    console.error(`createAVPlayer fail, error message:${error.message}`);
  }
});

media.createAVPlayer⁹⁺

createAVPlayer(): Promise<AVPlayer>

Creates an AVPlayer instance. This API uses a promise to return the result.

NOTE

• A maximum of 13 instances can be created in video-only playback scenarios.
• A maximum of 16 instances can be created in both audio and video playback scenarios.
• The actual number of instances that can be created may be different. It depends on the specifications of the device chip in use. For example, in the case of RK3568, a maximum of 6 instances can be created in video-only playback scenarios.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

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

media.createAVRecorder⁹⁺

createAVRecorder(callback: AsyncCallback<AVRecorder>): void

Creates an AVRecorder instance. This API uses an asynchronous callback to return the result.

NOTE

• A maximum of 2 instances can be created in audio and video recording scenarios.
• Only one instance can perform audio recording on a device at one time, since all the applications share the audio channel. Any attempt to create the second instance for audio recording fails due to audio channel conflicts.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';
let avRecorder: media.AVRecorder;

media.createAVRecorder((error: BusinessError, recorder: media.AVRecorder) => {
  if (recorder != null) {
    avRecorder = recorder;
    console.info('createAVRecorder success');
  } else {
    console.error(`createAVRecorder fail, error message:${error.message}`);
  }
});

media.createAVRecorder⁹⁺

createAVRecorder(): Promise<AVRecorder>

Creates an AVRecorder instance. This API uses a promise to return the result.

NOTE

• A maximum of 2 instances can be created in audio and video recording scenarios.
• Only one instance can perform audio recording on a device at one time, since all the applications share the audio channel. Any attempt to create the second instance for audio recording fails due to audio channel conflicts.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

let avRecorder: media.AVRecorder;
media.createAVRecorder().then((recorder: media.AVRecorder) => {
  if (recorder != null) {
    avRecorder = recorder;
    console.info('createAVRecorder success');
  } else {
    console.error('createAVRecorder fail');
  }
}).catch((error: BusinessError) => {
  console.error(`createAVRecorder catchCallback, error message:${error.message}`);
});

media.createAVMetadataExtractor¹¹⁺

createAVMetadataExtractor(callback: AsyncCallback<AVMetadataExtractor>): void

Creates an AVMetadataExtractor instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

let avMetadataExtractor: media.AVMetadataExtractor;
media.createAVMetadataExtractor((error: BusinessError, extractor: media.AVMetadataExtractor) => {
  if (extractor != null) {
    avMetadataExtractor = extractor;
    console.info('createAVMetadataExtractor success');
  } else {
    console.error(`createAVMetadataExtractor fail, error message:${error.message}`);
  }
});

media.createAVMetadataExtractor¹¹⁺

createAVMetadataExtractor(): Promise<AVMetadataExtractor>

Creates an AVMetadataExtractor instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

let avMetadataExtractor: media.AVMetadataExtractor;
media.createAVMetadataExtractor().then((extractor: media.AVMetadataExtractor) => {
  if (extractor != null) {
    avMetadataExtractor = extractor;
    console.info('createAVMetadataExtractor success');
  } else {
    console.error('createAVMetadataExtractor fail');
  }
}).catch((error: BusinessError) => {
  console.error(`AVMetadataExtractor catchCallback, error message:${error.message}`);
});

media.createSoundPool¹⁰⁺

createSoundPool(maxStreams: number, audioRenderInfo: audio.AudioRendererInfo, callback: AsyncCallback<SoundPool>): void

Creates a SoundPool instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import audio from '@ohos.multimedia.audio'

let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage : audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags : 0
}

media.createSoundPool(5, audioRendererInfo, (error, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
  }
});

media.createSoundPool¹⁰⁺

createSoundPool(maxStreams: number, audioRenderInfo: audio.AudioRendererInfo): Promise<SoundPool>

Creates a SoundPool instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import audio from '@ohos.multimedia.audio'
import { BusinessError } from '@ohos.base';

let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage : audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags : 0
}

media.createSoundPool(5, audioRendererInfo).then((soundpool_: media.SoundPool) => {
  if (soundpool_ != null) {
    soundPool = soundpool_;
    console.info('create SoundPool success');
  } else {
    console.error('create SoundPool fail');
  }
}, (error: BusinessError) => {
  console.error(`soundpool catchCallback, error message:${error.message}`);
});

AVErrorCode⁹⁺

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

StateChangeReason⁹⁺

Enumerates the reasons for the state transition of the AVPlayer or AVRecorder instance. The enum value is reported together with state.

System capability: SystemCapability.Multimedia.Media.Core

AVPlayer⁹⁺

A playback management class that provides APIs to manage and play media assets. Before calling any API in AVPlayer, you must use createAVPlayer() to create an AVPlayer instance.

For details about the audio and video playback demo, see Audio Playback and Video Playback.

Attributes

System capability: SystemCapability.Multimedia.Media.AVPlayer

Name	Type	Readable	Writable	Description
url9+	string	Yes	Yes	URL of the media asset. It can be set only when the AVPlayer is in the idle state. The video formats MP4, MPEG-TS, and MKV are supported. The audio formats M4A, AAC, MP3, OGG, WAV, and FLAC 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 NOTE WebM is no longer supported since API version 11.
fdSrc9+	AVFileDescriptor	Yes	Yes	FD of the media asset. It can be set only when the AVPlayer is in the idle state. This attribute is required when media assets of an application are continuously stored in a file. The video formats MP4, MPEG-TS, and MKV are supported. The audio formats M4A, AAC, MP3, OGG, WAV, and FLAC are supported. Example: Assume that a media file that stores continuous assets consists of the following: Video 1 (address offset: 0, byte length: 100) Video 2 (address offset: 101; byte length: 50) Video 3 (address offset: 151, byte length: 150) 1. To play video 1: AVFileDescriptor {fd = resource handle; offset = 0; length = 100; } 2. To play video 2: AVFileDescriptor {fd = resource handle; offset = 101; length = 50; } 3. To play video 3: AVFileDescriptor {fd = resource handle; offset = 151; length = 150; } To play an independent media file, use src=fd://xx. NOTE WebM is no longer supported since API version 11.
dataSrc10+	AVDataSrcDescriptor	Yes	Yes	Descriptor of a streaming media asset. It can be set only when the AVPlayer is in the idle state. Use scenario: An application starts playing a media file while the file is still being downloaded from the remote to the local host. The video formats MP4, MPEG-TS, and MKV are supported. The audio formats M4A, AAC, MP3, OGG, WAV, and FLAC are supported. Example: A user is obtaining an audio and video file from a remote server and wants to play the downloaded file content. To implement this scenario, do as follows: 1. Obtain the total file size, in bytes. If the total size cannot be obtained, set fileSize to -1. 2. Implement the func callback to fill in data. If fileSize is -1, the format of func is func(buffer: ArrayBuffer, length: number), and the AVPlayer obtains data in sequence; otherwise, the format is func(buffer: ArrayBuffer, length: number, pos: number), and the AVPlayer seeks and obtains data in the required positions. 3. Set AVDataSrcDescriptor {fileSize = size, callback = func}. Notes: If the media file to play is in MP4/M4A format, ensure that the moov field (specifying the media information) is before the mdat field (specifying the media data) or the fields before the moov field is less than 10 MB. Otherwise, the parsing fails and the media file cannot be played. NOTE WebM is no longer supported since API version 11.
surfaceId9+	string	Yes	Yes	Video window ID. By default, there is no video window. It can be set only when the AVPlayer is in the initialized state. It is used to render the window for video playback and therefore is not required in audio-only playback scenarios. Example: Create a surface ID through XComponent.
loop9+	boolean	Yes	Yes	Whether to loop playback. The value true means to loop playback, and false (default) means the opposite. It is a dynamic attribute and can be set only when the AVPlayer is in the prepared, playing, paused, or completed state. This setting is not supported in live mode.
videoScaleType9+	VideoScaleType	Yes	Yes	Video scaling type. The default value is VIDEO_SCALE_TYPE_FIT. It is a dynamic attribute and can be set only when the AVPlayer is in the prepared, playing, paused, or completed state.
audioInterruptMode9+	audio.InterruptMode	Yes	Yes	Audio interruption mode. The default value is SHARE_MODE. It is a dynamic attribute and can be set only when the AVPlayer is in the prepared, playing, paused, or completed state. To take effect, this attribute must be set before play() is called for the first time.
audioRendererInfo10+	audio.AudioRendererInfo	Yes	Yes	Audio renderer information. The default values of usage and rendererFlags are STREAM_USAGE_MUSIC and 0, respectively. It can be set only when the AVPlayer is in the initialized state. To take effect, this attribute must be set before prepare() is called for the first time.
audioEffectMode10+	audio.AudioEffectMode	Yes	Yes	Audio effect mode. The audio effect mode is a dynamic attribute and is restored to the default value EFFECT_DEFAULT when usage of audioRendererInfo is changed. It can be set only when the AVPlayer is in the prepared, playing, paused, or completed state.
state9+	AVPlayerState	Yes	No	AVPlayer state. It can be used as a query parameter when the AVPlayer is in any state.
currentTime9+	number	Yes	No	Current video playback position, in ms. It can be used as a query parameter when the AVPlayer is in the prepared, playing, paused, or completed state. The value -1 indicates an invalid value. In live mode, -1 is returned by default.
duration9+	number	Yes	No	Video duration, in ms. It can be used as a query parameter when the AVPlayer is in the prepared, playing, paused, or completed state. The value -1 indicates an invalid value. In live mode, -1 is returned by default.
width9+	number	Yes	No	Video width, in px. It can be used as a query parameter when the AVPlayer is in the prepared, playing, paused, or completed state. The value 0 indicates an invalid value.
height9+	number	Yes	No	Video height, in px. It can be used as a query parameter when the AVPlayer is in the prepared, playing, paused, or completed state. The value 0 indicates an invalid value.

NOTE

After the resource handle (FD) is transferred to the AVPlayer, do not use the resource handle to perform read and write operations, including but not limited to transferring it to multiple AVPlayers. Competition occurs when multiple AVPlayers use the same resource handle to read and write files at the same time, resulting in playback errors.

on('stateChange')⁹⁺

on(type: 'stateChange', callback: (state: AVPlayerState, reason: StateChangeReason) => void): void

Subscribes to AVPlayer state changes.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.on('stateChange', async (state: string, reason: media.StateChangeReason) => {
  switch (state) {
    case 'idle':
      console.info('state idle called');
      break;
    case 'initialized':
      console.info('initialized prepared called');
      break;
    case 'prepared':
      console.info('state prepared called');
      break;
    case 'playing':
      console.info('state playing called');
      break;
    case 'paused':
      console.info('state paused called');
      break;
    case 'completed':
      console.info('state completed called');
      break;
    case 'stopped':
      console.info('state stopped called');
      break;
    case 'released':
      console.info('state released called');
      break;
    case 'error':
      console.info('state error called');
      break;
    default:
      console.info('unknown state :' + state);
      break;
  }
})

off('stateChange')⁹⁺

off(type: 'stateChange'): void

Unsubscribes from AVPlayer state changes.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('stateChange')

on('error')⁹⁺

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

Subscribes to AVPlayer errors. This event is used only for error prompt and does not require the user to stop playback control. If AVPlayerState is also switched to error, call reset() or release() to exit the playback.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.on('error', (error: BusinessError) => {
  console.info('error happened,and error message is :' + error.message)
  console.info('error happened,and error code is :' + error.code)
})

off('error')⁹⁺

off(type: 'error'): void

Unsubscribes from AVPlayer errors.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('error')

prepare⁹⁺

prepare(callback: AsyncCallback<void>): void

Prepares for audio and video playback. This API uses an asynchronous callback to return the result. It can be called only when the AVPlayer is in the initialized state. The state changes can be detected by subscribing to the stateChange event.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.prepare((err: BusinessError) => {
  if (err == null) {
    console.info('prepare success');
  } else {
    console.error('prepare filed,error message is :' + err.message)
  }
})

prepare⁹⁺

prepare(): Promise<void>

Prepares for audio and video playback. This API uses a promise to return the result. It can be called only when the AVPlayer is in the initialized state. The state changes can be detected by subscribing to the stateChange event.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.prepare().then(() => {
  console.info('prepare success');
}, (err: BusinessError) => {
  console.error('prepare filed,error message is :' + err.message)
})

play⁹⁺

play(callback: AsyncCallback<void>): void

Starts to play an audio and video asset. This API uses an asynchronous callback to return the result. It can be called only when the AVPlayer is in the prepared, paused, or completed state.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.play((err: BusinessError) => {
  if (err == null) {
    console.info('play success');
  } else {
    console.error('play filed,error message is :' + err.message)
  }
})

play⁹⁺

play(): Promise<void>

Starts to play an audio and video asset. This API uses a promise to return the result. It can be called only when the AVPlayer is in the prepared, paused, or completed state.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.play().then(() => {
  console.info('play success');
}, (err: BusinessError) => {
  console.error('play filed,error message is :' + err.message)
})

pause⁹⁺

pause(callback: AsyncCallback<void>): void

Pauses audio and video playback. This API uses an asynchronous callback to return the result. It can be called only when the AVPlayer is in the playing state.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.pause((err: BusinessError) => {
  if (err == null) {
    console.info('pause success');
  } else {
    console.error('pause filed,error message is :' + err.message)
  }
})

pause⁹⁺

pause(): Promise<void>

Pauses audio and video playback. This API uses a promise to return the result. It can be called only when the AVPlayer is in the playing state.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.pause().then(() => {
  console.info('pause success');
}, (err: BusinessError) => {
  console.error('pause filed,error message is :' + err.message)
})

stop⁹⁺

stop(callback: AsyncCallback<void>): void

Stops audio and video playback. This API uses an asynchronous callback to return the result. It can be called only when the AVPlayer is in the prepared, playing, paused, or completed state.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.stop((err: BusinessError) => {
  if (err == null) {
    console.info('stop success');
  } else {
    console.error('stop filed,error message is :' + err.message)
  }
})

stop⁹⁺

stop(): Promise<void>

Stops audio and video playback. This API uses a promise to return the result. It can be called only when the AVPlayer is in the prepared, playing, paused, or completed state.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.stop().then(() => {
  console.info('stop success');
}, (err: BusinessError) => {
  console.error('stop filed,error message is :' + err.message)
})

reset⁹⁺

reset(callback: AsyncCallback<void>): void

Resets audio and video playback. This API uses an asynchronous callback to return the result. It can be called only when the AVPlayer is in the initialized, prepared, playing, paused, completed, stopped, or error state.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.reset((err: BusinessError) => {
  if (err == null) {
    console.info('reset success');
  } else {
    console.error('reset filed,error message is :' + err.message)
  }
})

reset⁹⁺

reset(): Promise<void>

Resets audio and video playback. This API uses a promise to return the result. It can be called only when the AVPlayer is in the initialized, prepared, playing, paused, completed, stopped, or error state.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.reset().then(() => {
  console.info('reset success');
}, (err: BusinessError) => {
  console.error('reset filed,error message is :' + err.message)
})

release⁹⁺

release(callback: AsyncCallback<void>): void

Releases the playback resources. This API uses an asynchronous callback to return the result. It can be called when the AVPlayer is in any state except released.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.release((err: BusinessError) => {
  if (err == null) {
    console.info('release success');
  } else {
    console.error('release filed,error message is :' + err.message)
  }
})

release⁹⁺

release(): Promise<void>

Releases the playback resources. This API uses a promise to return the result. It can be called when the AVPlayer is in any state except released.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.release().then(() => {
  console.info('release success');
}, (err: BusinessError) => {
  console.error('release filed,error message is :' + err.message)
})

getTrackDescription⁹⁺

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

Obtains the audio and video track information. This API uses an asynchronous callback to return the result. It can be called only when the AVPlayer is in the prepared, playing, or paused state. To obtain information about all audio and video tracks, this API must be called after the data loading callback is triggered.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.getTrackDescription((error: BusinessError, arrList: Array<media.MediaDescription>) => {
  if ((arrList) != null) {
    console.info('getTrackDescription success');
  } else {
    console.error(`video getTrackDescription fail, error:${error}`);
  }
});

getTrackDescription⁹⁺

getTrackDescription(): Promise<Array<MediaDescription>>

Obtains the audio and video track information. This API uses a promise to return the result. It can be called only when the AVPlayer is in the prepared, playing, or paused state.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avPlayer.getTrackDescription().then((arrList: Array<media.MediaDescription>) => {
  console.info('getTrackDescription success');
}).catch((error: BusinessError) => {
  console.error(`video catchCallback, error:${error}`);
});

setDecryptionConfig¹¹⁺

setDecryptionConfig(mediaKeySession: drm.MediaKeySession, secureVideoPath: boolean): void

Sets the decryption configuration. When receiving a mediaKeySystemInfoUpdate event, create the related configuration and set the decryption configuration based on the information in the reported event. Otherwise, the playback fails.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

For details about the DRM module, see js-apis-drm.md.

import drm from '@ohos.multimedia.drm'

// Create a media key system.
let keySystem:drm.MediaKeySystem = drm.createMediaKeySystem('com.clearplay.drm');
// Create a media key session.
let keySession:drm.MediaKeySession = keySystem.createMediaKeySession(drm.ContentProtectionLevel.CONTENT_PROTECTION_LEVEL_SW_CRYPTO);
// Flag indicating whether a secure video channel is used.
var secureVideoPath:boolean = false;
// Set the decryption configuration.
avPlayer.setDecryptionConfig(keySession, secureVideoPath);

getMediaKeySystemInfos¹¹⁺

getMediaKeySystemInfos(): Array<drm.MediaKeySystemInfo>

Obtains the media key system information of the media asset that is being played. This API must be called after the [mediaKeySystemInfoUpdate event[(#onmediakeysysteminfoupdate11) is triggered.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Return value

Example

import drm from '@ohos.multimedia.drm'

const infos = avPlayer.getMediaKeySystemInfos();
console.info('GetMediaKeySystemInfos count: ' + infos.length);
for (var i = 0; i < infos.length; i++) {
  console.info('GetMediaKeySystemInfos uuid: ' + infos[i]["uuid"]);
  console.info('GetMediaKeySystemInfos pssh: ' + infos[i]["pssh"]);
}

seek⁹⁺

seek(timeMs: number, mode?:SeekMode): void

Seeks to the specified playback position. This API can be called only when the AVPlayer is in the prepared, playing, paused, or completed state. You can check whether the seek operation takes effect by subscribing to the seekDone event. This API is not supported in live mode.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

let seekTime: number = 1000
avPlayer.seek(seekTime, media.SeekMode.SEEK_PREV_SYNC)

on('seekDone')⁹⁺

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

Subscribes to the event to check whether the seek operation takes effect.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.on('seekDone', (seekDoneTime:number) => {
  console.info('seekDone success,and seek time is:' + seekDoneTime)
})

off('seekDone')⁹⁺

off(type: 'seekDone'): void

Unsubscribes from the event that checks whether the seek operation takes effect.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('seekDone')

setSpeed⁹⁺

setSpeed(speed: PlaybackSpeed): void

Sets the playback speed. This API can be called only when the AVPlayer is in the prepared, playing, paused, or completed state. You can check whether the setting takes effect by subscribing to the speedDone event. This API is not supported in live mode.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.setSpeed(media.PlaybackSpeed.SPEED_FORWARD_2_00_X)

on('speedDone')⁹⁺

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

Subscribes to the event to check whether the playback speed is successfully set.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.on('speedDone', (speed:number) => {
  console.info('speedDone success,and speed value is:' + speed)
})

off('speedDone')⁹⁺

off(type: 'speedDone'): void

Unsubscribes from the event that checks whether the playback speed is successfully set.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('speedDone')

setBitrate⁹⁺

setBitrate(bitrate: number): void

Sets the bit rate, which is valid only for HTTP Live Streaming (HLS) streams. This API can be called only when the AVPlayer is in the prepared, playing, paused, or completed state. You can check whether the setting takes effect by subscribing to the bitrateDone event. Note that the AVPlayer selects a proper bit rate based on the network connection speed.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

let bitrate: number = 96000
avPlayer.setBitrate(bitrate)

on('bitrateDone')⁹⁺

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

Subscribes to the event to check whether the bit rate is successfully set.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.on('bitrateDone', (bitrate:number) => {
  console.info('bitrateDone success,and bitrate value is:' + bitrate)
})

off('bitrateDone')⁹⁺

off(type: 'bitrateDone'): void

Unsubscribes from the event that checks whether the bit rate is successfully set.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('bitrateDone')

on('availableBitrates')⁹⁺

on(type: 'availableBitrates', callback: (bitrates: Array<number>) => void): void

Subscribes to available bit rates of HLS streams. This event is reported only after the AVPlayer switches to the prepared state.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.on('availableBitrates', (bitrates: Array<number>) => {
  console.info('availableBitrates success,and availableBitrates length is:' + bitrates.length)
})

off('availableBitrates')⁹⁺

off(type: 'availableBitrates'): void

Unsubscribes from available bit rates of HLS streams. This event is reported after prepare is called.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('availableBitrates')

on('mediaKeySystemInfoUpdate')¹¹⁺

on(type: 'mediaKeySystemInfoUpdate', callback: (mediaKeySystemInfo: Array<drm.MediaKeySystemInfo>) => void): void

Subscribes to media key system information changes.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

import drm from './@ohos.multimedia.drm';

avPlayer.on('mediaKeySystemInfoUpdate', (mediaKeySystemInfo: Array<drm.MediaKeySystemInfo>) => {
    for (var i = 0; i < mediaKeySystemInfo.length; i++) {
      console.info('mediaKeySystemInfoUpdate happened uuid: ' + mediaKeySystemInfo[i]["uuid"]);
      console.info('mediaKeySystemInfoUpdate happened pssh: ' + mediaKeySystemInfo[i]["pssh"]);
    }
})

off('mediaKeySystemInfoUpdate')¹¹⁺

off(type: 'mediaKeySystemInfoUpdate', callback?: (mediaKeySystemInfo: Array<drm.MediaKeySystemInfo>) => void): void;

Unsubscribes from media key system information changes.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('mediaKeySystemInfoUpdate')

setVolume⁹⁺

setVolume(volume: number): void

Sets the volume. This API can be called only when the AVPlayer is in the prepared, playing, paused, or completed state. You can check whether the setting takes effect by subscribing to the volumeChange event.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

let volume: number = 1.0
avPlayer.setVolume(volume)

on('volumeChange')⁹⁺

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

Subscribes to the event to check whether the volume is successfully set.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.on('volumeChange', (vol: number) => {
  console.info('volumeChange success,and new volume is :' + vol)
})

off('volumeChange')⁹⁺

off(type: 'volumeChange'): void

Unsubscribes from the event that checks whether the volume is successfully set.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('volumeChange')

on('endOfStream')⁹⁺

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

Subscribes to the event that indicates the end of the stream being played. If loop = true is set, the AVPlayer seeks to the beginning of the stream and plays the stream again. If loop is not set, the completed state is reported through the stateChange event.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.on('endOfStream', () => {
  console.info('endOfStream success')
})

off('endOfStream')⁹⁺

off(type: 'endOfStream'): void

Unsubscribes from the event that indicates the end of the stream being played.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('endOfStream')

on('timeUpdate')⁹⁺

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

Subscribes to playback position changes. It is used to refresh the current position of the progress bar. By default, this event is reported every 100 ms. However, it is reported immediately upon a successful seek operation. The 'timeUpdate' event is not supported in live mode.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.on('timeUpdate', (time:number) => {
  console.info('timeUpdate success,and new time is :' + time)
})

off('timeUpdate')⁹⁺

off(type: 'timeUpdate'): void

Unsubscribes from playback position changes.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('timeUpdate')

on('durationUpdate')⁹⁺

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

Subscribes to media asset duration changes. It is used to refresh the length of the progress bar. By default, this event is reported once when the AVPlayer switches to the prepared state. However, it can be repeatedly reported for special streams that trigger duration changes. The 'durationUpdate' event is not supported in live mode.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.on('durationUpdate', (duration: number) => {
  console.info('durationUpdate success,new duration is :' + duration)
})

off('durationUpdate')⁹⁺

off(type: 'durationUpdate'): void

Unsubscribes from media asset duration changes.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('durationUpdate')

on('bufferingUpdate')⁹⁺

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

Subscribes to audio and video buffer changes. This subscription is supported only in network playback scenarios.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.on('bufferingUpdate', (infoType: media.BufferingInfoType, value: number) => {
  console.info('bufferingUpdate success,and infoType value is:' + infoType + ', value is :' + value)
})

off('bufferingUpdate')⁹⁺

off(type: 'bufferingUpdate'): void

Unsubscribes from audio and video buffer changes.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('bufferingUpdate')

on('startRenderFrame')⁹⁺

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

Subscribes to the event that indicates rendering starts for the first frame. This subscription is supported only in the video playback scenarios. This event only means that the playback service sends the first frame to the display module. The actual rendering effect depends on the rendering performance of the display service.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.on('startRenderFrame', () => {
  console.info('startRenderFrame success')
})

off('startRenderFrame')⁹⁺

off(type: 'startRenderFrame'): void

Unsubscribes from the event that indicates rendering starts for the first frame.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('startRenderFrame')

on('videoSizeChange')⁹⁺

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

Subscribes to video size (width and height) changes. This subscription is supported only in the video playback scenarios. By default, this event is reported only once in the prepared state. However, it is also reported upon resolution changes in the case of HLS streams.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.on('videoSizeChange', (width: number, height: number) => {
  console.info('videoSizeChange success,and width is:' + width + ', height is :' + height)
})

off('videoSizeChange')⁹⁺

off(type: 'videoSizeChange'): void

Unsubscribes from video size changes.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('videoSizeChange')

on('audioInterrupt')⁹⁺

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

Subscribes to the audio interruption event. When multiple audio and video assets are played at the same time, this event is triggered based on the audio interruption mode audio.InterruptMode.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

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

avPlayer.on('audioInterrupt', (info: audio.InterruptEvent) => {
  console.info('audioInterrupt success,and InterruptEvent info is:' + info)
})

off('audioInterrupt')⁹⁺

off(type: 'audioInterrupt'): void

Unsubscribes from the audio interruption event.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Example

avPlayer.off('audioInterrupt')

on('audioOutputDeviceChangeWithInfo') ¹¹⁺

on(type: 'audioOutputDeviceChangeWithInfo', callback: Callback<audio.AudioStreamDeviceChangeInfo>): void

Subscribes to audio stream output device changes and reasons. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Error codes

Example

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

avPlayer.on('audioOutputDeviceChangeWithInfo', (data: audio.AudioStreamDeviceChangeInfo) => {
  console.info(`${JSON.stringify(data)}`);
});

off('audioOutputDeviceChangeWithInfo') ¹¹⁺

off(type: 'audioOutputDeviceChangeWithInfo', callback?: Callback<audio.AudioStreamDeviceChangeInfo>): void

Unsubscribes from audio stream output device changes and reasons. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Error codes

Example

avPlayer.off('audioOutputDeviceChangeWithInfo');

AVPlayerState⁹⁺

Enumerates the states of the AVPlayer. Your application can proactively obtain the AVPlayer state through the state attribute or obtain the reported AVPlayer state by subscribing to the stateChange event. For details about the rules for state transition, see Audio Playback.

System capability: SystemCapability.Multimedia.Media.AVPlayer

AVFileDescriptor⁹⁺

Describes an audio and video file asset. It is used to specify a particular asset for playback based on its offset and length within a file.

System capability: SystemCapability.Multimedia.Media.Core

AVDataSrcDescriptor¹⁰⁺

Defines the descriptor of an audio and video file, which is used in DataSource playback mode.
Use scenario: An application can create a playback instance and start playback before it finishes downloading the audio and video resources.

System capability: SystemCapability.Multimedia.Media.AVPlayer

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

VideoScaleType⁹⁺

Enumerates the video scale modes.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

MediaDescription⁸⁺

Defines media information in key-value mode.

System capability: SystemCapability.Multimedia.Media.Core

Example

import { BusinessError } from '@ohos.base';
import media from '@ohos.multimedia.media';

function printfItemDescription(obj: media.MediaDescription, key: string) {
  let property: Object = obj[key];
  console.info('audio key is ' + key); // Specify a key. For details about the keys, see [MediaDescriptionKey].
  console.info('audio value is ' + property); // Obtain the value of the key. The value can be any type. For details about the types, see [MediaDescriptionKey].
}

let avPlayer: media.AVPlayer | undefined = undefined;
media.createAVPlayer((err: BusinessError, player: media.AVPlayer) => {
  if(player != null) {
    avPlayer = player;
    console.info(`createAVPlayer success`);
    avPlayer.getTrackDescription((error: BusinessError, arrList: Array<media.MediaDescription>) => {
      if (arrList != null) {
        for (let i = 0; i < arrList.length; i++) {
          printfItemDescription(arrList[i], media.MediaDescriptionKey.MD_KEY_TRACK_TYPE);  // Print the MD_KEY_TRACK_TYPE value of each track.
        }
      } else {
        console.error(`audio getTrackDescription fail, error:${error}`);
      }
    });
  } else {
    console.error(`createAVPlayer fail, error message:${err.message}`);
  }
});

AVRecorder⁹⁺

A recording management class that provides APIs to record media assets. Before calling any API in AVRecorder, you must use createAVRecorder() to create an AVRecorder instance.

For details about the audio and video recording demo, see Audio Recording and Video Recording.

NOTE

To use the camera to record videos, the camera module is required. For details about how to use the APIs provided by the camera module, see Camera Management.

Attributes

System capability: SystemCapability.Multimedia.Media.AVRecorder

prepare⁹⁺

prepare(config: AVRecorderConfig, callback: AsyncCallback<void>): void

Sets audio and video recording parameters. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MICROPHONE

This permission is required only if audio recording is involved.

To use the camera to record videos, the camera module is required. For details about how to use the APIs provided by the camera module, see Camera Management.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Configure the parameters based on those supported by the hardware device.
let avRecorderProfile: media.AVRecorderProfile = {
  audioBitrate : 48000,
  audioChannels : 2,
  audioCodec : media.CodecMimeType.AUDIO_AAC,
  audioSampleRate : 48000,
  fileFormat : media.ContainerFormatType.CFT_MPEG_4,
  videoBitrate : 2000000,
  videoCodec : media.CodecMimeType.VIDEO_AVC,
  videoFrameWidth : 640,
  videoFrameHeight : 480,
  videoFrameRate : 30
}
let avRecorderConfig: media.AVRecorderConfig = {
  audioSourceType : media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC,
  videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV,
  profile : avRecorderProfile,
  url : 'fd://', // Before passing in an FD to this parameter, the file must be created by the caller and granted with the read and write permissions. Example value: fd://45.
  rotation: 0, // The value can be 0, 90, 180, or 270. If any other value is used, prepare() reports an error.
  location : { latitude : 30, longitude : 130 }
}

avRecorder.prepare(avRecorderConfig, (err: BusinessError) => {
  if (err == null) {
    console.info('prepare success');
  } else {
    console.error('prepare failed and error is ' + err.message);
  }
})

prepare⁹⁺

prepare(config: AVRecorderConfig): Promise<void>

Sets audio and video recording parameters. This API uses a promise to return the result.

Required permissions: ohos.permission.MICROPHONE

This permission is required only if audio recording is involved.

To use the camera to record videos, the camera module is required. For details about how to use the APIs provided by the camera module, see Camera Management.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Configure the parameters based on those supported by the hardware device.
let avRecorderProfile: media.AVRecorderProfile = {
  audioBitrate : 48000,
  audioChannels : 2,
  audioCodec : media.CodecMimeType.AUDIO_AAC,
  audioSampleRate : 48000,
  fileFormat : media.ContainerFormatType.CFT_MPEG_4,
  videoBitrate : 2000000,
  videoCodec : media.CodecMimeType.VIDEO_AVC,
  videoFrameWidth : 640,
  videoFrameHeight : 480,
  videoFrameRate : 30
}
let avRecorderConfig: media.AVRecorderConfig = {
  audioSourceType : media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC,
  videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV,
  profile : avRecorderProfile,
  url : 'fd://', // Before passing in an FD to this parameter, the file must be created by the caller and granted with the read and write permissions. Example value: fd://45.
  rotation: 0, // The value can be 0, 90, 180, or 270. If any other value is used, prepare() reports an error.
  location : { latitude : 30, longitude : 130 }
}

avRecorder.prepare(avRecorderConfig).then(() => {
  console.info('prepare success');
}).catch((err: BusinessError) => {
  console.error('prepare failed and catch error is ' + err.message);
});

getInputSurface⁹⁺

getInputSurface(callback: AsyncCallback<string>): void

Obtains the surface required for recording. This API uses an asynchronous callback to return the result. The caller obtains the surfaceBuffer from this surface and fills in the corresponding video data.

Note that the video data must carry the timestamp (in ns) and buffer size, and the start time of the timestamp must be based on the system startup time.

This API can be called only after the prepare() API is called.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';
let surfaceID: string; // The surfaceID is transferred to the camera API to create a videoOutput instance.

avRecorder.getInputSurface((err: BusinessError, surfaceId: string) => {
  if (err == null) {
    console.info('getInputSurface success');
    surfaceID = surfaceId;
  } else {
    console.error('getInputSurface failed and error is ' + err.message);
  }
});

getInputSurface⁹⁺

getInputSurface(): Promise<string>

Obtains the surface required for recording. This API uses a promise to return the result. The caller obtains the surfaceBuffer from this surface and fills in the corresponding video data.

Note that the video data must carry the timestamp (in ns) and buffer size, and the start time of the timestamp must be based on the system startup time.

This API can be called only after the prepare() API is called.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';
let surfaceID: string; // The surfaceID is transferred to the camera API to create a videoOutput instance.

avRecorder.getInputSurface().then((surfaceId: string) => {
  console.info('getInputSurface success');
  surfaceID = surfaceId;
}).catch((err: BusinessError) => {
  console.error('getInputSurface failed and catch error is ' + err.message);
});

start⁹⁺

start(callback: AsyncCallback<void>): void

Starts recording. This API uses an asynchronous callback to return the result.

For audio-only recording, this API can be called only after the prepare() API is called. For video-only recording, this API can be called only after the getInputSurface() API is called.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avRecorder.start((err: BusinessError) => {
  if (err == null) {
    console.info('start AVRecorder success');
  } else {
    console.error('start AVRecorder failed and error is ' + err.message);
  }
});

start⁹⁺

start(): Promise<void>

Starts recording. This API uses a promise to return the result.

For audio-only recording, this API can be called only after the prepare() API is called. For video-only recording, this API can be called only after the getInputSurface() API is called.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avRecorder.start().then(() => {
  console.info('start AVRecorder success');
}).catch((err: BusinessError) => {
  console.error('start AVRecorder failed and catch error is ' + err.message);
});

pause⁹⁺

pause(callback: AsyncCallback<void>): void

Pauses recording. This API uses an asynchronous callback to return the result.

This API can be called only after the start() API is called. You can call resume() to resume recording.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avRecorder.pause((err: BusinessError) => {
  if (err == null) {
    console.info('pause AVRecorder success');
  } else {
    console.error('pause AVRecorder failed and error is ' + err.message);
  }
});

pause⁹⁺

pause(): Promise<void>

Pauses recording. This API uses a promise to return the result.

This API can be called only after the start() API is called. You can call resume() to resume recording.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avRecorder.pause().then(() => {
  console.info('pause AVRecorder success');
}).catch((err: BusinessError) => {
  console.error('pause AVRecorder failed and catch error is ' + err.message);
});

resume⁹⁺

resume(callback: AsyncCallback<void>): void

Resumes recording. This API uses an asynchronous callback to return the result.

This API can be called only after the pause() API is called.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avRecorder.resume((err: BusinessError) => {
  if (err == null) {
    console.info('resume AVRecorder success');
  } else {
    console.error('resume AVRecorder failed and error is ' + err.message);
  }
});

resume⁹⁺

resume(): Promise<void>

Resumes recording. This API uses a promise to return the result.

This API can be called only after the pause() API is called.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avRecorder.resume().then(() => {
  console.info('resume AVRecorder success');
}).catch((err: BusinessError) => {
  console.error('resume AVRecorder failed and catch error is ' + err.message);
});

stop⁹⁺

stop(callback: AsyncCallback<void>): void

Stops recording. This API uses an asynchronous callback to return the result.

This API can be called only after the start() or pause() API is called.

For audio-only recording, you can call prepare() again for re-recording. For video-only recording or audio and video recording, you can call prepare() and getInputSurface() again for re-recording.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avRecorder.stop((err: BusinessError) => {
  if (err == null) {
    console.info('stop AVRecorder success');
  } else {
    console.error('stop AVRecorder failed and error is ' + err.message);
  }
});

stop⁹⁺

stop(): Promise<void>

Stops recording. This API uses a promise to return the result.

This API can be called only after the start() or pause() API is called.

For audio-only recording, you can call prepare() again for re-recording. For video-only recording or audio and video recording, you can call prepare() and getInputSurface() again for re-recording.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avRecorder.stop().then(() => {
  console.info('stop AVRecorder success');
}).catch((err: BusinessError) => {
  console.error('stop AVRecorder failed and catch error is ' + err.message);
});

reset⁹⁺

reset(callback: AsyncCallback<void>): void

Resets audio and video recording. This API uses an asynchronous callback to return the result.

For audio-only recording, you can call prepare() again for re-recording. For video-only recording or audio and video recording, you can call prepare() and getInputSurface() again for re-recording.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avRecorder.reset((err: BusinessError) => {
  if (err == null) {
    console.info('reset AVRecorder success');
  } else {
    console.error('reset AVRecorder failed and error is ' + err.message);
  }
});

reset⁹⁺

reset(): Promise<void>

Resets audio and video recording. This API uses a promise to return the result.

For audio-only recording, you can call prepare() again for re-recording. For video-only recording or audio and video recording, you can call prepare() and getInputSurface() again for re-recording.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avRecorder.reset().then(() => {
  console.info('reset AVRecorder success');
}).catch((err: BusinessError) => {
  console.error('reset AVRecorder failed and catch error is ' + err.message);
});

release⁹⁺

release(callback: AsyncCallback<void>): void

Releases the audio and video recording resources. This API uses an asynchronous callback to return the result.

After the resources are released, you can no longer perform any operation on the AVRecorder instance.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avRecorder.release((err: BusinessError) => {
  if (err == null) {
    console.info('release AVRecorder success');
  } else {
    console.error('release AVRecorder failed and error is ' + err.message);
  }
});

release⁹⁺

release(): Promise<void>

Releases the audio and video recording resources. This API uses a promise to return the result.

After the resources are released, you can no longer perform any operation on the AVRecorder instance.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avRecorder.release().then(() => {
  console.info('release AVRecorder success');
}).catch((err: BusinessError) => {
  console.error('release AVRecorder failed and catch error is ' + err.message);
});

getCurrentAudioCapturerInfo¹¹⁺

getCurrentAudioCapturerInfo(callback: AsyncCallback<audio.AudioCapturerChangeInfo>): void

Obtains the information about the current audio capturer. This API uses an asynchronous callback to return the result.

This API can be called only after the prepare() API is called. If this API is called after stop() is successfully called, an error is reported.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

let currentCapturerInfo: audio.AudioCapturerChangeInfo;

avRecorder.getCurrentAudioCapturerInfo((err: BusinessError, capturerInfo: audio.AudioCapturerChangeInfo) => {
  if (err == null) {
    console.info('getCurrentAudioCapturerInfo success');
    currentCapturerInfo = capturerInfo;
  } else {
    console.error('getCurrentAudioCapturerInfo failed and error is ' + err.message);
  }
});

getCurrentAudioCapturerInfo¹¹⁺

getCurrentAudioCapturerInfo(): Promise<audio.AudioCapturerChangeInfo>

Obtains the information about the current audio capturer. This API uses a promise to return the result.

This API can be called only after the prepare() API is called. If this API is called after stop() is successfully called, an error is reported.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

let currentCapturerInfo: audio.AudioCapturerChangeInfo;

avRecorder.getCurrentAudioCapturerInfo().then((capturerInfo: audio.AudioCapturerChangeInfo) => {
  console.info('getCurrentAudioCapturerInfo success');
  currentCapturerInfo = capturerInfo;
}).catch((err: BusinessError) => {
  console.error('getCurrentAudioCapturerInfo failed and catch error is ' + err.message);
});

getAudioCapturerMaxAmplitude¹¹⁺

getAudioCapturerMaxAmplitude(callback: AsyncCallback<number>): void

Obtains the maximum amplitude of the current audio capturer. This API uses an asynchronous callback to return the result.

This API can be called only after the prepare() API is called. If this API is called after stop() is successfully called, an error is reported.

The return value is the maximum amplitude within the duration from the time the maximum amplitude is obtained last time to the current time. For example, if you have obtained the maximum amplitude at 1s and you call this API again at 2s, then the return value is the maximum amplitude within the duration from 1s to 2s.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

let maxAmplitude: number;

avRecorder.getAudioCapturerMaxAmplitude((err: BusinessError, amplitude: number) => {
  if (err == null) {
    console.info('getAudioCapturerMaxAmplitude success');
    maxAmplitude = amplitude;
  } else {
    console.error('getAudioCapturerMaxAmplitude failed and error is ' + err.message);
  }
});

getAudioCapturerMaxAmplitude¹¹⁺

getAudioCapturerMaxAmplitude(): Promise<number>

Obtains the maximum amplitude of the current audio capturer. This API uses a promise to return the result.

This API can be called only after the prepare() API is called. If this API is called after stop() is successfully called, an error is reported.

The return value is the maximum amplitude within the duration from the time the maximum amplitude is obtained last time to the current time. For example, if you have obtained the maximum amplitude at 1s and you call this API again at 2s, then the return value is the maximum amplitude within the duration from 1s to 2s.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

let maxAmplitude: number;

avRecorder.getAudioCapturerMaxAmplitude().then((amplitude: number) => {
  console.info('getAudioCapturerMaxAmplitude success');
  maxAmplitude = amplitude;
}).catch((err: BusinessError) => {
  console.error('getAudioCapturerMaxAmplitude failed and catch error is ' + err.message);
});

getAvailableEncoder¹¹⁺

getAvailableEncoder(callback: AsyncCallback<Array<EncoderInfo>>): void

Obtains available encoders. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

let encoderInfo: media.EncoderInfo;

avRecorder.getAvailableEncoder((err: BusinessError, info: media.EncoderInfo) => {
  if (err == null) {
    console.info('getAvailableEncoder success');
    encoderInfo = info;
  } else {
    console.error('getAvailableEncoder failed and error is ' + err.message);
  }
});

getAvailableEncoder¹¹⁺

getAvailableEncoder(): Promise<Array<EncoderInfo>>

Obtains available encoders. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

let encoderInfo: media.EncoderInfo;

avRecorder.getAvailableEncoder().then((info: media.EncoderInfo) => {
  console.info('getAvailableEncoder success');
  encoderInfo = info;
}).catch((err: BusinessError) => {
  console.error('getAvailableEncoder failed and catch error is ' + err.message);
});

getAVRecorderConfig¹¹⁺

getAVRecorderConfig(callback: AsyncCallback<AVRecorderConfig>): void

Obtains the real-time configuration of this AVRecorder. This API uses an asynchronous callback to return the result.

This API can be called only after prepare() is called.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

let AVRecorderConfig: AVRecorderConfig;

avRecorder.getAVRecorderConfig((err: BusinessError, config: AVRecorderConfig) => {
  if (err == null) {
    console.info('getAVRecorderConfig success');
    AVRecorderConfig = config;
  } else {
    console.error('getAVRecorderConfig failed and error is ' + err.message);
  }
});

getAVRecorderConfig¹¹⁺

getAVRecorderConfig(): Promise<AVRecorderConfig>;

Obtains the real-time configuration of this AVRecorder. This API uses a promise to return the result.

This API can be called only after prepare() is called.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

let AVRecorderConfig: AVRecorderConfig;

avRecorder.getAVRecorderConfig().then((config: AVRecorderConfig) => {
  console.info('getAVRecorderConfig success');
  AVRecorderConfig = config;
}).catch((err: BusinessError) => {
  console.error('getAVRecorderConfig failed and catch error is ' + err.message);
});

on('stateChange')⁹⁺

on(type: 'stateChange', callback: (state: AVRecorderState, reason: StateChangeReason) => void): void

Subscribes to AVRecorder state changes. An application can subscribe to only one AVRecorder state change event. When the application initiates multiple subscriptions to this event, the last subscription prevails.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

avRecorder.on('stateChange', async (state: media.AVRecorderState, reason: media.StateChangeReason) => {
  console.info('case state has changed, new state is :' + state + ',and new reason is : ' + reason);
});

off('stateChange')⁹⁺

off(type: 'stateChange'): void

Unsubscribes from AVRecorder state changes.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Example

avRecorder.off('stateChange');

on('error')⁹⁺

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

Subscribes to AVRecorder errors. This event is used only for error prompt and does not require the user to stop recording control. If the AVRecorderState is also switched to error, call reset() or [release()]release() to exit the recording.

An application can subscribe to only one AVRecorder error event. When the application initiates multiple subscriptions to this event, the last subscription prevails.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

avRecorder.on('error', (err: BusinessError) => {
  console.info('case avRecorder.on(error) called, errMessage is ' + err.message);
});

off('error')⁹⁺

off(type: 'error'): void

Unsubscribes from AVRecorder errors. After the unsubscription, your application can no longer receive AVRecorder errors.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Example

avRecorder.off('error');

on('audioCapturerChange')¹¹⁺

on(type: 'audioCapturerChange', callback: Callback<audio.AudioCapturerChangeInfo>): void

Subscribes to audio capturer configuration changes. Any configuration change triggers the callback that returns the entire configuration information.

When the application initiates multiple subscriptions to this event, the last subscription prevails.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Error codes

Example

let capturerChangeInfo: audio.AudioCapturerChangeInfo;

avRecorder.on('audioCapturerChange',  (audioCapturerChangeInfo: audio.AudioCapturerChangeInfo) => {
  console.info('audioCapturerChange success');
  capturerChangeInfo = audioCapturerChangeInfo;
});

off('audioCapturerChange')¹¹⁺

off(type: 'audioCapturerChange'): void

Subscribes to audio capturer configuration changes.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Example

avRecorder.off('audioCapturerChange');

AVRecorderState⁹⁺

Enumerates the AVRecorder states. You can obtain the state through the state attribute.

System capability: SystemCapability.Multimedia.Media.AVRecorder

AVRecorderConfig⁹⁺

Describes the audio and video recording parameters.

The audioSourceType and videoSourceType parameters are used to distinguish audio-only recording, video-only recording, and audio and video recording. For audio-only recording, set only audioSourceType. For video-only recording, set only videoSourceType. For audio and video recording, set both audioSourceType and videoSourceType.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Name	Type	Mandatory	Description
audioSourceType	AudioSourceType	No	Type of the audio source to record. This parameter is mandatory for audio recording.
videoSourceType	VideoSourceType	No	Type of the video source to record. This parameter is mandatory for video recording.
profile	AVRecorderProfile	Yes	Recording profile. This parameter is mandatory.
url	string	Yes	Recording output URL: fd://xx (fd number). This parameter is mandatory.
rotation	number	No	Rotation angle of the recorded video. The value can be 0 (default), 90, 180, or 270 for MP4 videos.
location	Location	No	Geographical location of the recorded video. By default, the geographical location information is not recorded.

AVRecorderProfile⁹⁺

Describes the audio and video recording profile.

System capability: SystemCapability.Multimedia.Media.AVRecorder

AudioSourceType⁹⁺

Enumerates the audio source types for video recording.

System capability: SystemCapability.Multimedia.Media.AVRecorder

VideoSourceType⁹⁺

Enumerates the video source types for video recording.

System capability: SystemCapability.Multimedia.Media.AVRecorder

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

EncoderInfo¹¹⁺

Describes the information about an encoder.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Range¹¹⁺

Describes a range.

System capability: SystemCapability.Multimedia.Media.AVRecorder

AVMetadataExtractor¹¹⁺

Provides APIs to obtain metadata from media resources. Before calling any API of AVMetadataExtractor, you must use createAVMetadataExtractor() to create an AVMetadataExtractor instance.

For details about the demo for obtaining audio or video metadata, see Obtaining Audio/Video Metadata.

Attributes

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

fetchMetadata¹¹⁺

fetchMetadata(callback: AsyncCallback<AVMetadata>): void

Obtains media metadata. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';
import media from '@ohos.multimedia.media';

let avMetadataExtractor: media.AVMetadataExtractor | undefined = undefined;

// Obtain the metadata.
media.createAVMetadataExtractor((err: BusinessError, extractor: media.AVMetadataExtractor) => {
  if(extractor != null){
    avMetadataExtractor = extractor;
    console.error(`createAVMetadataExtractor success`);
    avMetadataExtractor.fetchMetadata((error: BusinessError, metadata: media.AVMetadata) => {
      if (error) {
        console.error(`fetchMetadata callback failed, err = ${JSON.stringify(error)}`);
        return;
      }
      console.info(`fetchMetadata callback success, genre: ${metadata.genre}`);
    });
  } else {
    console.error(`createAVMetadataExtractor fail, error message:${err.message}`);
  }
});

fetchMetadata¹¹⁺

fetchMetadata(): Promise<AVMetadata>

Obtains media metadata. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';
import media from '@ohos.multimedia.media';

let avMetadataExtractor: media.AVMetadataExtractor | undefined = undefined;

// Obtain the metadata.
media.createAVMetadataExtractor((err: BusinessError, extractor: media.AVMetadataExtractor) => {
  if(extractor != null){
    avMetadataExtractor = extractor;
    console.error(`createAVMetadataExtractor success`);
    avMetadataExtractor.fetchMetadata().then((metadata: media.AVMetadata) => {
      console.info(`fetchMetadata callback success, genre: ${metadata.genre}`)
    }).catch((error: BusinessError) => {
      console.error(`fetchMetadata catchCallback, error message:${error.message}`);
    });
  } else {
    console.error(`createAVMetadataExtractor fail, error message:${err.message}`);
  }
});

fetchAlbumCover¹¹⁺

fetchAlbumCover(callback: AsyncCallback<image.PixelMap>): void

Obtains the cover of the audio album. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';
import media from '@ohos.multimedia.media';
import image from '@ohos.multimedia.image';

let avMetadataExtractor: media.AVMetadataExtractor | undefined = undefined;
let pixel_map : image.PixelMap | undefined = undefined;

// Obtain the album cover.
media.createAVMetadataExtractor((err: BusinessError, extractor: media.AVMetadataExtractor) => {
  if(extractor != null){
    avMetadataExtractor = extractor;
    console.error(`createAVMetadataExtractor success`);
    avMetadataExtractor.fetchAlbumCover((error: BusinessError, pixelMap: image.PixelMap) => {
      if (error) {
        console.error(`fetchAlbumCover callback failed, error = ${JSON.stringify(error)}`);
        return;
      }
      pixel_map = pixelMap;
    });
  } else {
    console.error(`createAVMetadataExtractor fail, error message:${err.message}`);
  };
});

fetchAlbumCover¹¹⁺

fetchAlbumCover(): Promise<image.PixelMap>

Obtains the cover of the audio album. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';
import media from '@ohos.multimedia.media';
import image from '@ohos.multimedia.image';

let avMetadataExtractor: media.AVMetadataExtractor | undefined = undefined;
let pixel_map : image.PixelMap | undefined = undefined;

// Obtain the album cover.
media.createAVMetadataExtractor((err: BusinessError, extractor: media.AVMetadataExtractor) => {
  if(extractor != null){
    avMetadataExtractor = extractor;
    console.error(`createAVMetadataExtractor success`);
    avMetadataExtractor.fetchAlbumCover().then((pixelMap: image.PixelMap) => {
      pixel_map = pixelMap;
    }).catch((error: BusinessError) => {
      console.error(`fetchAlbumCover catchCallback, error message:${error.message}`);
    });
  } else {
    console.error(`createAVMetadataExtractor fail, error message:${err.message}`);
  };
});

release¹¹⁺

release(callback: AsyncCallback<void>): void

Releases this AVMetadataExtractor instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';
import media from '@ohos.multimedia.media';

let avMetadataExtractor: media.AVMetadataExtractor | undefined = undefined;

// Release the instance.
media.createAVMetadataExtractor((err: BusinessError, extractor: media.AVMetadataExtractor) => {
  if(extractor != null){
    avMetadataExtractor = extractor;
    console.error(`createAVMetadataExtractor success`);
    avMetadataExtractor.release((error: BusinessError) => {
      if (error) {
        console.error(`release failed, err = ${JSON.stringify(error)}`);
        return;
      }
      console.info(`release success.`);
    });
  } else {
    console.error(`createAVMetadataExtractor fail, error message:${err.message}`);
  };
});

release¹¹⁺

release(): Promise<void>

Releases this AVMetadataExtractor instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';
import media from '@ohos.multimedia.media';

let avMetadataExtractor: media.AVMetadataExtractor | undefined = undefined;

// Release the instance.
media.createAVMetadataExtractor((err: BusinessError, extractor: media.AVMetadataExtractor) => {
  if(extractor != null){
    avMetadataExtractor = extractor;
    console.error(`createAVMetadataExtractor success`);
    avMetadataExtractor.release().then(() => {
      console.info(`release success.`);
    }).catch((error: BusinessError) => {
      console.error(`release catchCallback, error message:${error.message}`);
    });
  } else {
    console.error(`createAVMetadataExtractor fail, error message:${err.message}`);
  };
});

AVMetadata¹¹⁺

Defines the audio and video metadata.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

media.createAudioPlayer^(deprecated)

createAudioPlayer(): AudioPlayer

Creates an AudioPlayer instance in synchronous mode.

NOTE

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

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Return value

Example

let audioPlayer: media.AudioPlayer = media.createAudioPlayer();

media.createVideoPlayer^(deprecated)

createVideoPlayer(callback: AsyncCallback<VideoPlayer>): void

Creates a VideoPlayer instance. 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 createAVPlayer instead.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

import { BusinessError } from '@ohos.base';

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

media.createVideoPlayer^(deprecated)

createVideoPlayer(): Promise<VideoPlayer>

Creates a VideoPlayer instance. 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 createAVPlayer instead.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Return value

Example

import { BusinessError } from '@ohos.base';

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

media.createAudioRecorder^(deprecated)

createAudioRecorder(): AudioRecorder

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

NOTE

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

System capability: SystemCapability.Multimedia.Media.AudioRecorder

Return value

Example

let audioRecorder: media.AudioRecorder = media.createAudioRecorder();

MediaErrorCode^(deprecated)

Enumerates the media error codes.

NOTE

This enum is supported since API version 8 and deprecated since API version 11. You are advised to use Media Error Codes instead.

System capability: SystemCapability.Multimedia.Media.Core

AudioPlayer^(deprecated)

NOTE

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

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

Attributes^(deprecated)

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Name	Type	Readable	Writable	Description
src	string	Yes	Yes	Audio file URI. The mainstream audio formats (M4A, AAC, MP3, OGG, and WAV) 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
fdSrc9+	AVFileDescriptor	Yes	Yes	Description of the audio file. This attribute 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	Yes	Yes	Whether to loop audio playback. The value true means to loop audio playback, and false means the opposite.
audioInterruptMode9+	audio.InterruptMode	Yes	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 success');
});
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 success');
});
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 success');
});
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 success');
});
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

Example

audioPlayer.on('timeUpdate', (seekDoneTime: number) => {    // Set the 'timeUpdate' event callback.
  if (seekDoneTime == null) {
    console.error('audio seek fail');
    return;
  }
  console.info('audio seek success. 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

Example

audioPlayer.on('volumeChange', () => {    // Set the 'volumeChange' event callback.
  console.info('audio volumeChange success');
});
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. This API uses an asynchronous callback to return the result. It can be called only after the 'dataLoad' event is triggered.

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

Example

import { BusinessError } from '@ohos.base';

audioPlayer.getTrackDescription((error: BusinessError, arrList: Array<media.MediaDescription>) => {
  if (arrList != null) {
    console.info('audio getTrackDescription success');
  } else {
    console.error(`audio getTrackDescription fail, error:${error}`);
  }
});

getTrackDescription^(deprecated)

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.

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

Example

import { BusinessError } from '@ohos.base';

audioPlayer.getTrackDescription().then((arrList: Array<media.MediaDescription>) => {
  console.info('audio getTrackDescription success');
}).catch((error: BusinessError) => {
  console.error(`audio catchCallback, 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

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)

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

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

Example

import fs from '@ohos.file.fs';
import { BusinessError } from '@ohos.base';

let audioPlayer: media.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: number) => {  // Set the 'timeUpdate' event callback.
  if (seekDoneTime == null) {
    console.error('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: 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';
fs.open(path).then((file) => {
  fdPath = fdPath + '' + file.fd;
  console.info('open fd success fd is' + fdPath);
  audioPlayer.src = fdPath;  // Set the src attribute and trigger the 'dataLoad' event callback.
}, (err: BusinessError) => {
  console.error('open fd failed err is' + err);
}).catch((err: BusinessError) => {
  console.error('open fd failed 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

Example

audioPlayer.on('timeUpdate', (newTime: number) => {    // Set the 'timeUpdate' event callback.
  if (newTime == null) {
    console.error('audio timeUpadate fail');
    return;
  }
  console.info('audio timeUpadate success. 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 in 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

Example

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

audioPlayer.on('audioInterrupt', (info: audio.InterruptEvent) => {
  console.info('audioInterrupt success,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

Example

import { BusinessError } from '@ohos.base';

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.

AudioState^(deprecated)

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

NOTE

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

System capability: SystemCapability.Multimedia.Media.AudioPlayer

VideoPlayer^(deprecated)

NOTE

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

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

Attributes

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Name	Type	Readable	Writable	Description
url8+	string	Yes	Yes	Video URL. The mainstream video formats (MP4, MPEG-TS, and MKV) 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 5. File type: file://xx NOTE WebM is no longer supported since API version 11.
fdSrc9+	AVFileDescriptor	Yes	Yes	Description of a video file. This attribute is required when video 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: Video 1 (address offset: 0, byte length: 100) Video 2 (address offset: 101; byte length: 50) Video 3 (address offset: 151, byte length: 150) 1. To play video 1: AVFileDescriptor {fd = resource handle; offset = 0; length = 100; } 2. To play video 2: AVFileDescriptor {fd = resource handle; offset = 101; length = 50; } 3. To play video 3: AVFileDescriptor {fd = resource handle; offset = 151; length = 150; } To play an independent video file, use src=fd://xx.
loop8+	boolean	Yes	Yes	Whether to loop video playback. The value true means to loop video playback, and false means the opposite.
videoScaleType9+	VideoScaleType	Yes	Yes	Video scale type. The default value is VIDEO_SCALE_TYPE_FIT.
audioInterruptMode9+	audio.InterruptMode	Yes	Yes	Audio interruption mode.
currentTime8+	number	Yes	No	Current video playback position, in ms.
duration8+	number	Yes	No	Video duration, in ms. The value -1 indicates the live mode.
state8+	VideoPlayState	Yes	No	Video playback state.
width8+	number	Yes	No	Video width, in px.
height8+	number	Yes	No	Video height, in px.

setDisplaySurface^(deprecated)

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

Sets SurfaceId. This API uses an asynchronous callback to return the result.

*Note: SetDisplaySurface must be called between the URL setting and the calling of prepare. A surface must be set for video streams without audio. Otherwise, the calling of prepare fails.

NOTE

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

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

import { BusinessError } from '@ohos.base';

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

setDisplaySurface^(deprecated)

setDisplaySurface(surfaceId: string): Promise<void>

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

*Note: SetDisplaySurface must be called between the URL setting and the calling of prepare. A surface must be set for video streams without audio. Otherwise, the calling of prepare fails.

NOTE

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

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';

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

prepare^(deprecated)

prepare(callback: AsyncCallback<void>): void

Prepares for video playback. 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.prepare instead.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

import { BusinessError } from '@ohos.base';

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

prepare^(deprecated)

prepare(): Promise<void>

Prepares for video playback. 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.prepare instead.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Return value

Example

import { BusinessError } from '@ohos.base';

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

play^(deprecated)

play(callback: AsyncCallback<void>): void

Starts to play video assets. 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.play instead.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Parameters

Example

import { BusinessError } from '@ohos.base';

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

play^(deprecated)

play(): Promise<void>

Starts to play video assets. 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.play instead.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Return value