Interface (AVCastController)

After a casting connection is set up, you can call avSession.getAVCastController to obtain the cast controller. Through the controller, you can query the session ID, send commands and events to a session, and obtain session metadata and playback state information.

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.

The initial APIs of this interface are supported since API version 10.

Modules to Import

import { avSession } from '@kit.AVSessionKit';

getAVPlaybackState¹⁰⁺

getAVPlaybackState(callback: AsyncCallback<AVPlaybackState>): void

Obtains the remote playback state. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<AVPlaybackState>	Yes	Callback used to return the remote playback state.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.

Example

avCastController.getAVPlaybackState((state: avSession.AVPlaybackState) => {
  console.info('Succeeded in getting AV playback state.');
});

getAVPlaybackState¹⁰⁺

getAVPlaybackState(): Promise<AVPlaybackState>

Obtains the remote playback state. This API uses a promise to return the result.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Return value

Type	Description
Promise<AVPlaybackState>	Promise used to return the remote playback state.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.

Example



avCastController.getAVPlaybackState().then((state: avSession.AVPlaybackState) => {
  console.info('Succeeded in getting AV playback state.');
});

getSupportedDecoders¹⁹⁺

getSupportedDecoders(): Promise<Array<DecoderType>>

Obtains the decoding modes supported by the current remote device. This API uses a promise to return the result.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Return value

Type	Description
Promise<Array<DecoderType>>	Promise used to return an array of decoding modes supported by the remote device.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.

Example



avCastController.getSupportedDecoders().then((decoderTypes: avSession.DecoderType[]) => {
  console.info(`Succeeded in getting supported decoders, length: ${decoderTypes.length}`);
  if (decoderTypes.length > 0 ) {
    console.info(`Succeeded in getting supported decoder: ${decoderTypes[0]}`);
  }
});

getRecommendedResolutionLevel¹⁹⁺

getRecommendedResolutionLevel(decoderType: DecoderType): Promise<ResolutionLevel>

Obtains the recommended resolution level based on the passed decoding mode. This API uses a promise to return the result.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
decoderType	DecoderType	Yes	Decoding format supported by the device. The following decoding formats are supported by the device: 'OH_AVCODEC_MIMETYPE_VIDEO_AVC': VIDEO AVC. 'OH_AVCODEC_MIMETYPE_VIDEO_HEVC': VIDEO HEVC. 'OH_AVCODEC_MIMETYPE_AUDIO_VIVID': AUDIO AV3A.

Return value

Type	Description
Promise<ResolutionLevel>	Promise used to return the recommended resolution level of the remote device.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.

Example



let decoderType = avSession.DecoderType.OH_AVCODEC_MIMETYPE_VIDEO_AVC;
avCastController.getRecommendedResolutionLevel(decoderType).then((resolutionLevel: avSession.ResolutionLevel) => {
  console.info('Succeeded in getting recommended resolution level.');
});

getSupportedHdrCapabilities¹⁹⁺

getSupportedHdrCapabilities(): Promise<Array<hdrCapability.HDRFormat>>

Obtains the HDR capabilities supported by the current remote device. This API uses a promise to return the result.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Return value

Type	Description
Promise<Array<hdrCapability.HDRFormat>>	Promise used to return an array of HDR capabilities supported by the remote device.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.

Example


import type hdrCapability from './@ohos.graphics.hdrCapability';

avCastController.getSupportedHdrCapabilities().then((hdrFormats: hdrCapability.HDRFormat[]) => {
  console.info(`Succeeded in getting supported HDR capabilities, length: ${hdrFormats.length}`);
  if (hdrFormats.length > 0 ) {
    console.info(`Succeeded in getting supported HDR capability: ${hdrFormats[0]}`);
  }
});

getSupportedPlaySpeeds¹⁹⁺

getSupportedPlaySpeeds(): Promise<Array<number>>

Obtains the playback speeds supported by the remote device. This API is only supported for devices connected using the Cast+ protocol. This API uses a promise to return the result.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Return value

Type	Description
Promise<Array<number>>	Promise used to return an array of playback speeds supported by the remote device.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.

Example



avCastController.getSupportedPlaySpeeds().then((nums: number[]) => {
  console.info(`Succeeded in getting supported play speeds, length: ${nums.length}`);
  if (nums.length > 0 ) {
    console.info(`Succeeded in getting supported play speed: ${nums[0]}`);
  }
});

sendControlCommand¹⁰⁺

sendControlCommand(command: AVCastControlCommand): Promise<void>

Sends a control command to the session through the controller. This API uses a promise to return the result.

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
command	AVCastControlCommand	Yes	Command to send.

Return value

Type	Description
Promise<void>	Promise used to return the result. If the command is sent, no value is returned; otherwise, an error object is returned.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception.
6600105	Invalid session command.
6600109	The remote connection is not established.

Example



let avCommand: avSession.AVCastControlCommand = {command:'play'};
avCastController.sendControlCommand(avCommand).then(() => {
  console.info('Succeeded in sending control command.');
});

sendControlCommand¹⁰⁺

sendControlCommand(command: AVCastControlCommand, callback: AsyncCallback<void>): void

Sends a control command to the session through the controller. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
command	AVCastControlCommand	Yes	Command to send.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the command is sent, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception.
6600105	Invalid session command.
6600109	The remote connection is not established.

Example



let avCommand: avSession.AVCastControlCommand = {command:'play'};
avCastController.sendControlCommand(avCommand, () => {
  console.info('Succeeded in sending control command.');
});

sendCustomData²⁰⁺

sendCustomData(data: Record<string, Object>): Promise<void>

Sends custom data to the remote device. This API uses a promise to return the result.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
data	Record<string, Object>	Yes	Custom data filled by the application. The server processes only the key 'customData' when the associated value is a string object.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.You are advised to:1.Scheduled retry.2.Destroy the current session or session controller and re-create it.

Example



avCastController.sendCustomData({customData : "This is custom data"});

prepare¹⁰⁺

prepare(item: AVQueueItem, callback: AsyncCallback<void>): void

Prepares for the playback of a media asset, that is, loads and buffers a media asset. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
item	AVQueueItem	Yes	Properties of an item in the playlist.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the command is sent, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception.
6600109	The remote connection is not established.

Example



// Set playback parameters.
let playItem: avSession.AVQueueItem = {
  itemId: 0,
  description: {
    assetId: '12345',
    mediaType: 'AUDIO',
    mediaUri: 'http://resource1_address',
    mediaSize: 12345,
    startPosition: 0,
    duration: 0,
    artist: 'mysong',
    albumTitle: 'song1_title',
    albumCoverUri: "http://resource1_album_address",
    lyricUri: "http://resource1_lyric_address",
    appName: 'MyMusic'
  }
};
// Prepare for playback. This operation triggers loading and buffering, but not the actual playback.
avCastController.prepare(playItem, () => {
  console.info('Succeeded in preparing.');
});

prepare¹⁰⁺

prepare(item: AVQueueItem): Promise<void>

Prepares for the playback of a media asset, that is, loads and buffers a media asset. This API uses a promise to return the result.

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
item	AVQueueItem	Yes	Properties of an item in the playlist.

Return value

Type	Description
Promise<void>	Promise used to return the result. If the command is sent, no value is returned; otherwise, an error object is returned.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception.
6600109	The remote connection is not established.

Example



// Set playback parameters.
let playItem: avSession.AVQueueItem = {
  itemId: 0,
  description: {
    assetId: '12345',
    mediaType: 'AUDIO',
    mediaUri: 'http://resource1_address',
    mediaSize: 12345,
    startPosition: 0,
    duration: 0,
    artist: 'mysong',
    albumTitle: 'song1_title',
    albumCoverUri: "http://resource1_album_address",
    lyricUri: "http://resource1_lyric_address",
    appName: 'MyMusic'
  }
};
// Prepare for playback. This operation triggers loading and buffering, but not the actual playback.
avCastController.prepare(playItem).then(() => {
  console.info('Succeeded in preparing.');
});

start¹⁰⁺

start(item: AVQueueItem, callback: AsyncCallback<void>): void

Prepares for the playback of a media asset. This API uses an asynchronous callback to return the result.

NOTE

In the audio and video casting scenario, when the application sequentially calls the prepare and start APIs and the asset ID remains unchanged, if a valid mediaUri or fdSrc is passed to the prepare API, the start API will reuse the complete AVMediaDescription object information in the prepare phase.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
item	AVQueueItem	Yes	Properties of an item in the playlist.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the command is sent, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception.
6600109	The remote connection is not established.

Example



// Set playback parameters.
let playItem: avSession.AVQueueItem = {
  itemId: 0,
  description: {
    assetId: '12345',
    mediaType: 'AUDIO',
    mediaUri: 'http://resource1_address',
    mediaSize: 12345,
    startPosition: 0,
    duration: 0,
    artist: 'mysong',
    albumTitle: 'song1_title',
    albumCoverUri: "http://resource1_album_address",
    lyricUri: "http://resource1_lyric_address",
    appName: 'MyMusic'
  }
};

// Start playback.
avCastController.start(playItem, () => {
  console.info('Succeeded in starting.');
});

start¹⁰⁺

start(item: AVQueueItem): Promise<void>

Prepares for the playback of a media asset. This API uses a promise to return the result.

NOTE

In the audio and video casting scenario, when the application sequentially calls the prepare and start APIs and the asset ID remains unchanged, if a valid mediaUri or fdSrc is passed to the prepare API, the start API will reuse the complete AVMediaDescription object information in the prepare phase.

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
item	AVQueueItem	Yes	Properties of an item in the playlist.

Return value

Type	Description
Promise<void>	Promise used to return the result. If the command is sent, no value is returned; otherwise, an error object is returned.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception.
6600109	The remote connection is not established.

Example



// Set playback parameters.
let playItem: avSession.AVQueueItem = {
  itemId: 0,
  description: {
    assetId: '12345',
    mediaType: 'AUDIO',
    mediaUri: 'http://resource1_address',
    mediaSize: 12345,
    startPosition: 0,
    duration: 0,
    artist: 'mysong',
    albumTitle: 'song1_title',
    albumCoverUri: "http://resource1_album_address",
    lyricUri: "http://resource1_lyric_address",
    appName: 'MyMusic'
  }
};
// Start playback.
avCastController.start(playItem).then(() => {
  console.info('Succeeded in starting.');
});

getCurrentItem¹⁰⁺

getCurrentItem(callback: AsyncCallback<AVQueueItem>): void

Obtains the information about the media asset that is being played. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<AVQueueItem>	Yes	Callback used to return the result. If the command is sent, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.

Example

avCastController.getCurrentItem((value: avSession.AVQueueItem) => {
  console.info('Succeeded in getting current item.');
});

getCurrentItem¹⁰⁺

getCurrentItem(): Promise<AVQueueItem>

Obtains the information about the media asset that is being played. This API uses a promise to return the result.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Return value

Type	Description
Promise<AVQueueItem>	Promise used to return the media asset obtained. If the operation fails, an error object is returned.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.

Example



avCastController.getCurrentItem().then((value: avSession.AVQueueItem) => {
  console.info('Succeeded in getting current item.');
});

getValidCommands¹¹⁺

getValidCommands(callback: AsyncCallback<Array<AVCastControlCommandType>>): void

Obtains the supported commands. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Array<AVCastControlCommandType>>	Yes	Callback used to return the supported commands.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.

Example

avCastController.getValidCommands((state: avSession.AVCastControlCommandType[]) => {
  console.info('Succeeded in getting valid commands.');
});

getValidCommands¹¹⁺

getValidCommands(): Promise<Array<AVCastControlCommandType>>

Obtains the supported commands. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Return value

Type	Description
Promise<Array<AVCastControlCommandType>>	Promise used to return the supported commands.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.

Example



avCastController.getValidCommands().then((state: avSession.AVCastControlCommandType[]) => {
  console.info('Succeeded in getting valid commands.');
});

processMediaKeyResponse¹²⁺

processMediaKeyResponse(assetId: string, response: Uint8Array): Promise<void>

Processes the response to a media key request during online DRM resource projection. This API uses a promise to return the result.

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.
response	Uint8Array	Yes	Response to the media key request.

Return value

Type	Description
Promise<void>	Promise used to return the result. If the response is processed successfully, no result is returned. Otherwise, an error object is returned.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception.

Example

let keyRequestCallback: avSession.KeyRequestCallback = async(assetId: string, requestData: Uint8Array) => {
  // Obtain the DRM URL based on the asset ID.
  let drmUrl = 'http://license.xxx.xxx.com:8080/drmproxy/getLicense';
  // Obtain a media key from the server. Assign a value based on service requirements.
  let licenseResponseData: Uint8Array = new Uint8Array();
  console.info(`Succeeded in get license by ${drmUrl}.`);
  avCastController.processMediaKeyResponse(assetId, licenseResponseData);
}

release¹¹⁺

release(callback: AsyncCallback<void>): void

Releases this cast controller. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the controller is released, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.

Example



avCastController.release(() => {
  console.info('Succeeded in releasing.');
});

release¹¹⁺

release(): Promise<void>

Releases this cast controller. This API uses a promise to return the result.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Return value

Type	Description
Promise<void>	Promise used to return the result. If the controller is released, no value is returned; otherwise, an error object is returned.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.

Example



avCastController.release().then(() => {
  console.info('Succeeded in releasing.');
});

on('playbackStateChange')¹⁰⁺

on(type: 'playbackStateChange', filter: Array<keyof AVPlaybackState> | 'all', callback: (state: AVPlaybackState) => void): void

Subscribes to playback state change events. This API uses an asynchronous callback to return the result.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

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
type	string	Yes	Event type. The event 'playbackStateChange' is triggered when the playback state changes.
filter	Array<keyof AVPlaybackState>\|'all'	Yes	The value 'all' indicates that any playback state field change will trigger the event, and Array<keyof AVPlaybackstate> indicates that only changes to the listed playback state field will trigger the event.
callback	(state: AVPlaybackState) => void	Yes	Callback function, where the state parameter indicates the new playback state.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.on('playbackStateChange', 'all', (playbackState: avSession.AVPlaybackState) => {
  console.info(`on playbackStateChange state : ${playbackState.state}`);
});

let playbackFilter: Array<keyof avSession.AVPlaybackState> = ['state', 'speed', 'loopMode'];
avCastController.on('playbackStateChange', playbackFilter, (playbackState: avSession.AVPlaybackState) => {
  console.info(`on playbackStateChange state : ${playbackState.state}`);
});

off('playbackStateChange')¹⁰⁺

off(type: 'playbackStateChange', callback?: (state: AVPlaybackState) => void): void

Unsubscribes from playback state change events. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

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
type	string	Yes	Event type, which is 'playbackStateChange' in this case.
callback	(state: AVPlaybackState) => void	No	Callback function, where the state parameter indicates the new playback state. The callback parameter is optional. If it is not specified, all the subscriptions to the specified event are canceled for this session.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.off('playbackStateChange');

on('mediaItemChange')¹⁰⁺

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

Subscribes to media asset change events. This API uses an asynchronous callback to return the result.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

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
type	string	Yes	Event type. The event 'mediaItemChange' is triggered when the media content being played changes.
callback	Callback<AVQueueItem>	Yes	Callback function, where the AVQueueItem parameter specifies the media asset that is being played.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.on('mediaItemChange', (item: avSession.AVQueueItem) => {
  console.info(`on mediaItemChange state : ${item.itemId}`);
});

off('mediaItemChange')¹⁰⁺

off(type: 'mediaItemChange'): void

Unsubscribes from media asset change events. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

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
type	string	Yes	Event type, which is 'mediaItemChange' in this case.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.off('mediaItemChange');

on('playNext')¹⁰⁺

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

Subscribes to playNext command events.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

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
type	string	Yes	Event type. The event 'playNext' is triggered when the command for playing the next item is received.
callback	Callback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.on('playNext', () => {
  console.info('on playNext');
});

off('playNext')¹⁰⁺

off(type: 'playNext'): void

Unsubscribes from playNext command events. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

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
type	string	Yes	Event type, which is 'playNext' in this case.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.off('playNext');

on('playPrevious')¹⁰⁺

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

Subscribes to playPrevious command events.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

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
type	string	Yes	Event type. The event 'playPrevious' is triggered when the command for playing the previous event is received.
callback	Callback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.on('playPrevious', () => {
  console.info('on playPrevious');
});

off('playPrevious')¹⁰⁺

off(type: 'playPrevious'): void

Unsubscribes from playPrevious command events. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

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
type	string	Yes	Event type, which is 'playPrevious' in this case.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.off('playPrevious');

on('requestPlay')¹¹⁺

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

Subscribes to playback request events.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'requestPlay' is triggered when a playback request is received.
callback	Callback<AVQueueItem>	Yes	Callback function, where the AVQueueItem parameter specifies the media asset that is being played. If the subscription is successful, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.on('requestPlay', (item: avSession.AVQueueItem) => {
  console.info(`on requestPlay state : ${item.itemId}`);
});

off('requestPlay')¹¹⁺

off(type: 'requestPlay', callback?: Callback<AVQueueItem>): void

Unsubscribes from playback request events. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'requestPlay' in this case.
callback	Callback<AVQueueItem>	No	Callback function, where the AVQueueItem parameter specifies the media asset that is being played. If the unsubscription is successful, err is undefined; otherwise, err is an error object. The callback parameter is optional. If it is not specified, all the subscriptions to the specified event are canceled for this session.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.off('requestPlay');

on('endOfStream')¹¹⁺

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

Subscribes to playback end events.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'endOfStream' is triggered when the playback operation is complete.
callback	Callback<void>	Yes	Callback used for subscription. If the subscription is successful, err is undefined; otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.on('endOfStream', () => {
  console.info('on endOfStream');
});

off('endOfStream')¹¹⁺

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

Unsubscribes from the playback end events. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'endOfStream' in this case.
callback	Callback<void>	No	Callback used for unsubscription. If the unsubscription is successful, err is undefined; otherwise, err is an error object. The callback parameter is optional. If it is not specified, all the subscriptions to the specified event are canceled for this session.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.off('endOfStream');

on('seekDone')¹⁰⁺

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

Subscribes to seek done events.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

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
type	string	Yes	Event type. The event 'seekDone' is triggered when the seek operation is complete.
callback	Callback<number>	Yes	Callback used to return the position after the seek operation.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.on('seekDone', (pos: number) => {
  console.info(`on seekDone pos: ${pos} `);
});

off('seekDone')¹⁰⁺

off(type: 'seekDone'): void

Unsubscribes from the seek done events. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

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
type	string	Yes	Event type, which is 'seekDone' in this case.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.off('seekDone');

on('validCommandChange')¹¹⁺

on(type: 'validCommandChange', callback: Callback<Array<AVCastControlCommandType>>)

Subscribes to valid command change events.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'validCommandChange' is triggered when the valid commands supported by the session changes.
callback	Callback<Array<AVCastControlCommandType>>	Yes	Callback used for subscription. The commands parameter in the callback is a set of valid commands.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified.2.Incorrect parameter types.
6600101	Session service exception.
6600103	The session controller does not exist.

Example

avCastController.on('validCommandChange', (validCommands: avSession.AVCastControlCommandType[]) => {
  console.info(`Succeeded in valid command change, size: ${validCommands.length}`);
  console.info(`Succeeded in valid command change, validCommands: ${validCommands.values()}`);
});

off('validCommandChange')¹¹⁺

off(type: 'validCommandChange', callback?: Callback<Array<AVCastControlCommandType>>)

Unsubscribes from valid command change events. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'validCommandChange' in this case.
callback	Callback<Array<AVCastControlCommandType>>	No	Callback used for unsubscription. The commands parameter in the callback is a set of valid commands. The callback parameter is optional. If it is not specified, all the subscriptions to the specified event are canceled for this session.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified.2.Incorrect parameter types.
6600101	Session service exception.
6600103	The session controller does not exist.

Example

avCastController.off('validCommandChange');

on('videoSizeChange')¹²⁺

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

Subscribes to video size change events.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'videoSizeChange' is triggered when the valid commands supported by the session changes.
callback	(width: number, height: number) => void	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.on('videoSizeChange', (width: number, height: number) => {
  console.info(`Succeeded in video size change, size: ${width}, ${height}`);
});

off('videoSizeChange')¹²⁺

off(type: 'videoSizeChange'): void

Unsubscribes from video size change events. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'videoSizeChange' is triggered when the valid commands supported by the session changes.

Error codes

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

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.off('videoSizeChange');

on('error')¹⁰⁺

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

Subscribes to remote player errors. This event is used only for error prompt and does not require the user to stop playback control.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

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
type	string	Yes	Event type, which is 'error' in this case. This event can be triggered by both user operations and the system.
callback	ErrorCallback	Yes	Callback used to return the error code ID and error message.

Error codes

For details about the error codes, see Universal Error Codes, Media Error Codes, and AVSession Management Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
5400101	No memory.
5400102	Operation not allowed.
5400103	I/O error.
5400104	Time out.
5400105	Service died.
5400106	Unsupport format.
6600101	Session service exception.

Example

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

avCastController.on('error', (error: BusinessError) => {
  console.info(`error happened, error code: ${error.code}, error message : ${error.message}.`)
})

off('error')¹⁰⁺

off(type: 'error'): void

Unsubscribes from remote player errors. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

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
type	string	Yes	Event type, which is 'error' in this case.

Error codes

For details about the error codes, see Universal Error Codes, Media Error Codes, and AVSession Management Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
5400101	No memory.
5400102	Operation not allowed.
5400103	I/O error.
5400104	Time out.
5400105	Service died.
5400106	Unsupport format.
6600101	Session service exception.

Example

avCastController.off('error')

on('keyRequest')¹²⁺

on(type: 'keyRequest', callback: KeyRequestCallback): void

Subscribes to media key requests during the cast of online DRM resources.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

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
type	string	Yes	Event type. The event 'keyRequest' is triggered when a media key request is required during the cast of online DRM resources.
callback	KeyRequestCallback	Yes	Callback used to request the media resources and media key.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

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

off('keyRequest')¹²⁺

off(type: 'keyRequest', callback?: KeyRequestCallback): void

Unsubscribes from media key requests during the cast of online DRM resources. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

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
type	string	Yes	Event type, which is 'keyRequest' in this case.
callback	KeyRequestCallback	No	Callback used for unsubscription. If the unsubscription is successful, err is undefined; otherwise, err is an error object. The callback parameter is optional. If it is not specified, all the subscriptions to the specified event are canceled for this session.

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avCastController.off('keyRequest');

on('castControlGenericError')¹³⁺

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

Subscribes to generic error events during cast control.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

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

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
6611000	The error code for cast control is unspecified.
6611001	An unspecified error occurs in the remote player.
6611002	The playback position falls behind the live window.
6611003	The process of cast control times out.
6611004	The runtime check failed.
6611100	Cross-device data transmission is locked.
6611101	The specified seek mode is not supported.
6611102	The position to seek to is out of the range of the media asset or the specified seek mode is not supported.
6611103	The specified playback mode is not supported.
6611104	The specified playback speed is not supported.
6611105	The action failed because either the media source device or the media sink device has been revoked.
6611106	The parameter is invalid, for example, the url is illegal to play.
6611107	Allocation of memory failed.
6611108	Operation is not allowed.

Example

avCastController.on('castControlGenericError', (error: BusinessError) => {
  console.info(`castControlGenericError happened, error code: ${error.code}, error message : ${error.message}.`)
})

off('castControlGenericError')¹³⁺

off(type: 'castControlGenericError', callback?: ErrorCallback): void

Unsubscribes from generic error events during cast control. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'castControlGenericError' in this case.
callback	ErrorCallback	No	Callback used for unsubscription. If the unsubscription is successful, err is undefined; otherwise, err is an error object. The callback parameter is optional. If it is not specified, all the subscriptions to the specified event are canceled for this session.

Error codes

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

ID	Error Message
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.

Example

avCastController.off('castControlGenericError');

on('castControlIoError')¹³⁺

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

Subscribes to input/output error events during cast control.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

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

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
6612000	An unspecified input/output error occurs.
6612001	Network connection failure.
6612002	Network timeout.
6612003	Invalid "Content-Type" HTTP header.
6612004	The HTTP server returns an unexpected HTTP response status code.
6612005	The file does not exist.
6612006	No permission is granted to perform the IO operation.
6612007	Access to cleartext HTTP traffic is not allowed by the app's network security configuration.
6612008	Reading data out of the data bound.
6612100	The media does not contain any contents that can be played.
6612101	The media cannot be read, for example, because of dust or scratches.
6612102	This resource is already in use.
6612103	The content using the validity interval has expired.
6612104	Using the requested content to play is not allowed.
6612105	The use of the allowed content cannot be verified.
6612106	The number of times this content has been used as requested has reached the maximum allowed number of uses.
6612107	An error occurs when sending packet from source device to sink device.

Example

avCastController.on('castControlIoError', (error: BusinessError) => {
  console.info(`castControlIoError happened, error code: ${error.code}, error message : ${error.message}.`)
})

off('castControlIoError')¹³⁺

off(type: 'castControlIoError', callback?: ErrorCallback): void

Unsubscribes from input/output error events during cast control. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'castControlIoError' in this case.
callback	ErrorCallback	No	Callback used for unsubscription. If the unsubscription is successful, err is undefined; otherwise, err is an error object. The callback parameter is optional. If it is not specified, all the subscriptions to the specified event are canceled for this session.

Error codes

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

ID	Error Message
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.

Example

avCastController.off('castControlIoError');

on('castControlParsingError')¹³⁺

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

Subscribes to parsing error events during cast control.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

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

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
6613000	Unspecified error related to content parsing.
6613001	Parsing error associated with media container format bit streams.
6613002	Parsing error associated with the media manifest.
6613003	An error occurs when attempting to extract a file with an unsupported media container format or an unsupported media container feature.
6613004	Unsupported feature in the media manifest.

Example

avCastController.on('castControlParsingError', (error: BusinessError) => {
  console.info(`castControlParsingError happened, error code: ${error.code}, error message : ${error.message}.`)
})

off('castControlParsingError')¹³⁺

off(type: 'castControlParsingError', callback?: ErrorCallback): void

Unsubscribes from parsing error events during cast control. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'castControlParsingError' in this case.
callback	ErrorCallback	No	Callback used for unsubscription. If the unsubscription is successful, err is undefined; otherwise, err is an error object. The callback parameter is optional. If it is not specified, all the subscriptions to the specified event are canceled for this session.

Error codes

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

ID	Error Message
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.

Example

avCastController.off('castControlParsingError');

on('castControlDecodingError')¹³⁺

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

Subscribes to decoding error events during cast control.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

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

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
6614000	Unspecified decoding error.
6614001	Decoder initialization failed.
6614002	Decoder query failed.
6614003	Decoding the media samples failed.
6614004	The format of the content to decode exceeds the capabilities of the device.
6614005	The format of the content to decode is not supported.

Example

avCastController.on('castControlDecodingError', (error: BusinessError) => {
  console.info(`castControlDecodingError happened, error code: ${error.code}, error message : ${error.message}.`)
})

off('castControlDecodingError')¹³⁺

off(type: 'castControlDecodingError', callback?: ErrorCallback): void

Unsubscribes from decoding error events during cast control. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'castControlDecodingError' in this case.
callback	ErrorCallback	No	Callback used for unsubscription. If the unsubscription is successful, err is undefined; otherwise, err is an error object. The callback parameter is optional. If it is not specified, all the subscriptions to the specified event are canceled for this session.

Error codes

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

ID	Error Message
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.

Example

avCastController.off('castControlDecodingError');

on('castControlAudioRendererError')¹³⁺

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

Subscribes to audio renderer error events during cast control.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

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

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
6615000	Unspecified errors related to the audio renderer.
6615001	Initializing the audio renderer failed.
6615002	The audio renderer fails to write data.

Example

avCastController.on('castControlAudioRendererError', (error: BusinessError) => {
  console.info(`castControlAudioRendererError happened, error code: ${error.code}, error message : ${error.message}.`)
})

off('castControlAudioRendererError')¹³⁺

off(type: 'castControlAudioRendererError', callback?: ErrorCallback): void

Unsubscribes from audio renderer error events during cast control. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'castControlAudioRendererError' in this case.
callback	ErrorCallback	No	Callback used for unsubscription. If the unsubscription is successful, err is undefined; otherwise, err is an error object. The callback parameter is optional. If it is not specified, all the subscriptions to the specified event are canceled for this session.

Error codes

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

ID	Error Message
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.

Example

avCastController.off('castControlAudioRendererError');

on('castControlDrmError')¹³⁺

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

Subscribes to DRM error events during cast control.

Multiple callbacks can be registered for this event. To ensure only the latest callback executes, unregister previous listeners first. Otherwise, all registered callbacks will fire on state changes.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

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

Error codes

For details about the error codes, see Universal Error Codes and AVSession Error Codes.

ID	Error Message
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
6616000	Unspecified error related to DRM.
6616001	The chosen DRM protection scheme is not supported by the device.
6616002	Device provisioning failed.
6616003	The DRM-protected content to play is incompatible.
6616004	Failed to obtain a license.
6616005	The operation is disallowed by the license policy.
6616006	An error occurs in the DRM system.
6616007	The device has revoked DRM privileges.
6616008	The DRM license being loaded into the open DRM session has expired.
6616100	An error occurs when the DRM processes the key response.

Example

avCastController.on('castControlDrmError', (error: BusinessError) => {
  console.info(`castControlDrmError happened, error code: ${error.code}, error message : ${error.message}.`)
})

off('castControlDrmError')¹³⁺

off(type: 'castControlDrmError', callback?: ErrorCallback): void

Unsubscribes from DRM error events during cast control. If a callback is specified, the corresponding listener is unregistered. If no callback is specified, all listeners for the specified event are unregistered.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'castControlDrmError' in this case.
callback	ErrorCallback	No	Callback used for unsubscription. If the unsubscription is successful, err is undefined; otherwise, err is an error object. The callback parameter is optional. If it is not specified, all the subscriptions to the specified event are canceled for this session.

Error codes

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

ID	Error Message
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.

Example

avCastController.off('castControlDrmError');

on('customDataChange')²⁰⁺

on(type: 'customDataChange', callback: Callback<Record<string, Object>>): void

Subscribes to events indicating that custom data is sent to a remote device.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'customDataChange' is triggered when the provider sends custom data.
callback	Callback<Record<string, Object>>	Yes	Callback used to receive the custom data.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.

Example

avCastController.on('customDataChange', (callback) => {
    console.info(`Caught customDataChange event,the new callback is: ${JSON.stringify(callback)}`);
});

off('customDataChange')²⁰⁺

off(type: 'customDataChange', callback?: Callback<Record<string, Object>>): void

Unsubscribes from events indicating that custom data is sent to a remote device.

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'customDataChange' in this case.
callback	Callback<Record<string, Object>>	No	Callback used for unsubscription. The callback parameter is optional. If it is not specified, all the subscriptions to the specified event are canceled for this session.

Error codes

For details about the error codes, see AVSession Management Error Codes.

ID	Error Message
6600101	Session service exception.

Example

avCastController.off('customDataChange');

Interface (AVCastController)

Modules to Import

getAVPlaybackState10+

getAVPlaybackState10+

getSupportedDecoders19+

getRecommendedResolutionLevel19+

getSupportedHdrCapabilities19+

getSupportedPlaySpeeds19+

sendControlCommand10+

sendControlCommand10+

sendCustomData20+

prepare10+

prepare10+

start10+

start10+

getCurrentItem10+

getCurrentItem10+

getValidCommands11+

getValidCommands11+

processMediaKeyResponse12+

release11+

release11+

on('playbackStateChange')10+

off('playbackStateChange')10+

on('mediaItemChange')10+

off('mediaItemChange')10+

on('playNext')10+

off('playNext')10+

on('playPrevious')10+

off('playPrevious')10+

on('requestPlay')11+

off('requestPlay')11+

on('endOfStream')11+

off('endOfStream')11+

on('seekDone')10+

off('seekDone')10+

on('validCommandChange')11+

off('validCommandChange')11+

on('videoSizeChange')12+

off('videoSizeChange')12+

on('error')10+

off('error')10+

on('keyRequest')12+

off('keyRequest')12+

on('castControlGenericError')13+

off('castControlGenericError')13+

on('castControlIoError')13+

off('castControlIoError')13+

on('castControlParsingError')13+

off('castControlParsingError')13+

on('castControlDecodingError')13+

off('castControlDecodingError')13+

on('castControlAudioRendererError')13+

off('castControlAudioRendererError')13+

on('castControlDrmError')13+

off('castControlDrmError')13+

on('customDataChange')20+

off('customDataChange')20+

getAVPlaybackState¹⁰⁺

getAVPlaybackState¹⁰⁺

getSupportedDecoders¹⁹⁺

getRecommendedResolutionLevel¹⁹⁺

getSupportedHdrCapabilities¹⁹⁺

getSupportedPlaySpeeds¹⁹⁺

sendControlCommand¹⁰⁺

sendControlCommand¹⁰⁺

sendCustomData²⁰⁺

prepare¹⁰⁺

prepare¹⁰⁺

start¹⁰⁺

start¹⁰⁺

getCurrentItem¹⁰⁺

getCurrentItem¹⁰⁺

getValidCommands¹¹⁺

getValidCommands¹¹⁺

processMediaKeyResponse¹²⁺

release¹¹⁺

release¹¹⁺

on('playbackStateChange')¹⁰⁺

off('playbackStateChange')¹⁰⁺

on('mediaItemChange')¹⁰⁺

off('mediaItemChange')¹⁰⁺

on('playNext')¹⁰⁺

off('playNext')¹⁰⁺

on('playPrevious')¹⁰⁺

off('playPrevious')¹⁰⁺

on('requestPlay')¹¹⁺

off('requestPlay')¹¹⁺

on('endOfStream')¹¹⁺

off('endOfStream')¹¹⁺

on('seekDone')¹⁰⁺

off('seekDone')¹⁰⁺

on('validCommandChange')¹¹⁺

off('validCommandChange')¹¹⁺

on('videoSizeChange')¹²⁺

off('videoSizeChange')¹²⁺

on('error')¹⁰⁺

off('error')¹⁰⁺

on('keyRequest')¹²⁺

off('keyRequest')¹²⁺

on('castControlGenericError')¹³⁺

off('castControlGenericError')¹³⁺

on('castControlIoError')¹³⁺

off('castControlIoError')¹³⁺

on('castControlParsingError')¹³⁺

off('castControlParsingError')¹³⁺

on('castControlDecodingError')¹³⁺

off('castControlDecodingError')¹³⁺

on('castControlAudioRendererError')¹³⁺

off('castControlAudioRendererError')¹³⁺

on('castControlDrmError')¹³⁺

off('castControlDrmError')¹³⁺

on('customDataChange')²⁰⁺

off('customDataChange')²⁰⁺