@ohos.multimedia.avsession (AVSession Management) (System API)

The AVSession module provides APIs for media playback control so that applications can access the system's Media Controller.

This module provides the following typical features related to media sessions:

AVCastController: used to control playback, listen for remote playback state changes, and obtain the remote playback state in casting scenarios.

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.

This topic describes only system APIs provided by the module. For details about its public APIs, see @ohos.multimedia.avsession (AVSession Management).

Modules to Import

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

Usage Guidelines

This topic describes only system APIs. Before using these APIs, you must create an instance. For details about how to create an instance, see the description and example of the public API avSession.createAVSession.

avSession.getAllSessionDescriptors

getAllSessionDescriptors(callback: AsyncCallback<Array<Readonly<AVSessionDescriptor>>>): void

Obtains the descriptors of all sessions that have been configured with media information and registered with the control callback. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES (available only to system applications)

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Array<Readonly<AVSessionDescriptor>>>	Yes	Callback used to return an array of AVSessionDescriptor objects, each of which is read only.

Error codes

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

ID	Error Message
201	permission denied.
202	Not System App.
6600101	Session service exception.

Example

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

@Entry 
@Component 
struct Index { 
  @State message: string = 'hello world'; 

  build() { 
    Column() { 
        Text(this.message) 
          .onClick(()=>{ 
            avSession.getAllSessionDescriptors((descriptors: avSession.AVSessionDescriptor[]) => { 
                console.info(`Succeeded in getting all session descriptors, length: ${descriptors.length}`); 
                if (descriptors.length > 0 ) { 
                    console.info(`Succeeded in getting session descriptor, isActive: ${descriptors[0].isActive}`); 
                    console.info(`Succeeded in getting session descriptor, type: ${descriptors[0].type}`); 
                    console.info(`Succeeded in getting session descriptor, sessionTag: ${descriptors[0].sessionTag}`); 
                } 
            }); 
          }) 
      } 
    .width('100%') 
    .height('100%') 
  } 
}

avSession.getSessionDescriptors²²⁺

getSessionDescriptors(category: SessionCategory): Promise<Array<Readonly<AVSessionDescriptor>>>

Obtains the session descriptors based on the session category. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
category	SessionCategory	Yes	Session category.

Return value

Type	Description
Promise<Array<Readonly<AVSessionDescriptor>>>	Promise used to return an array of AVSessionDescriptor objects of the corresponding category, each of which is read only.

Error codes

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

ID	Error Message
201	permission denied.
202	Not System App.
6600101	Session service exception.

Example

avSession.getSessionDescriptors(avSession.SessionCategory.CATEGORY_ALL).then((descriptors: avSession.AVSessionDescriptor[]) => {
  console.info(`Succeeded in getting session descriptors, length: ${descriptors.length}`);
  if (descriptors.length > 0) {
    console.info(`Succeeded in getting session descriptor, isActive: ${descriptors[0].isActive}`);
    console.info(`Succeeded in getting session descriptor, type: ${descriptors[0].type}`);
    console.info(`Succeeded in getting session descriptor, sessionTag: ${descriptors[0].sessionTag}`);
  }
});

avSession.getHistoricalSessionDescriptors¹⁰⁺

getHistoricalSessionDescriptors(maxSize?: number): Promise<Array<Readonly<AVSessionDescriptor>>>

Obtains the descriptors of all historical sessions. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
maxSize	number	No	Maximum number of descriptors to obtain. The value ranges from 0 to 10. If this parameter is left blank, the default value 3 is used.

Return value

Type	Description
Promise<Array<Readonly<AVSessionDescriptor>>>	Promise used to return an array of AVSessionDescriptor objects, each of which is read only.

Error codes

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

ID	Error Message
201	permission denied.
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avSession.getHistoricalSessionDescriptors().then((descriptors: avSession.AVSessionDescriptor[]) => {
  console.info(`Succeeded in getting historical session descriptors, length: ${descriptors.length}`);
  if (descriptors.length > 0 && descriptors[0]) {
    console.info(`Succeeded in getting historical session descriptor, isActive: ${descriptors[0].isActive}`);
    console.info(`Succeeded in getting historical session descriptor, type: ${descriptors[0].type}`);
    console.info(`Succeeded in getting historical session descriptor, sessionTag: ${descriptors[0].sessionTag}`);
    console.info(`Succeeded in getting historical session descriptor, sessionId: ${descriptors[0].sessionId}`);
    console.info(`Succeeded in getting historical session descriptor, bundleName: ${descriptors[0].elementName.bundleName}`);
  }
});

avSession.getHistoricalSessionDescriptors¹⁰⁺

getHistoricalSessionDescriptors(maxSize: number, callback: AsyncCallback<Array<Readonly<AVSessionDescriptor>>>): void

Obtains the descriptors of all historical sessions. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
maxSize	number	Yes	Maximum number of descriptors to obtain. The value ranges from 0 to 10.
callback	AsyncCallback<Array<Readonly<AVSessionDescriptor>>>	Yes	Callback used to return an array of AVSessionDescriptor objects, each of which is read only.

Error codes

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

ID	Error Message
201	permission denied.
202	Not System App.
401	parameter check failed. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avSession.getHistoricalSessionDescriptors(1, (descriptors: avSession.AVSessionDescriptor[]) => { 
    console.info(`Succeeded in getting historical session descriptors, length: ${descriptors.length}`); 
    if (descriptors.length > 0 ) { 
      console.info(`Succeeded in getting historical session descriptor, isActive: ${descriptors[0].isActive}`); 
      console.info(`Succeeded in getting historical session descriptor, type: ${descriptors[0].type}`); 
      console.info(`Succeeded in getting historical session descriptor, sessionTag: ${descriptors[0].sessionTag}`); 
      console.info(`Succeeded in getting historical session descriptor, sessionId: ${descriptors[0].sessionId}`); 
      console.info(`Succeeded in getting historical session descriptor, bundleName: ${descriptors[0].elementName.bundleName}`); 
    } 
});

avSession.getHistoricalAVQueueInfos¹¹⁺

getHistoricalAVQueueInfos(maxSize: number, maxAppSize: number) : Promise<Array<Readonly<AVQueueInfo>>>

Obtains all the historical playlists. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
maxSize	number	Yes	Maximum number of playlists that can be obtained. Currently, the maximum number is restricted by the system.
maxAppSize	number	Yes	Maximum number of applications to which the playlists to be obtained belong. Currently, the maximum number is restricted by the system.

Return value

Type	Description
Promise<Array<Readonly<AVQueueInfo>>>	Promise used to return all the read-only historical playlists.

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

avSession.getHistoricalAVQueueInfos(3, 5).then((avQueueInfos: avSession.AVQueueInfo[]) => {
  console.info(`Succeeded in getting historical AV queue infos, length: ${avQueueInfos.length}`);
});

avSession.getHistoricalAVQueueInfos¹¹⁺

getHistoricalAVQueueInfos(maxSize: number, maxAppSize: number, callback: AsyncCallback<Array<Readonly<AVQueueInfo>>>): void;

Obtains all the historical playlists. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
maxSize	number	Yes	Maximum number of playlists that can be obtained. Currently, the maximum number is restricted by the system.
maxAppSize	number	Yes	Maximum number of applications to which the playlists to be obtained belong. Currently, the maximum number is restricted by the system.
callback	AsyncCallback<Array<Readonly<AVQueueInfo>>>	Yes	Callback used to return all the read-only historical playlists.

Error codes

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

ID	Error Message
201	permission denied.
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avSession.getHistoricalAVQueueInfos(3, 5, (avQueueInfos: avSession.AVQueueInfo[]) => { 
    console.info(`Succeeded in getting historical AV queue infos, length: ${avQueueInfos.length}`); 
});

avSession.createController

createController(sessionId: string, callback: AsyncCallback<AVSessionController>): void

Creates a session controller based on the session ID. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES (available only to system applications)

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
sessionId	string	Yes	Session ID.
callback	AsyncCallback<AVSessionController>	Yes	Callback used to return the session controller created, which can be used to obtain the session ID, send commands and events to sessions, and obtain metadata and playback state information.

Error codes

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

ID	Error Message
201	permission denied.
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception.
6600102	The session does not exist.

Example

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

@Entry
@Component
struct Index {
  @State message: string = 'hello world';

  build() {
    Column() {
        Text(this.message)
          .onClick(()=>{
            avSession.getAllSessionDescriptors().then((descriptors: avSession.AVSessionDescriptor[]) => {
              console.info(`Succeeded in getting all session descriptors, length: ${descriptors.length}`);
              if (descriptors.length > 0 ) {
avSession.createController(descriptors[0]?.sessionId, (avcontroller: avSession.AVSessionController) => { 
                    console.info('Succeeded in creating controller.'); 
                });
              }
            });
          })
      }
    .width('100%')
    .height('100%')
  }
}

avSession.castAudio

castAudio(session: SessionToken | 'all', audioDevices: Array<audio.AudioDeviceDescriptor>): Promise<void>

Casts a session to a list of devices. This API uses a promise to return the result.

Before calling this API, import the ohos.multimedia.audio module to obtain the descriptors of these audio devices.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES (available only to system applications)

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
session	SessionToken \| 'all'	Yes	Session token. SessionToken indicates a specific token, and 'all' indicates all tokens.
audioDevices	Array<audio.AudioDeviceDescriptor>	Yes	Audio devices.

Return value

Type	Description
Promise<void>	Promise used to return the result. If casting is successful, 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
201	permission denied.
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception.
6600102	The session does not exist.
6600104	The remote session connection failed.

Example

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

let audioManager = audio.getAudioManager();
let audioRoutingManager = audioManager.getRoutingManager();
let audioDevices: audio.AudioDeviceDescriptors | undefined = undefined;
audioRoutingManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data) => {
  audioDevices = data;
  console.info('Promise returned to indicate that the device list is obtained.');
});

if (audioDevices !== undefined) {
  avSession.castAudio('all', audioDevices as audio.AudioDeviceDescriptors).then(() => {
    console.info('Succeeded in creating controller.');
  });
}

avSession.castAudio

castAudio(session: SessionToken | 'all', audioDevices: Array<audio.AudioDeviceDescriptor>, callback: AsyncCallback<void>): void

Casts a session to a list of devices. This API uses an asynchronous callback to return the result.

Before calling this API, import the ohos.multimedia.audio module to obtain the descriptors of these audio devices.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES (available only to system applications)

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
session	SessionToken \| 'all'	Yes	Session token. SessionToken indicates a specific token, and 'all' indicates all tokens.
audioDevices	Array<audio.AudioDeviceDescriptor>	Yes	Audio devices.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If casting 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
201	permission denied.
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception.
6600102	The session does not exist.
6600104	The remote session connection failed.

Example

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

let audioManager = audio.getAudioManager();
let audioRoutingManager = audioManager.getRoutingManager();
let audioDevices: audio.AudioDeviceDescriptors | undefined = undefined;
audioRoutingManager.getDevices(audio.DeviceFlag.OUTPUT_DEVICES_FLAG).then((data) => {
  audioDevices = data;
  console.info('Promise returned to indicate that the device list is obtained.');
  if (audioDevices !== undefined) {
    avSession.castAudio('all', audioDevices as audio.AudioDeviceDescriptors, () => {
        console.info('Succeeded in casting audio.');
    });
  }
});

avSession.startAVPlayback¹¹⁺

startAVPlayback(bundleName: string, assetId: string): Promise<void>

Starts an application to play a media asset. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES (available only to system applications)

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name of the application.
assetId	string	Yes	ID of the media asset.

Return value

Type	Description
Promise<void>	Promise used to return the result. If the playback is successful, 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
201	permission denied.
202	Not System App. Interface caller is not a system app.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed.
6600101	Session service exception.

Example

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

avSession.startAVPlayback("com.example.myapplication", "121278").then(() => {
  console.info('Succeeded in starting AV playback.');
});

avSession.getDistributedSessionController¹⁸⁺

getDistributedSessionController(distributedSessionType: DistributedSessionType): Promise<Array<AVSessionController>>

Obtains remote distributed session controllers based on the remote session type. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
distributedSessionType	DistributedSessionType	Yes	Remote session type.

Return value

Type	Description
Promise<Array<AVSessionController>>	Promise used to return an array of session controller instances of the corresponding type. You can view the session ID, send commands and events to the session, and obtain metadata and playback status information.

Error codes

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

ID	Error Message
201	permission denied.
202	Not System App.
6600101	Session service exception.
6600109	The remote connection is not established.

Example

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

avSession.getDistributedSessionController(avSession.DistributedSessionType.TYPE_SESSION_REMOTE).then((sessionControllers: Array<avSession.AVSessionController>) => {
  console.info(`Succeeded in getting distributed session controller, length: ${sessionControllers.length}`);
});

SessionToken

Describes the information about a session token.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES (available only to system applications)

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Name	Type	Read-Only	Optional	Description
sessionId	string	No	No	Session ID.
pid	number	No	Yes	Process ID of the session.
uid	number	No	Yes	User ID.

avSession.on('sessionCreate')

on(type: 'sessionCreate', callback: (session: AVSessionDescriptor) => void): void

Subscribes to session creation events. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'sessionCreate' is triggered when a session is created.
callback	(session: AVSessionDescriptor) => void	Yes	Callback used to report the session descriptor.

Error codes

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

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

Example

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

@Entry
@Component
struct Index {
  @State message: string = 'hello world';

  build() {
    Column() {
        Text(this.message)
          .onClick(()=>{
            avSession.on('sessionCreate', (descriptor: avSession.AVSessionDescriptor) => {
              console.info(`on sessionCreate : isActive : ${descriptor.isActive}`);
              console.info(`on sessionCreate : type : ${descriptor.type}`);
              console.info(`on sessionCreate : sessionTag : ${descriptor.sessionTag}`);
            });
          })
      }
    .width('100%')
    .height('100%')
  }
}

avSession.on('sessionDestroy')

on(type: 'sessionDestroy', callback: (session: AVSessionDescriptor) => void): void

Subscribes to session destroy events. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'sessionDestroy' is triggered when a session is destroyed.
callback	(session: AVSessionDescriptor) => void	Yes	Callback used to report the session descriptor.

Error codes

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

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

Example

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

@Entry
@Component
struct Index {
  @State message: string = 'hello world';

  build() {
    Column() {
        Text(this.message)
          .onClick(()=>{
            avSession.on('sessionDestroy', (descriptor: avSession.AVSessionDescriptor) => {
              console.info(`on sessionDestroy : ${descriptor.sessionId}`);
            });
          })
      }
    .width('100%')
    .height('100%')
  }
}

avSession.on('topSessionChange')

on(type: 'topSessionChange', callback: (session: AVSessionDescriptor) => void): void

Subscribes to the top session change events. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'topSessionChange' is triggered when the top session is changed.
callback	(session: AVSessionDescriptor) => void	Yes	Callback used to report the session descriptor.

Error codes

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

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

Example

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

@Entry
@Component
struct Index {
  @State message: string = 'hello world';

  build() {
    Column() {
        Text(this.message)
          .onClick(()=>{
            avSession.on('topSessionChange', (descriptor: avSession.AVSessionDescriptor) => {
              console.info(`on topSessionChange : isActive : ${descriptor.isActive}`);
              console.info(`on topSessionChange : type : ${descriptor.type}`);
              console.info(`on topSessionChange : sessionTag : ${descriptor.sessionTag}`);
            });
          })
      }
    .width('100%')
    .height('100%')
  }
}

avSession.off('sessionCreate')

off(type: 'sessionCreate', callback?: (session: AVSessionDescriptor) => void): void

Unsubscribes from session creation events. After unsubscription, the event will no longer be received.

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'sessionCreate' in this case.
callback	(session: AVSessionDescriptor) => void	No	Callback used for unsubscription. If the unsubscription is successful, err is undefined; otherwise, err is an error object. The session parameter in the callback describes a media session. 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
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

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

@Entry
@Component
struct Index {
  @State message: string = 'hello world';

  build() {
    Column() {
        Text(this.message)
          .onClick(()=>{
            avSession.on('sessionCreate', (descriptor: avSession.AVSessionDescriptor) => {
            });
            avSession.off('sessionCreate');
          })
      }
    .width('100%')
    .height('100%')
  }
}

avSession.off('sessionDestroy')

off(type: 'sessionDestroy', callback?: (session: AVSessionDescriptor) => void): void

Unsubscribes from session destroy events. After unsubscription, the event will no longer be received.

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'sessionDestroy' in this case.
callback	(session: AVSessionDescriptor) => void	No	Callback used for unsubscription. If the unsubscription is successful, err is undefined; otherwise, err is an error object. The session parameter in the callback describes a media session. 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
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

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

@Entry
@Component
struct Index {
  @State message: string = 'hello world';

  build() {
    Column() {
        Text(this.message)
          .onClick(()=>{
            avSession.on('sessionDestroy', (descriptor: avSession.AVSessionDescriptor) => {
            });
            avSession.off('sessionDestroy');
          })
      }
    .width('100%')
    .height('100%')
  }
}

avSession.off('topSessionChange')

off(type: 'topSessionChange', callback?: (session: AVSessionDescriptor) => void): void

Unsubscribes from the top session change events. After unsubscription, the event will no longer be received.

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'topSessionChange' in this case.
callback	(session: AVSessionDescriptor) => void	No	Callback used for unsubscription. If the unsubscription is successful, err is undefined; otherwise, err is an error object. The session parameter in the callback describes a media session. 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
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

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

@Entry
@Component
struct Index {
  @State message: string = 'hello world';

  build() {
    Column() {
        Text(this.message)
          .onClick(()=>{
            avSession.on('topSessionChange', (descriptor: avSession.AVSessionDescriptor) => {
            });
            avSession.off('topSessionChange');
          })
      }
    .width('100%')
    .height('100%')
  }
}

avSession.on('sessionServiceDie')

on(type: 'sessionServiceDie', callback: () => void): void

Subscribes to session service death events. Upon receiving this event, the application can clear resources.

System capability: SystemCapability.Multimedia.AVSession.Core

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'sessionServiceDie' is triggered when the session service dies.
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
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avSession.on('sessionServiceDie', () => {
  console.info('on sessionServiceDie  : session is  Died ');
});

avSession.off('sessionServiceDie')

off(type: 'sessionServiceDie', callback?: () => void): void

Unsubscribes from session service death events.

System capability: SystemCapability.Multimedia.AVSession.Core

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'sessionServiceDie' is triggered when the session service dies.
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
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
6600101	Session service exception.

Example

avSession.off('sessionServiceDie');

avSession.on('distributedSessionChange')¹⁸⁺

on(type: 'distributedSessionChange', distributedSessionType: DistributedSessionType, callback: Callback<Array<AVSessionController>>): void

Subscribes to the latest distributed remote session change events.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'distributedSessionChange' is triggered when the latest distributed session is changed.
distributedSessionType	DistributedSessionType	Yes	Remote session type.
callback	Callback<Array<AVSessionController>>	Yes	Callback used to return an array of session controller instances of the corresponding type. You can view the session ID, send commands and events to the session, and obtain metadata and playback status information.

Error codes

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

ID	Error Message
202	Not System App.
6600101	Session service exception.

Example

avSession.on('distributedSessionChange', avSession.DistributedSessionType.TYPE_SESSION_REMOTE, (sessionControllers: Array<avSession.AVSessionController>) => {
  console.info(`on distributedSessionChange size: ${sessionControllers.length}`);
});

avSession.off('distributedSessionChange')¹⁸⁺

off(type: 'distributedSessionChange', distributedSessionType: DistributedSessionType, callback?: Callback<Array<AVSessionController>>): void

Unsubscribes from the latest distributed remote session change events.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'distributedSessionChange' is triggered when the latest distributed session is changed.
distributedSessionType	DistributedSessionType	Yes	Remote session type.
callback	Callback<Array<AVSessionController>>	No	Callback used to return an array of session controller instances of the corresponding type. You can view the session ID, send commands and events to the session, and obtain metadata and playback status information.

Error codes

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

ID	Error Message
202	Not System App.
6600101	Session service exception.

Example

avSession.off('distributedSessionChange', avSession.DistributedSessionType.TYPE_SESSION_REMOTE);

avSession.sendSystemAVKeyEvent

sendSystemAVKeyEvent(event: KeyEvent, callback: AsyncCallback<void>): void

Sends a system key event to the top session. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES (available only to system applications)

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
event	KeyEvent	Yes	Key event.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the event 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
201	permission denied.
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception.
6600105	Invalid session command.

Example

import { KeyEvent } from '@kit.InputKit';

let keyItem: KeyEvent.Key = {code:0x49, pressedTime:2, deviceId:0};
let event: KeyEvent.KeyEvent = {id:1, deviceId:0, actionTime:1, screenId:1, windowId:1, action:2, key:keyItem, unicodeChar:0, keys:[keyItem], ctrlKey:false, altKey:false, shiftKey:false, logoKey:false, fnKey:false, capsLock:false, numLock:false, scrollLock:false};

avSession.sendSystemAVKeyEvent(event, () => {
    console.info('Succeeded in sending system AV key event.');
});

avSession.sendSystemAVKeyEvent

sendSystemAVKeyEvent(event: KeyEvent): Promise<void>

Sends a system key event to the top session. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES (available only to system applications)

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
event	KeyEvent	Yes	Key event.

Return value

Type	Description
Promise<void>	Promise used to return the result. If the event 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
201	permission denied.
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception.
6600105	Invalid session command.

Example

import { KeyEvent } from '@kit.InputKit';

let keyItem: KeyEvent.Key = {code:0x49, pressedTime:2, deviceId:0};
let event: KeyEvent.KeyEvent = {id:1, deviceId:0, actionTime:1, screenId:1, windowId:1, action:2, key:keyItem, unicodeChar:0, keys:[keyItem], ctrlKey:false, altKey:false, shiftKey:false, logoKey:false, fnKey:false, capsLock:false, numLock:false, scrollLock:false};

avSession.sendSystemAVKeyEvent(event).then(() => {
  console.info('Succeeded in sending system AV key event.');
});

avSession.sendSystemControlCommand

sendSystemControlCommand(command: AVControlCommand, callback: AsyncCallback<void>): void

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

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES (available only to system applications)

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
command	AVControlCommand	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
201	permission denied.
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception.
6600105	Invalid session command.
6600107	Too many commands or events.

Example

let cmd : avSession.AVControlCommandType = 'play';
// let cmd : avSession.AVControlCommandType = 'pause';
// let cmd : avSession.AVControlCommandType = 'stop';
// let cmd : avSession.AVControlCommandType = 'playNext';
// let cmd : avSession.AVControlCommandType = 'playPrevious';
// let cmd : avSession.AVControlCommandType = 'fastForward';
// let cmd : avSession.AVControlCommandType = 'rewind';
let avcommand: avSession.AVControlCommand = {command:cmd};
// let cmd : avSession.AVControlCommandType = 'seek';
// let avcommand = {command:cmd, parameter:10};
// let cmd : avSession.AVControlCommandType = 'setSpeed';
// let avcommand = {command:cmd, parameter:2.6};
// let cmd : avSession.AVControlCommandType = 'setLoopMode';
// let avcommand = {command:cmd, parameter:avSession.LoopMode.LOOP_MODE_SINGLE};
// let cmd : avSession.AVControlCommandType = 'toggleFavorite';
// let avcommand = {command:cmd, parameter:"false"};
avSession.sendSystemControlCommand(avcommand, () => {
    console.info('Succeeded in sending system control command.');
});

avSession.sendSystemControlCommand

sendSystemControlCommand(command: AVControlCommand): Promise<void>

Sends a system control command to the top session. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES (available only to system applications)

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
command	AVControlCommand	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
201	permission denied.
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception.
6600105	Invalid session command.
6600107	Too many commands or events.

Example


let cmd : avSession.AVControlCommandType = 'play';
// let cmd : avSession.AVControlCommandType = 'pause';
// let cmd : avSession.AVControlCommandType = 'stop';
// let cmd : avSession.AVControlCommandType = 'playNext';
// let cmd : avSession.AVControlCommandType = 'playPrevious';
// let cmd : avSession.AVControlCommandType = 'fastForward';
// let cmd : avSession.AVControlCommandType = 'rewind';
let avcommand: avSession.AVControlCommand = {command:cmd};
// let cmd : avSession.AVControlCommandType = 'seek';
// let avcommand = {command:cmd, parameter:10};
// let cmd : avSession.AVControlCommandType = 'setSpeed';
// let avcommand = {command:cmd, parameter:2.6};
// let cmd : avSession.AVControlCommandType = 'setLoopMode';
// let avcommand = {command:cmd, parameter:avSession.LoopMode.LOOP_MODE_SINGLE};
// let cmd : avSession.AVControlCommandType = 'toggleFavorite';
// let avcommand = {command:cmd, parameter:"false"};
avSession.sendSystemControlCommand(avcommand).then(() => {
  console.info('Succeeded in sending system control command.');
});

ProtocolType¹⁰⁺

Enumerates the protocol types supported by the remote device.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Name	Value	Description
TYPE_CAST_PLUS_MIRROR	1	Cast+ mirror mode. System API: This is a system API.

avSession.startCastDeviceDiscovery¹⁰⁺

startCastDeviceDiscovery(callback: AsyncCallback<void>): void

Starts cast-enabled device discovery. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

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

Error codes

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

ID	Error Message
202	Not System App.

Example


avSession.startCastDeviceDiscovery(() => {
    console.info('Succeeded in starting cast device discovery.');
});

DistributedSessionType¹⁸⁺

Enumerates the session types supported by the remote distributed device.

System capability: SystemCapability.Multimedia.AVSession.Message

System API: This is a system API.

Name	Value	Description
TYPE_SESSION_REMOTE	0	Session on the remote device.
TYPE_SESSION_MIGRATE_IN	1	Session migrated to the local device.
TYPE_SESSION_MIGRATE_OUT	2	Session migrated to the remote device.

avSession.startCastDeviceDiscovery¹⁰⁺

startCastDeviceDiscovery(filter: number, callback: AsyncCallback<void>): void

Starts cast-enabled device discovery with filter criteria specified. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
filter	number	Yes	Filter criteria for device discovery. The value consists of ProtocolTypes.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the command is sent and device discovery starts, err is undefined; otherwise, err is an error object.

Error codes

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

ID	Error Message
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.

Example


let filter = 2;
avSession.startCastDeviceDiscovery(filter, () => {
    console.info('Succeeded in starting cast device discovery.');
});

avSession.startCastDeviceDiscovery¹⁰⁺

startCastDeviceDiscovery(filter?: number, drmSchemes?: Array<string>): Promise<void>

Starts cast-enabled device discovery. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
filter	number	No	Filter criteria for device discovery. The value consists of ProtocolTypes.
drmSchemes	Array<string>	No	Filter criteria for discovering devices that support DRM resource playback. The value consists of DRM UUIDs. This parameter is supported since API version 12.

Return value

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

Error codes

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

ID	Error Message
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.

Example


let filter = 2;
let drmSchemes = ['3d5e6d35-9b9a-41e8-b843-dd3c6e72c42c'];
avSession.startCastDeviceDiscovery(filter, drmSchemes).then(() => {
  console.info('Succeeded in starting cast device discovery.');
});

avSession.stopCastDeviceDiscovery¹⁰⁺

stopCastDeviceDiscovery(callback: AsyncCallback<void>): void

Stops cast-enabled device discovery. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

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

Error codes

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

ID	Error Message
202	Not System App.

Example


avSession.stopCastDeviceDiscovery(() => {
    console.info('Succeeded in stopping cast device discovery.');
});

avSession.stopCastDeviceDiscovery¹⁰⁺

stopCastDeviceDiscovery(): Promise<void>

Stops cast-enabled device discovery. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Return value

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

Error codes

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

ID	Error Message
202	Not System App.

Example


avSession.stopCastDeviceDiscovery().then(() => {
  console.info('Succeeded in stopping cast device discovery.');
});

avSession.setDiscoverable¹⁰⁺

setDiscoverable(enable: boolean, callback: AsyncCallback<void>): void

Sets whether to allow the device discoverable. A discoverable device can be used as the cast receiver. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to allow the device discoverable. true if discoverable, false otherwise.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the setting is successful, err is undefined; otherwise, err is an error object.

Error codes

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

ID	Error Message
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.

Example


avSession.setDiscoverable(true, () => {
    console.info('Succeeded in setting discoverable.');
});

avSession.setDiscoverable¹⁰⁺

setDiscoverable(enable: boolean): Promise<void>

Sets whether to allow the device discoverable. A discoverable device can be used as the cast receiver. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to allow the device discoverable. true if discoverable, false otherwise.

Return value

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

Error codes

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

ID	Error Message
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.

Example


avSession.setDiscoverable(true).then(() => {
  console.info('Succeeded in setting discoverable.');
});

avSession.on('deviceAvailable')¹⁰⁺

on(type: 'deviceAvailable', callback: (device: OutputDeviceInfo) => void): void

Subscribes to device discovery events.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'deviceAvailable' is triggered when a device is discovered.
callback	(device: OutputDeviceInfo) => 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.

ID	Error Message
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.

Example

let castDevice: avSession.OutputDeviceInfo;
avSession.on('deviceAvailable', (device: avSession.OutputDeviceInfo) => {
  castDevice = device;
  console.info(`on deviceAvailable  : ${device} `);
});

avSession.off('deviceAvailable')¹⁰⁺

off(type: 'deviceAvailable', callback?: (device: OutputDeviceInfo) => void): void

Unsubscribes from device discovery events.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'deviceAvailable' is triggered when a device is discovered.
callback	(device: OutputDeviceInfo) => void	No	Callback used to return the device information.

Error codes

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

ID	Error Message
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.

Example

avSession.off('deviceAvailable');

avSession.on('deviceOffline')¹¹⁺

on(type: 'deviceOffline', callback: (deviceId: string) => void): void

Subscribes to device offline events.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'deviceOffline' is triggered when a device gets offline.
callback	(deviceId: string) => void	Yes	Callback used to return the result. The deviceId parameter in the callback indicates the device ID. 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.

ID	Error Message
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.

Example

let castDeviceId: string;
avSession.on('deviceOffline', (deviceId: string) => {
  castDeviceId = deviceId;
  console.info(`on deviceOffline  : ${deviceId} `);
});

avSession.off('deviceOffline')¹¹⁺

off(type: 'deviceOffline', callback?: (deviceId: string) => void): void

Unsubscribes from device offline events.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'deviceOffline' in this case.
callback	(deviceId: string) => void	No	Callback used to return the result. The deviceId parameter in the callback indicates the device ID. 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
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.

Example

avSession.off('deviceOffline');

avSession.getAVCastController¹⁰⁺

getAVCastController(sessionId: string, callback: AsyncCallback<AVCastController>): void

Obtains the cast controller when a casting connection is set up. This API uses an asynchronous callback to return the result.

This API can be called on both the local and remote devices. You can use the API to obtain the same controller to control audio playback after cast.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
sessionId	string	Yes	Session ID.
callback	AsyncCallback<AVCastController>	Yes	Callback used to return the cast controller.

Error codes

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

ID	Error Message
201	permission denied.
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	Session service exception
6600102	session does not exist

Example

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

@Entry
@Component
struct Index {
  @State message: string = 'hello world';

  build() {
    Column() {
      Text(this.message)
        .onClick(() => {
          let currentAVSession: avSession.AVSession | undefined = undefined;
          let tag = "createNewSession";
          let context = this.getUIContext().getHostContext() as Context;
          let sessionId: string = ""; // Used as an input parameter of subsequent functions.

          let avCastController: avSession.AVCastController;
          avSession.getAVCastController(sessionId, (avcontroller: avSession.AVCastController) => {
              avCastController = avcontroller;
              console.info('Succeeded in getting AV cast controller.');
          });
        })
    }
    .width('100%')
    .height('100%')
  }
}

avSession.getAVCastController¹⁰⁺

getAVCastController(sessionId: string): Promise<AVCastController>

Obtains the cast controller when a casting connection is set up. This API uses a promise to return the result.

This API can be called on both the local and remote devices. You can use the API to obtain the same controller to control audio playback after cast.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
sessionId	string	Yes	Session ID.

Return value

Type	Description
Promise<AVCastController>	Promise used to return the cast controller.

Error codes

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

ID	Error Message
201	permission denied.
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600101	server exception
6600102	The session does not exist

Example

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

@Entry
@Component
struct Index {
  @State message: string = 'hello world';

  build() {
    Column() {
      Text(this.message)
        .onClick(() => {
          let currentAVSession: avSession.AVSession | undefined = undefined;
          let tag = "createNewSession";
          let context = this.getUIContext().getHostContext() as Context;
          let sessionId: string = ""; // Used as an input parameter of subsequent functions.

          let avCastController: avSession.AVCastController;
          avSession.getAVCastController(sessionId).then((avcontroller: avSession.AVCastController) => {
            avCastController = avcontroller;
            console.info('Succeeded in getting AV cast controller.');
          });
        })
    }
    .width('100%')
    .height('100%')
  }
}

avSession.startCasting¹⁰⁺

startCasting(session: SessionToken, device: OutputDeviceInfo, callback: AsyncCallback<void>): void

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

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES (available only to system applications)

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
session	SessionToken	Yes	Session token.
device	OutputDeviceInfo	Yes	Device-related information.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the command is sent and casting starts, 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
201	permission denied.
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed.
6600101	Session service exception.
6600108	Device connection failed.

Example


let myToken: avSession.SessionToken = {
  sessionId: sessionId,
}
let castDevice: avSession.OutputDeviceInfo | undefined = undefined;
avSession.on('deviceAvailable', (device: avSession.OutputDeviceInfo) => {
  castDevice = device;
  console.info(`on deviceAvailable  : ${device} `);
  if (castDevice !== undefined) {
    avSession.startCasting(myToken, castDevice, () => {
        console.info('Succeeded in starting casting.');
    });
  }
});

avSession.startCasting¹⁰⁺

startCasting(session: SessionToken, device: OutputDeviceInfo): Promise<void>

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

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES (available only to system applications)

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
session	SessionToken	Yes	Session token.
device	OutputDeviceInfo	Yes	Device-related information.

Return value

Type	Description
Promise<void>	Promise used to return the result. If the command is sent and casting starts, 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
201	permission denied.
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed.
6600101	Session service exception.
6600108	Device connection failed.

Example


let myToken: avSession.SessionToken = {
  sessionId: sessionId,
}
let castDevice: avSession.OutputDeviceInfo | undefined = undefined;
avSession.on('deviceAvailable', (device: avSession.OutputDeviceInfo) => {
  castDevice = device;
  console.info(`on deviceAvailable  : ${device} `);
  if (castDevice !== undefined) {
    avSession.startCasting(myToken, castDevice).then(() => {
      console.info('Succeeded in starting casting.');
    });
  }
});

avSession.stopCasting¹⁰⁺

stopCasting(session: SessionToken, callback: AsyncCallback<void>): void

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
session	SessionToken	Yes	Session token.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If casting stops, 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
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed.
6600109	The remote connection is not established.

Example


let myToken: avSession.SessionToken = {
  sessionId: sessionId,
}
avSession.stopCasting(myToken, () => {
    console.info('Succeeded in stopping casting.');
});

avSession.stopCasting¹⁰⁺

stopCasting(session: SessionToken): Promise<void>

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

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
session	SessionToken	Yes	Session token.

Return value

Type	Description
Promise<void>	Promise used to return the result. If casting stops, 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
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. 3.Parameter verification failed.
6600109	The remote connection is not established.

Example


let myToken: avSession.SessionToken = {
  sessionId: sessionId,
}
avSession.stopCasting(myToken).then(() => {
  console.info('Succeeded in stopping casting.');
});

avSession.startDeviceLogging¹³⁺

startDeviceLogging(url: string, maxSize?: number): Promise<void>

Starts to write device logs to a file. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
url	string	Yes	Target file descriptor (unique identifier used to open a file).
maxSize	number	No	Maximum size of the log file, in KB.

Return value

Type	Description
Promise<void>	Promise used to return the result. If the device logs are written to the file 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
202	Not System App.
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
6600101	Session service exception.
6600102	The session does not exist.

Example

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

let file = await fileIo.open("filePath");
let url = file.fd.toString();
avSession.startDeviceLogging(url, 2048).then(() => {
  console.info('Succeeded in starting device logging.');
})

avSession.stopDeviceLogging¹³⁺

stopDeviceLogging(): Promise<void>

Stops device logging. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Return value

Type	Description
Promise<void>	Promise used to return the result. If device logging is stopped, 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
202	Not System App.
6600101	Session service exception.
6600102	The session does not exist.

Example

avSession.stopDeviceLogging().then(() => {
  console.info('Succeeded in stopping casting.');
});

avSession.on('deviceLogEvent')¹³⁺

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

Subscribes to device log events.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'deviceLogEvent' in this case.
callback	(callback: DeviceLogEventCode) => void	Yes	Callback function, in which DeviceLogEventCode is the return value of the current device log event.

Error codes

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

ID	Error Message
202	Not System App.
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
6600101	Session service exception.
6600102	The session does not exist.

Example

avSession.on('deviceLogEvent', (eventCode: avSession.DeviceLogEventCode) => {
  console.info(`on deviceLogEvent code : ${eventCode}`);
});

avSession.off('deviceLogEvent')¹³⁺

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

Unsubscribes from device log events.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'deviceLogEvent' in this case.
callback	(callback: DeviceLogEventCode) => 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
202	Not System App.
401	Parameter check failed. 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
6600101	Session service exception.
6600102	The session does not exist.

Example

avSession.off('deviceLogEvent');

DeviceState²⁰⁺

Describes the connection state of the casting device.

System API: This is a system API.

System capability: SystemCapability.Multimedia.AVSession.AVCast

Name	Type	Read-Only	Optional	Description
deviceId	string	Yes	No	ID of the casting device.
deviceState	number	Yes	No	Connection status code of the casting device.
reasonCode	number	Yes	No	Connection error code of the casting device.
radarErrorCode	number	Yes	No	System radar error code.

avSession.on('deviceStateChanged')²⁰⁺

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

Subscribes to casting device connection state events.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'deviceStateChanged' in this case. This event is triggered when the connection state of the casting device changes.
callback	(callback: DeviceState) => void	Yes	Callback function, in which DeviceState contains the casting device ID, connection status code, connection error code, and system radar error code.

Error codes

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

ID	Error Message
201	Permission denied.
202	Not System App.

Example

avSession.on('deviceStateChanged', (state: avSession.DeviceState) => {
  console.info(`on deviceStateChanged state, deviceId=${state.deviceId}, connect status=${state.deviceState},
    reasonCode=${state.reasonCode}, radarErrorCode=${state.radarErrorCode}`)
})

avSession.off('deviceStateChanged')²⁰⁺

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

Unsubscribes from casting device connection state events.

System API: This is a system API.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System capability: SystemCapability.Multimedia.AVSession.AVCast

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'deviceStateChanged' in this case. This event is triggered when the connection state of the casting device changes.
callback	(callback: DeviceState) => void	No	Callback used to return the result. If the operation 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
201	Permission denied.
202	Not System App.

Example

avSession.off('deviceStateChanged');

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.

setDisplaySurface¹⁰⁺

setDisplaySurface(surfaceId: string): Promise<void>

Sets the surface ID for playback, which is used at the cast receiver (sink). This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
surfaceId	string	Yes	Surface ID.

Return value

Type	Description
Promise<void>	Promise used to return the result.

Error codes

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

ID	Error Message
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600109	The remote connection is not established.

Example

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

let surfaceID: string = '';
media.createAVRecorder().then((avRecorder) => {
  avRecorder.getInputSurface((surfaceId: string) => {
    console.info('Succeeded in getting input surface.');
    surfaceID = surfaceId;
    if (surfaceID) {
      avCastController.setDisplaySurface(surfaceID).then(() => {
        console.info('Succeeded in setting display surface.');
      });
    }
  });
})

setDisplaySurface¹⁰⁺

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

Sets the surface ID for playback, which is used at the cast receiver (sink). This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.
surfaceId	string	Yes	Surface ID.

Error codes

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

ID	Error Message
202	Not System App.
401	parameter check failed. 1.Mandatory parameters are left unspecified. 2.Parameter verification failed.
6600109	The remote connection is not established.

Example

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

let surfaceID: string = '';
media.createAVRecorder().then((avRecorder) => {
  avRecorder.getInputSurface((surfaceId: string) => {
    console.info('Succeeded in getting input surface.');
    surfaceID = surfaceId;
    if (surfaceID) {
      avCastController.setDisplaySurface(surfaceID, () => {
          console.info('Succeeded in setting display surface.');
      });
    }
  });
})

on('videoSizeChange')¹²⁺

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

Subscribes to video size change events.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The event 'videoSizeChange' is triggered when the video size changes.
callback	(width:number, height:number) => void	Yes	Callback used to return the video width and height.

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(`width : ${width} `);
  console.info(`height: ${height} `);
});

off('videoSizeChange')¹²⁺

off(type: 'videoSizeChange'): void

Unsubscribes from video size changes.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'videoSizeChange' 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('videoSizeChange');

avSession.onActiveSessionChanged²³⁺

function onActiveSessionChanged(callback: Callback<Array<AVSessionDescriptor>>): void

Subscribes to changes to the session that can be displayed in the system control entry. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	Callback<Array<AVSessionDescriptor>>	Yes	Callback used to return the sessions that can be displayed in the system control entry.

Error codes

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

ID	Error Message
201	permission denied.
202	Not System App.
6600101	Session service exception.

Example

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

@Entry
@Component
struct Index {
  @State message: string = 'hello world';

  build() {
    Column() {
      Text(this.message)
        .onClick(() => {
          avSession.onActiveSessionChanged((descs: Array<avSession.AVSessionDescriptor>) => {
            descs.forEach((desc, index) => {
              console.info(`=== Session ${index + 1}/${descs.length} ===`);
              console.info(`on onActiveSessionChanged : isActive : ${desc.isActive}`);
              console.info(`on onActiveSessionChanged : type : ${desc.type}`);
              console.info(`on onActiveSessionChanged : sessionTag : ${desc.sessionTag}`);
            });
          });
        })
    }
    .width('100%')
    .height('100%')
  }
}

avSession.offActiveSessionChanged²³⁺

function offActiveSessionChanged(callback?: Callback<Array<AVSessionDescriptor>>): void

Unsubscribes from changes to the session that can be displayed in the system control entry. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MEDIA_RESOURCES

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	Callback<Array<AVSessionDescriptor>>	No	Callback used for unsubscription. If the unsubscription is successful, err is undefined; otherwise, err is an error object. This parameter is optional. If it is not specified, the change events of all sessions that can be displayed in the system control entry are unsubscribed.

Error codes

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

ID	Error Message
201	permission denied.
202	Not System App.
6600101	Session service exception.

Example

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

@Entry
@Component
struct Index {
  @State message: string = 'hello world';

  build() {
    Column() {
      Text(this.message)
        .onClick(() => {
          avSession.onActiveSessionChanged((descriptors: Array<avSession.AVSessionDescriptor>) => {
          });
          avSession.offActiveSessionChanged();
        })
    }
    .width('100%')
    .height('100%')
  }
}

AVQueueInfo¹¹⁺

Defines the attributes of a playlist.

System capability: SystemCapability.Multimedia.AVSession.Core

System API: This is a system API.

Name	Type	Read-Only	Optional	Description
bundleName	string	No	No	Bundle name of the application to which the playlist belongs.
avQueueName	string	No	No	Playlist name.
avQueueId	string	No	No	Unique ID of the playlist.
avQueueImage	image.PixelMap \| string	No	No	Cover image of the playlist, which can be pixel data of an image or an image path (local path or Internet path).
lastPlayedTime	number	No	Yes	Last time when the playlist is played.

DeviceInfo¹⁰⁺

Describes the information related to the output device.

Name	Type	Read-Only	Optional	Description
ipAddress	string	No	Yes	IP address of the output device. System API: This is a system API. System capability: SystemCapability.Multimedia.AVSession.AVCast
providerId	number	No	Yes	Vendor of the output device. System API: This is a system API. System capability: SystemCapability.Multimedia.AVSession.AVCast
authenticationStatus¹¹⁺	number	No	Yes	Whether the output device is trusted. The default value is 0, indicating that the device is untrusted. The value 1 means that the device is trusted. System API: This is a system API. System capability: SystemCapability.Multimedia.AVSession.AVCast
networkId¹³⁺	string	No	Yes	Network ID of the output device. System API: This is a system API. System capability: SystemCapability.Multimedia.AVSession.AVCast
isLegacy¹³⁺	boolean	No	Yes	Whether the current device is a legacy device. true if it is a legacy device, false otherwise. System API: This is a system API. System capability: SystemCapability.Multimedia.AVSession.AVCast
mediumTypes¹³⁺	number	No	Yes	Medium types used for device discovery. 1: Bluetooth Low Energy (BLE), which is used to discover and connect to Bluetooth devices. 2: Constrained Application Protocol (CoAP), which is used to discover devices in a Local Area Network (LAN). System API: This is a system API. System capability: SystemCapability.Multimedia.AVSession.AVCast

AVSessionDescriptor

Declares the session descriptor.

System capability: SystemCapability.Multimedia.AVSession.Manager

Name	Type	Read-Only	Optional	Description
outputDevice	OutputDeviceInfo	No	No	Information about the output device. System API: This is a system API. System capability: SystemCapability.Multimedia.AVSession.Manager

DeviceLogEventCode¹³⁺

Enumerates the return values of device log events.

System capability: SystemCapability.Multimedia.AVSession.AVCast

System API: This is a system API.

Name	Value	Description
DEVICE_LOG_FULL	1	The log file is full.
DEVICE_LOG_EXCEPTION	2	An exception occurs during device logging.

SessionCategory²²⁺

Enumerates the session categories in different scenarios.

System capability: SystemCapability.Multimedia.AVSession.Manager

System API: This is a system API.

Name	Value	Description
CATEGORY_ACTIVE	1	Session category that can be displayed in the system control entry.
CATEGORY_NOT_ACTIVE	2	Session category that cannot be displayed in the system control entry.
CATEGORY_ALL	3	All session categories.

@ohos.multimedia.avsession (AVSession Management) (System API)

Modules to Import

Usage Guidelines

avSession.getAllSessionDescriptors

avSession.getSessionDescriptors22+

avSession.getHistoricalSessionDescriptors10+

avSession.getHistoricalSessionDescriptors10+

avSession.getHistoricalAVQueueInfos11+

avSession.getHistoricalAVQueueInfos11+

avSession.createController

avSession.castAudio

avSession.castAudio

avSession.startAVPlayback11+

avSession.getDistributedSessionController18+

SessionToken

avSession.on('sessionCreate')

avSession.on('sessionDestroy')

avSession.on('topSessionChange')

avSession.off('sessionCreate')

avSession.off('sessionDestroy')

avSession.off('topSessionChange')

avSession.on('sessionServiceDie')

avSession.off('sessionServiceDie')

avSession.on('distributedSessionChange')18+

avSession.off('distributedSessionChange')18+

avSession.sendSystemAVKeyEvent

avSession.sendSystemAVKeyEvent

avSession.sendSystemControlCommand

avSession.sendSystemControlCommand

ProtocolType10+

avSession.startCastDeviceDiscovery10+

DistributedSessionType18+

avSession.startCastDeviceDiscovery10+

avSession.startCastDeviceDiscovery10+

avSession.stopCastDeviceDiscovery10+

avSession.stopCastDeviceDiscovery10+

avSession.setDiscoverable10+

avSession.setDiscoverable10+

avSession.on('deviceAvailable')10+

avSession.off('deviceAvailable')10+

avSession.on('deviceOffline')11+

avSession.off('deviceOffline')11+

avSession.getAVCastController10+

avSession.getAVCastController10+

avSession.startCasting10+

avSession.startCasting10+

avSession.stopCasting10+

avSession.stopCasting10+

avSession.startDeviceLogging13+

avSession.stopDeviceLogging13+

avSession.on('deviceLogEvent')13+

avSession.off('deviceLogEvent')13+

DeviceState20+

avSession.on('deviceStateChanged')20+

avSession.off('deviceStateChanged')20+

AVCastController10+

setDisplaySurface10+

setDisplaySurface10+

on('videoSizeChange')12+

off('videoSizeChange')12+

avSession.onActiveSessionChanged23+

avSession.offActiveSessionChanged23+

AVQueueInfo11+

DeviceInfo10+

AVSessionDescriptor

DeviceLogEventCode13+

SessionCategory22+

avSession.getSessionDescriptors²²⁺

avSession.getHistoricalSessionDescriptors¹⁰⁺

avSession.getHistoricalSessionDescriptors¹⁰⁺

avSession.getHistoricalAVQueueInfos¹¹⁺

avSession.getHistoricalAVQueueInfos¹¹⁺

avSession.startAVPlayback¹¹⁺

avSession.getDistributedSessionController¹⁸⁺

avSession.on('distributedSessionChange')¹⁸⁺

avSession.off('distributedSessionChange')¹⁸⁺

ProtocolType¹⁰⁺

avSession.startCastDeviceDiscovery¹⁰⁺

DistributedSessionType¹⁸⁺

avSession.startCastDeviceDiscovery¹⁰⁺

avSession.startCastDeviceDiscovery¹⁰⁺

avSession.stopCastDeviceDiscovery¹⁰⁺

avSession.stopCastDeviceDiscovery¹⁰⁺

avSession.setDiscoverable¹⁰⁺

avSession.setDiscoverable¹⁰⁺

avSession.on('deviceAvailable')¹⁰⁺

avSession.off('deviceAvailable')¹⁰⁺

avSession.on('deviceOffline')¹¹⁺

avSession.off('deviceOffline')¹¹⁺

avSession.getAVCastController¹⁰⁺

avSession.getAVCastController¹⁰⁺

avSession.startCasting¹⁰⁺

avSession.startCasting¹⁰⁺

avSession.stopCasting¹⁰⁺

avSession.stopCasting¹⁰⁺

avSession.startDeviceLogging¹³⁺

avSession.stopDeviceLogging¹³⁺

avSession.on('deviceLogEvent')¹³⁺

avSession.off('deviceLogEvent')¹³⁺

DeviceState²⁰⁺

avSession.on('deviceStateChanged')²⁰⁺

avSession.off('deviceStateChanged')²⁰⁺

AVCastController¹⁰⁺

setDisplaySurface¹⁰⁺

setDisplaySurface¹⁰⁺

on('videoSizeChange')¹²⁺

off('videoSizeChange')¹²⁺

avSession.onActiveSessionChanged²³⁺

avSession.offActiveSessionChanged²³⁺

AVQueueInfo¹¹⁺

DeviceInfo¹⁰⁺

DeviceLogEventCode¹³⁺

SessionCategory²²⁺