Types

NOTE

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

AVSessionType¹⁰⁺

type AVSessionType = 'audio'|'video'|'voice_call'|'video_call'

Defines the session type supported by the session.

You can use the strings listed in the following table.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.Multimedia.AVSession.Core

Type	Description
'audio'	Audio session.
'video'	Video session.
'voice_call'¹¹⁺	Voice call.
'video_call'¹²⁺	Video call.

AVCastControlCommandType¹⁰⁺

Defines the commands that can be sent by a cast controller.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Type	Description
'play'	Play the media. No parameter is required.
'pause'	Pause the playback. No parameter is required.
'stop'	Stop the playback. No parameter is required.
'playNext'	Play the next media asset. No parameter is required.
'playPrevious'	Play the previous media asset. No parameter is required.
'fastForward'	Fast-forward. No parameter is required.
'rewind'	Rewind. No parameter is required.
'seek'	Seek to a playback position. The corresponding parameter is of the number type.
'setVolume'	Set the volume. The corresponding parameter is of the number type. You can use AVPlaybackState.maxVolume to obtain the maximum system volume.
'setSpeed'	Set the playback speed. The corresponding parameter is media.PlaybackSpeed.
'setLoopMode'	Set the loop mode. The corresponding parameter is LoopMode.
'toggleFavorite'	Favorite the media asset. The corresponding parameter is AVMetadata.assetId.
'toggleMute'	Set the muted status. No parameter is required.

ExtraInfo¹⁸⁺

type ExtraInfo = Record<string, Object>

Defines the custom media packet set by the provider.

System capability: SystemCapability.Multimedia.AVSession.Core

Type	Description
Record<string, Object>	key specifies the remote distributed event type. Currently, the following event types are supported: AUDIO_GET_VOLUME: obtains the volume of the remote device. AUDIO_GET_AVAILABLE_DEVICES: obtains all remote devices that can be connected. AUDIO_GET_PREFERRED_OUTPUT_DEVICE_FOR_RENDERER_INFO: obtains the actual remote audio device. The provider returns the corresponding media packet object based on the event type.

Type

Description

Record<string, Object>

key specifies the remote distributed event type. Currently, the following event types are supported:
AUDIO_GET_VOLUME: obtains the volume of the remote device.
AUDIO_GET_AVAILABLE_DEVICES: obtains all remote devices that can be connected.
AUDIO_GET_PREFERRED_OUTPUT_DEVICE_FOR_RENDERER_INFO: obtains the actual remote audio device.
The provider returns the corresponding media packet object based on the event type.

KeyRequestCallback¹²⁺

type KeyRequestCallback = (assetId: string, requestData: Uint8Array) => void

Defines the callback invoked for the media key request event.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
assetId	string	Yes	Media asset ID.
requestData	Uint8Array	Yes	Data carried in the media key request.

Example

let keyRequestCallback: avSession.KeyRequestCallback = async(assetId: string, requestData: Uint8Array) => {
  console.info(`Succeeded in keyRequestCallback. assetId: ${assetId}, requestData: ${requestData}`);
}

AVControlCommandType¹⁰⁺

Defines the commands that can be sent to a session.

You can use the union of the strings listed in the following table.

System capability: SystemCapability.Multimedia.AVSession.Core

Type	Description
'play'	Play the media. No parameter is required. Atomic service API: This API can be used in atomic services since API version 12.
'pause'	Pause the playback. No parameter is required. Atomic service API: This API can be used in atomic services since API version 12.
'stop'	Stop the playback. No parameter is required. Atomic service API: This API can be used in atomic services since API version 12.
'playNext'	Play the next media asset. No parameter is required. Atomic service API: This API can be used in atomic services since API version 12.
'playPrevious'	Play the previous media asset. No parameter is required. Atomic service API: This API can be used in atomic services since API version 12.
'fastForward'	Fast-forward. For details about the corresponding parameters, see SkipIntervals. Atomic service API: This API can be used in atomic services since API version 12.
'rewind'	Rewind. For details about the corresponding parameters, see SkipIntervals. Atomic service API: This API can be used in atomic services since API version 12.
'seek'	Seek to a playback position. The corresponding parameter is of the number type. Atomic service API: This API can be used in atomic services since API version 12.
'setSpeed'	Set the playback speed. The corresponding parameter is of the number type. Atomic service API: This API can be used in atomic services since API version 12.
'setLoopMode'	Set the loop mode. The corresponding parameter is LoopMode. Atomic service API: This API can be used in atomic services since API version 12.
'setTargetLoopMode' ¹⁸⁺	Set the target loop mode. The recommended parameter is LoopMode. Atomic service API: This API can be used in atomic services since API version 18.
'toggleFavorite'	Favorite the media asset. The corresponding parameter is AVMetadata.assetId. Atomic service API: This API can be used in atomic services since API version 12.
'playFromAssetId' ¹¹⁺	Play the media asset with the specified asset ID. Atomic service API: This API can be used in atomic services since API version 12.
'playWithAssetId' ²⁰⁺	Play the media asset with the specified asset ID. The corresponding parameter is AVMetadata.assetId. The string length must be less than 40960 bytes. Atomic service API: This API can be used in atomic services since API version 20.
'answer' ¹¹⁺	Answer a call. No parameter is required. Atomic service API: This API can be used in atomic services since API version 12.
'hangUp' ¹¹⁺	The call is disconnecting. No parameter is required. Atomic service API: This API can be used in atomic services since API version 12.
'toggleCallMute' ¹¹⁺	Set the mute status for a call. No parameter is required. Atomic service API: This API can be used in atomic services since API version 12.