harmony 鸿蒙@ohos.multimedia.avsession (媒体会话管理)
@ohos.multimedia.avsession (媒体会话管理)
媒体会话管理提供媒体播控相关功能的接口，目的是让应用接入播控中心。
该模块提供以下媒体会话相关的常用功能：
- AVSession : 会话，可用于设置元数据、播放状态信息等操作。
- AVSessionController: 会话控制器，可用于查看会话ID，完成对会话发送命令及事件，获取会话元数据、播放状态信息等操作。
- AVCastController: 投播控制器，可用于投播场景下，完成播放控制、远端播放状态监听、远端播放状态信息获取等操作。
说明：
本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
导入模块
import avSession from '@ohos.multimedia.avsession';
avSession.createAVSession10+
createAVSession(context: Context, tag: string, type: AVSessionType): Promise<AVSession>
创建会话对象，一个Ability只能存在一个会话，重复创建会失败，结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| context | Context | 是 | 应用上下文，提供获取应用程序环境信息的能力。 |
| tag | string | 是 | 会话的自定义名称。 |
| type | AVSessionType | 是 | 会话类型，当前支持音频和视频。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<AVSession> | Promise对象。回调返回会话实例对象，可用于获取会话ID，以及设置元数据、播放状态，发送按键事件等操作。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
import { BusinessError } from '@ohos.base';
let currentAVSession: avSession.AVSession;
let tag = "createNewSession";
let context: Context = getContext(this);
let sessionId: string; //供后续函数入参使用
avSession.createAVSession(context, tag, "audio").then((data: avSession.AVSession) => {
currentAVSession = data;
sessionId = currentAVSession.sessionId;
console.info(`CreateAVSession : SUCCESS : sessionId = ${sessionId}`);
}).catch((err: BusinessError) => {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
});
avSession.createAVSession10+
createAVSession(context: Context, tag: string, type: AVSessionType, callback: AsyncCallback<AVSession>): void
创建会话对象，一个Ability只能存在一个会话，重复创建会失败，结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| context | Context | 是 | 应用上下文，提供获取应用程序环境信息的能力。 |
| tag | string | 是 | 会话的自定义名称。 |
| type | AVSessionType | 是 | 会话类型，当前支持音频和视频。 |
| callback | AsyncCallback<AVSession> | 是 | 回调函数。回调返回会话实例对象，可用于获取会话ID，以及设置元数据、播放状态，发送按键事件等操作。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
import { BusinessError } from '@ohos.base';
let currentAVSession: avSession.AVSession;
let tag = "createNewSession";
let context: Context = getContext(this);
let sessionId: string; //供后续函数入参使用
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
sessionId = currentAVSession.sessionId;
console.info(`CreateAVSession : SUCCESS : sessionId = ${sessionId}`);
}
});
avSession.getAllSessionDescriptors
getAllSessionDescriptors(): Promise<Array<Readonly<AVSessionDescriptor>>>
获取所有会话的相关描述。结果通过Promise异步回调方式返回。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
返回值：
| 类型 | 说明 |
|---|---|
| Promise<Array<Readonly<AVSessionDescriptor>>> | Promise对象。返回所有会话描述的只读对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
import { BusinessError } from '@ohos.base';
avSession.getAllSessionDescriptors().then((descriptors: avSession.AVSessionDescriptor[]) => {
console.info(`getAllSessionDescriptors : SUCCESS : descriptors.length : ${descriptors.length}`);
if(descriptors.length > 0 ){
console.info(`getAllSessionDescriptors : SUCCESS : descriptors[0].isActive : ${descriptors[0].isActive}`);
console.info(`GetAllSessionDescriptors : SUCCESS : descriptors[0].type : ${descriptors[0].type}`);
console.info(`GetAllSessionDescriptors : SUCCESS : descriptors[0].sessionTag : ${descriptors[0].sessionTag}`);
}
}).catch((err: BusinessError) => {
console.error(`GetAllSessionDescriptors BusinessError: code: ${err.code}, message: ${err.message}`);
});
avSession.getAllSessionDescriptors
getAllSessionDescriptors(callback: AsyncCallback<Array<Readonly<AVSessionDescriptor>>>): void
获取所有会话的相关描述。结果通过callback异步回调方式返回。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback |
是 | 回调函数。返回所有会话描述的只读对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
import { BusinessError } from '@ohos.base';
avSession.getAllSessionDescriptors((err: BusinessError, descriptors: avSession.AVSessionDescriptor[]) => {
if (err) {
console.error(`GetAllSessionDescriptors BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`GetAllSessionDescriptors : SUCCESS : descriptors.length : ${descriptors.length}`);
if(descriptors.length > 0 ){
console.info(`getAllSessionDescriptors : SUCCESS : descriptors[0].isActive : ${descriptors[0].isActive}`);
console.info(`getAllSessionDescriptors : SUCCESS : descriptors[0].type : ${descriptors[0].type}`);
console.info(`getAllSessionDescriptors : SUCCESS : descriptors[0].sessionTag : ${descriptors[0].sessionTag}`);
}
}
});
avSession.getHistoricalSessionDescriptors10+
getHistoricalSessionDescriptors(maxSize?: number): Promise<Array<Readonly<AVSessionDescriptor>>>
获取所有会话的相关描述。结果通过Promise异步回调方式返回。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| maxSize | number | 否 | 指定获取描述符数量的最大值，可选范围是0-10，不填则取默认值，默认值为3。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<Array<Readonly<AVSessionDescriptor>>> | Promise对象。返回所有会话描述的只读对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
import { BusinessError } from '@ohos.base';
avSession.getHistoricalSessionDescriptors().then((descriptors: avSession.AVSessionDescriptor[]) => {
console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors.length : ${descriptors.length}`);
if(descriptors.length > 0 ){
console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].isActive : ${descriptors[0].isActive}`);
console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].type : ${descriptors[0].type}`);
console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].sessionTag : ${descriptors[0].sessionTag}`);
console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].sessionId : ${descriptors[0].sessionId}`);
console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].elementName.bundleName : ${descriptors[0].elementName.bundleName}`);
}
}).catch((err: BusinessError) => {
console.error(`getHistoricalSessionDescriptors BusinessError: code: ${err.code}, message: ${err.message}`);
});
avSession.getHistoricalSessionDescriptors10+
getHistoricalSessionDescriptors(maxSize: number, callback: AsyncCallback<Array<Readonly<AVSessionDescriptor>>>): void
获取所有会话的相关描述。结果通过callback异步回调方式返回。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| maxSize | number | 是 | 指定获取描述符数量的最大值，可选范围是0-10，不填则取默认值，默认值为3。 |
| callback | AsyncCallback |
是 | 回调函数。返回所有会话描述的只读对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
import { BusinessError } from '@ohos.base';
avSession.getHistoricalSessionDescriptors(1, (err: BusinessError, descriptors: avSession.AVSessionDescriptor[]) => {
if (err) {
console.error(`getHistoricalSessionDescriptors BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors.length : ${descriptors.length}`);
if(descriptors.length > 0 ){
console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].isActive : ${descriptors[0].isActive}`);
console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].type : ${descriptors[0].type}`);
console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].sessionTag : ${descriptors[0].sessionTag}`);
console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].sessionId : ${descriptors[0].sessionId}`);
console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].elementName.bundleName : ${descriptors[0].elementName.bundleName}`);
}
}
});
avSession.createController
createController(sessionId: string): Promise<AVSessionController>
根据会话ID创建会话控制器，可以创建多个会话控制器。结果通过Promise异步回调方式返回。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sessionId | string | 是 | 会话ID。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<AVSessionController> | Promise对象。返回会话控制器实例，可查看会话ID， 并完成对会话发送命令及事件，获取元数据、播放状态信息等操作。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
let sessionId: string = ""; //供后续函数入参使用
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
if (currentAVSession !== undefined) {
sessionId = currentAVSession.sessionId;
}
console.info(`CreateAVSession : SUCCESS : sessionId = ${sessionId}`);
}
});
let currentAVcontroller: avSession.AVSessionController|undefined = undefined;
avSession.createController(sessionId).then((avcontroller: avSession.AVSessionController) => {
currentAVcontroller = avcontroller;
console.info('CreateController : SUCCESS ');
}).catch((err: BusinessError) => {
console.error(`CreateController BusinessError: code: ${err.code}, message: ${err.message}`);
});
avSession.createController
createController(sessionId: string, callback: AsyncCallback<AVSessionController>): void
根据会话ID创建会话控制器，可以创建多个会话控制器。结果通过callback异步回调方式返回。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sessionId | string | 是 | 会话ID。 |
| callback | AsyncCallback<AVSessionController> | 是 | 回调函数。返回会话控制器实例，可查看会话ID， 并完成对会话发送命令及事件，获取元数据、播放状态信息等操作。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
let sessionId: string = ""; //供后续函数入参使用
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
if (currentAVSession !== undefined) {
sessionId = currentAVSession.sessionId;
}
console.info(`CreateAVSession : SUCCESS : sessionId = ${sessionId}`);
}
});
let currentAVcontroller: avSession.AVSessionController|undefined = undefined;
avSession.createController(sessionId, (err: BusinessError, avcontroller: avSession.AVSessionController) => {
if (err) {
console.error(`CreateController BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVcontroller = avcontroller;
console.info('CreateController : SUCCESS ');
}
});
avSession.castAudio
castAudio(session: SessionToken|‘all’, audioDevices: Array
投播会话到指定设备列表。结果通过Promise异步回调方式返回。
调用此接口之前，需要导入ohos.multimedia.audio模块获取AudioDeviceDescriptor的相关描述。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| session | SessionToken | ‘all’ | 是 | 会话令牌。SessionToken表示单个token；字符串'all'指所有token。 |
| audioDevices | Array<audio.AudioDeviceDescriptor> | 是 | 媒体设备列表。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当投播成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600104 | The remote session connection failed. |
示例：
import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';
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.`);
}).catch((err: BusinessError) => {
console.error(`GetDevices BusinessError: code: ${err.code}, message: ${err.message}`);
});
if (audioDevices !== undefined) {
avSession.castAudio('all', audioDevices as audio.AudioDeviceDescriptors).then(() => {
console.info(`CreateController : SUCCESS`);
}).catch((err: BusinessError) => {
console.error(`CreateController BusinessError: code: ${err.code}, message: ${err.message}`);
});
}
avSession.castAudio
castAudio(session: SessionToken|‘all’, audioDevices: Array
投播会话到指定设备列表。结果通过callback异步回调方式返回。
需要导入ohos.multimedia.audio模块获取AudioDeviceDescriptor的相关描述。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| session | SessionToken | ‘all’ | 是 | 会话令牌。SessionToken表示单个token；字符串'all'指所有token。 |
| audioDevices | Array<audio.AudioDeviceDescriptor> | 是 | 媒体设备列表。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当投播成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600104 | The remote session connection failed. |
示例：
import audio from '@ohos.multimedia.audio';
import { BusinessError } from '@ohos.base';
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.`);
}).catch((err: BusinessError) => {
console.error(`GetDevices BusinessError: code: ${err.code}, message: ${err.message}`);
});
if (audioDevices !== undefined) {
avSession.castAudio('all', audioDevices as audio.AudioDeviceDescriptors, (err: BusinessError) => {
if (err) {
console.error(`CastAudio BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`CastAudio : SUCCESS `);
}
});
}
SessionToken
会话令牌的信息。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sessionId | string | 是 | 会话ID |
| pid | number | 否 | 会话的进程ID |
| uid | number | 否 | 用户ID |
avSession.on(‘sessionCreate’)
on(type: ‘sessionCreate’, callback: (session: AVSessionDescriptor) => void): void
会话的创建监听事件。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持的事件是’sessionCreate’`：会话创建事件，检测到会话创建时触发。 |
| callback | (session: AVSessionDescriptor) => void | 是 | 回调函数。参数为会话相关描述。 |
错误码：
以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
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}`);
});
avSession.on(‘sessionDestroy’)
on(type: ‘sessionDestroy’, callback: (session: AVSessionDescriptor) => void): void
会话的销毁监听事件。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持的事件包括是'sessionDestroy'：会话销毁事件，检测到会话销毁时触发。 |
| callback | (session: AVSessionDescriptor) => void | 是 | 回调函数。参数为会话相关描述。 |
错误码：
以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
avSession.on('sessionDestroy', (descriptor: avSession.AVSessionDescriptor) => {
console.info(`on sessionDestroy : isActive : ${descriptor.isActive}`);
console.info(`on sessionDestroy : type : ${descriptor.type}`);
console.info(`on sessionDestroy : sessionTag : ${descriptor.sessionTag}`);
});
avSession.on(‘topSessionChange’)
on(type: ‘topSessionChange’, callback: (session: AVSessionDescriptor) => void): void
最新会话变更的监听事件。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持的事件包括是 'topSessionChange'：最新会话的变化事件，检测到最新的会话改变时触发。 |
| callback | (session: AVSessionDescriptor) => void | 是 | 回调函数。参数为会话相关描述。 |
错误码：
以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
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}`);
});
avSession.off(‘sessionCreate’)
off(type: ‘sessionCreate’, callback?: (session: AVSessionDescriptor) => void): void
取消会话创建事件监听，取消后，不再进行该事件的监听。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持的事件为：'sessionCreate'。 |
| callback | (session: AVSessionDescriptor) => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为会话相关描述，为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
avSession.off('sessionCreate');
avSession.off(‘sessionDestroy’)
off(type: ‘sessionDestroy’, callback?: (session: AVSessionDescriptor) => void): void
取消会话销毁事件监听，取消后，不再进行该事件的监听。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持的事件为'sessionDestroy'。 |
| callback | (session: AVSessionDescriptor) => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为会话相关描述，为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
avSession.off('sessionDestroy');
avSession.off(‘topSessionChange’)
off(type: ‘topSessionChange’, callback?: (session: AVSessionDescriptor) => void): void
取消最新会话变更事件监听，取消后，不再进行该事件的监听。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持的事件为'topSessionChange'。 |
| callback | (session: AVSessionDescriptor) => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为会话相关描述，为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
avSession.off('topSessionChange');
avSession.on(‘sessionServiceDie’)
on(type: ‘sessionServiceDie’, callback: () => void): void
监听会话的服务死亡事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
系统接口： 该接口为系统接口
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'sessionServiceDie'：会话服务死亡事件，检测到会话的服务死亡时触发。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
avSession.on('sessionServiceDie', () => {
console.info(`on sessionServiceDie : session is Died `);
});
avSession.off(‘sessionServiceDie’)
off(type: ‘sessionServiceDie’, callback?: () => void): void
取消会话服务死亡监听，取消后，不再进行服务死亡监听。
系统能力： SystemCapability.Multimedia.AVSession.Core
系统接口： 该接口为系统接口
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'sessionServiceDie'：会话服务死亡事件。 |
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的服务死亡监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
avSession.off('sessionServiceDie');
avSession.sendSystemAVKeyEvent
sendSystemAVKeyEvent(event: KeyEvent, callback: AsyncCallback<void>): void
发送按键事件给置顶会话。结果通过callback异步回调方式返回。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | KeyEvent | 是 | 按键事件。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当事件发送成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600105 | Invalid session command. |
示例：
import keyEvent from '@ohos.multimodalInput.keyEvent';
import { BusinessError } from '@ohos.base';
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, (err: BusinessError) => {
if (err) {
console.error(`SendSystemAVKeyEvent BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`SendSystemAVKeyEvent : SUCCESS `);
}
});
avSession.sendSystemAVKeyEvent
sendSystemAVKeyEvent(event: KeyEvent): Promise<void>
发送按键事件给置顶会话。结果通过Promise异步回调方式返回。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | KeyEvent | 是 | 按键事件。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当事件发送成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600105 | Invalid session command. |
示例：
import keyEvent from '@ohos.multimodalInput.keyEvent';
import { BusinessError } from '@ohos.base';
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(`SendSystemAVKeyEvent Successfully`);
}).catch((err: BusinessError) => {
console.error(`SendSystemAVKeyEvent BusinessError: code: ${err.code}, message: ${err.message}`);
});
avSession.sendSystemControlCommand
sendSystemControlCommand(command: AVControlCommand, callback: AsyncCallback<void>): void
发送控制命令给置顶会话。结果通过callback异步回调方式返回。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| command | AVControlCommand | 是 | AVSession的相关命令和命令相关参数。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当命令发送成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600105 | Invalid session command. |
| 6600107 | Too many commands or events. |
示例：
import avSession from '@ohos.multimedia.avsession';
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, (err) => {
if (err) {
console.error(`SendSystemControlCommand BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`sendSystemControlCommand successfully`);
}
});
avSession.sendSystemControlCommand
sendSystemControlCommand(command: AVControlCommand): Promise<void>
发送控制命令给置顶会话。结果通过Promise异步回调方式返回。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| command | AVControlCommand | 是 | AVSession的相关命令和命令相关参数。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当命令发送成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600105 | Invalid session command. |
| 6600107 | Too many commands or events. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
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(`SendSystemControlCommand successfully`);
}).catch((err: BusinessError) => {
console.error(`SendSystemControlCommand BusinessError: code: ${err.code}, message: ${err.message}`);
});
ProtocolType10+
远端设备支持的协议类型。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口。
| 名称 | 值 | 说明 |
|---|---|---|
| TYPE_LOCAL | 0 | 本地设备 |
| TYPE_CAST_PLUS_MIRROR | 1 | Cast+的镜像模式 |
| TYPE_CAST_PLUS_STREAM | 2 | Cast+的Stream模式 |
avSession.startCastDeviceDiscovery10+
startCastDeviceDiscovery(callback: AsyncCallback<void>): void
开始设备搜索发现。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数。当命令发送成功并开始搜索，err为undefined，否则返回错误对象。 |
示例：
import { BusinessError } from '@ohos.base';
avSession.startCastDeviceDiscovery((err: BusinessError) => {
if (err) {
console.error(`startCastDeviceDiscovery BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`startCastDeviceDiscovery successfully`);
}
});
avSession.startCastDeviceDiscovery10+
startCastDeviceDiscovery(filter: number, callback: AsyncCallback<void>): void
指定过滤条件，开始设备搜索发现。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| filter | number | 是 | 进行设备发现的过滤条件，由ProtocolType的组合而成 |
| callback | AsyncCallback<void> | 是 | 回调函数。当命令发送成功并开始搜索，err为undefined，否则返回错误对象。 |
示例：
import { BusinessError } from '@ohos.base';
let filter = 2;
avSession.startCastDeviceDiscovery(filter, (err: BusinessError) => {
if (err) {
console.error(`startCastDeviceDiscovery BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`startCastDeviceDiscovery successfully`);
}
});
avSession.startCastDeviceDiscovery10+
startCastDeviceDiscovery(filter?: number): Promise<void>
开始设备搜索发现。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| filter | number | 否 | 进行设备发现的过滤条件，由ProtocolType的组合而成 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当命令发送成功并开始搜索，无返回结果，否则返回错误对象。 |
示例：
import { BusinessError } from '@ohos.base';
let filter = 2;
avSession.startCastDeviceDiscovery(filter).then(() => {
console.info(`startCastDeviceDiscovery successfully`);
}).catch((err: BusinessError) => {
console.error(`startCastDeviceDiscovery BusinessError: code: ${err.code}, message: ${err.message}`);
});
avSession.stopCastDeviceDiscovery10+
stopCastDeviceDiscovery(callback: AsyncCallback<void>): void
结束设备搜索发现。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数。当成功停止搜索，err为undefined，否则返回错误对象。 |
示例：
import { BusinessError } from '@ohos.base';
avSession.stopCastDeviceDiscovery((err: BusinessError) => {
if (err) {
console.error(`stopCastDeviceDiscovery BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`stopCastDeviceDiscovery successfully`);
}
});
avSession.stopCastDeviceDiscovery10+
stopCastDeviceDiscovery(): Promise<void>
结束设备搜索发现。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口。
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当成功停止搜索，无返回结果，否则返回错误对象。 |
示例：
import { BusinessError } from '@ohos.base';
avSession.stopCastDeviceDiscovery().then(() => {
console.info(`startCastDeviceDiscovery successfully`);
}).catch((err: BusinessError) => {
console.error(`startCastDeviceDiscovery BusinessError: code: ${err.code}, message: ${err.message}`);
});
avSession.setDiscoverable10+
setDiscoverable(enable: boolean, callback: AsyncCallback<void>): void
设置设备是否可被发现，用于投播接收端。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enable | boolean | 是 | 是否允许本设备被发现. true: 允许被发现， false：不允许被发现 |
| callback | AsyncCallback<void> | 是 | 回调函数。当设置成功，err为undefined，否则返回错误对象。 |
示例：
import { BusinessError } from '@ohos.base';
avSession.setDiscoverable(true, (err: BusinessError) => {
if (err) {
console.error(`setDiscoverable BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`setDiscoverable successfully`);
}
});
avSession.setDiscoverable10+
setDiscoverable(enable: boolean): Promise<void>
设置设备是否可被发现，用于投播接收端。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enable | boolean | 是 | 是否允许本设备被发现. true: 允许被发现， false：不允许被发现 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当设置成功，无返回结果，否则返回错误对象。 |
示例：
import { BusinessError } from '@ohos.base';
avSession.setDiscoverable(true).then(() => {
console.info(`setDiscoverable successfully`);
}).catch((err: BusinessError) => {
console.error(`setDiscoverable BusinessError: code: ${err.code}, message: ${err.message}`);
});
avSession.on(‘deviceAvailable’)10+
on(type: ‘deviceAvailable’, callback: (device: OutputDeviceInfo) => void): void
设备发现回调监听。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'deviceAvailable'，有设备被发现时触发回调。 |
| callback | (device: OutputDeviceInfo) => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则返回错误对象。 |
示例：
import avSession from '@ohos.multimedia.avsession';
let castDevice: avSession.OutputDeviceInfo;
avSession.on('deviceAvailable', (device: avSession.OutputDeviceInfo) => {
castDevice = device;
console.info(`on deviceAvailable : ${device} `);
});
avSession.off(‘deviceAvailable’)10+
off(type: ‘deviceAvailable’, callback?: (device: OutputDeviceInfo) => void): void
取消设备发现回调的监听。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'deviceAvailable'：设备发现回调。 |
示例：
avSession.off('deviceAvailable');
avSession.getAVCastController10+
getAVCastController(sessionId: string, callback: AsyncCallback<AVCastController>): void
设备建立连接后，获取投播控制器。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES
系统接口： 该接口为系统接口
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sessionId | string | 是 | 用于指定要获取的投播控制器的sessionId |
| callback | AsyncCallback<AVCastController> | 是 | 回调函数，返回投播控制器实例。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception |
| 6600102 | session does not exist |
示例：
import { BusinessError } from '@ohos.base';
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
let sessionId: string = ""; //供后续函数入参使用
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
if (currentAVSession !== undefined) {
sessionId = currentAVSession.sessionId;
}
console.info(`CreateAVSession : SUCCESS : sessionId = ${sessionId}`);
}
});
let aVCastController: avSession.AVCastController;
avSession.getAVCastController(sessionId , (err: BusinessError, avcontroller: avSession.AVCastController) => {
if (err) {
console.error(`getAVCastController BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
aVCastController = avcontroller;
console.info('getAVCastController : SUCCESS ');
}
});
avSession.getAVCastController10+
getAVCastController(sessionId: string): Promise<AVCastController>;
设备建立连接后，获取投播控制器。结果通过Promise方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES
系统接口： 该接口为系统接口
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| sessionId | string | 是 | 用于指定要获取的投播控制器的sessionId |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<AVCastController> | Promise对象。返回投播控制器实例。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | server exception |
| 6600102 | The session does not exist |
示例：
import { BusinessError } from '@ohos.base';
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
let sessionId: string = ""; //供后续函数入参使用
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
if (currentAVSession !== undefined) {
sessionId = currentAVSession.sessionId;
}
console.info(`CreateAVSession : SUCCESS : sessionId = ${sessionId}`);
}
});
let aVCastController: avSession.AVCastController;
avSession.getAVCastController(sessionId).then((avcontroller: avSession.AVCastController) => {
aVCastController = avcontroller;
console.info('getAVCastController : SUCCESS');
}).catch((err: BusinessError) => {
console.error(`getAVCastController BusinessError: code: ${err.code}, message: ${err.message}`);
});
avSession.startCasting10+
startCasting(session: SessionToken, device: OutputDeviceInfo, callback: AsyncCallback<void>): void
启动投播。结果通过callback异步回调方式返回。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| session | SessionToken | 是 | 会话令牌。SessionToken表示单个token。 |
| device | OutputDeviceInfo | 是 | 设备相关信息 |
| callback | AsyncCallback<void> | 是 | 回调函数。当命令发送成功并启动投播，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600108 | Device connecting failed. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
let sessionId: string = ""; //供后续函数入参使用
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
if (currentAVSession !== undefined) {
sessionId = currentAVSession.sessionId;
}
console.info(`CreateAVSession : SUCCESS : sessionId = ${sessionId}`);
}
});
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, (err: BusinessError) => {
if (err) {
console.error(`startCasting BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`startCasting successfully`);
}
});
}
avSession.startCasting10+
startCasting(session: SessionToken, device: OutputDeviceInfo): Promise<void>
启动投播。结果通过Promise异步回调方式返回。
需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| session | SessionToken | 是 | 会话令牌。SessionToken表示单个token。 |
| device | OutputDeviceInfo | 是 | 设备相关信息 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当命令发送成功并启动投播，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600108 | Device connecting failed. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
let sessionId: string = ""; //供后续函数入参使用
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
if (currentAVSession !== undefined) {
sessionId = currentAVSession.sessionId;
}
console.info(`CreateAVSession : SUCCESS : sessionId = ${sessionId}`);
}
});
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(`startCasting successfully`);
}).catch((err: BusinessError) => {
console.error(`startCasting BusinessError: code: ${err.code}, message: ${err.message}`);
});
}
avSession.stopCasting10+
stopCasting(session: SessionToken, callback: AsyncCallback<void>): void
结束投播。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| session | SessionToken | 是 | 会话令牌。SessionToken表示单个token。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当成功结束投播，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600109 | The remote connection is not established. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
let sessionId: string = ""; //供后续函数入参使用
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
if (currentAVSession !== undefined) {
sessionId = currentAVSession.sessionId;
}
console.info(`CreateAVSession : SUCCESS : sessionId = ${sessionId}`);
}
});
let myToken: avSession.SessionToken = {
sessionId: sessionId,
}
avSession.stopCasting(myToken, (err: BusinessError) => {
if (err) {
console.error(`stopCasting BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`stopCasting successfully`);
}
});
avSession.stopCasting10+
stopCasting(session: SessionToken): Promise<void>
结束投播。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| session | SessionToken | 是 | 会话令牌。SessionToken表示单个token。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当成功结束投播，无返回结果，否则返回错误对象。 |
错误码：
错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600109 | The remote connection is not established. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
let sessionId: string = ""; //供后续函数入参使用
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
if (currentAVSession !== undefined) {
sessionId = currentAVSession.sessionId;
}
console.info(`CreateAVSession : SUCCESS : sessionId = ${sessionId}`);
}
});
let myToken: avSession.SessionToken = {
sessionId: sessionId,
}
avSession.stopCasting(myToken).then(() => {
console.info(`stopCasting successfully`);
}).catch((err: BusinessError) => {
console.error(`stopCasting BusinessError: code: ${err.code}, message: ${err.message}`);
});
AVSessionType10+
当前会话支持的会话类型。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 类型 | 说明 |
|---|---|---|
| audio | string | 音频 |
| video | string | 视频 |
AVSession10+
调用avSession.createAVSession后，返回会话的实例，可以获得会话ID，完成设置元数据，播放状态信息等操作。
属性
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| sessionId | string | 是 | 否 | AVSession对象唯一的会话标识。 |
| sessionType10+ | AVSessionType | 是 | 否 | AVSession会话类型。 |
示例：
import avSession from '@ohos.multimedia.avsession';
let sessionId: string = currentAVSession.sessionId;
let sessionType: avSession.AVSessionType = currentAVSession.sessionType;
setAVMetadata10+
setAVMetadata(data: AVMetadata): Promise<void>
设置会话元数据。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| data | AVMetadata | 是 | 会话元数据。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当元数据设置成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let metadata: avSession.AVMetadata = {
assetId: "121278",
title: "lose yourself",
artist: "Eminem",
author: "ST",
album: "Slim shady",
writer: "ST",
composer: "ST",
duration: 2222,
mediaImage: "https://www.example.com/example.jpg",
subtitle: "8 Mile",
description: "Rap",
lyric: "https://www.example.com/example.lrc",
previousAssetId: "121277",
nextAssetId: "121279",
};
currentAVSession.setAVMetadata(metadata).then(() => {
console.info(`SetAVMetadata successfully`);
}).catch((err: BusinessError) => {
console.error(`SetAVMetadata BusinessError: code: ${err.code}, message: ${err.message}`);
});
setAVMetadata10+
setAVMetadata(data: AVMetadata, callback: AsyncCallback<void>): void
设置会话元数据。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| data | AVMetadata | 是 | 会话元数据。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当元数据设置成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let metadata: avSession.AVMetadata = {
assetId: "121278",
title: "lose yourself",
artist: "Eminem",
author: "ST",
album: "Slim shady",
writer: "ST",
composer: "ST",
duration: 2222,
mediaImage: "https://www.example.com/example.jpg",
subtitle: "8 Mile",
description: "Rap",
lyric: "https://www.example.com/example.lrc",
previousAssetId: "121277",
nextAssetId: "121279",
};
currentAVSession.setAVMetadata(metadata, (err: BusinessError) => {
if (err) {
console.error(`SetAVMetadata BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`SetAVMetadata successfully`);
}
});
setAVPlaybackState10+
setAVPlaybackState(state: AVPlaybackState): Promise<void>
设置会话播放状态。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| data | AVPlaybackState | 是 | 会话播放状态，包括状态、倍数、循环模式等信息。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当播放状态设置成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let playbackState: avSession.AVPlaybackState = {
state:avSession.PlaybackState.PLAYBACK_STATE_PLAY,
speed: 1.0,
position:{elapsedTime:10, updateTime:(new Date()).getTime()},
bufferedTime:1000,
loopMode:avSession.LoopMode.LOOP_MODE_SINGLE,
isFavorite:true,
};
currentAVSession.setAVPlaybackState(playbackState).then(() => {
console.info(`SetAVPlaybackState successfully`);
}).catch((err: BusinessError) => {
console.info(`SetAVPlaybackState BusinessError: code: ${err.code}, message: ${err.message}`);
});
setAVPlaybackState10+
setAVPlaybackState(state: AVPlaybackState, callback: AsyncCallback<void>): void
设置会话播放状态。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| data | AVPlaybackState | 是 | 会话播放状态，包括状态、倍数、循环模式等信息。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当播放状态设置成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let PlaybackState: avSession.AVPlaybackState = {
state:avSession.PlaybackState.PLAYBACK_STATE_PLAY,
speed: 1.0,
position:{elapsedTime:10, updateTime:(new Date()).getTime()},
bufferedTime:1000,
loopMode:avSession.LoopMode.LOOP_MODE_SINGLE,
isFavorite:true,
};
currentAVSession.setAVPlaybackState(PlaybackState, (err: BusinessError) => {
if (err) {
console.info(`SetAVPlaybackState BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`SetAVPlaybackState successfully`);
}
});
setLaunchAbility10+
setLaunchAbility(ability: WantAgent): Promise<void>
设置一个WantAgent用于拉起会话的Ability。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| ability | WantAgent | 是 | 应用的相关属性信息，如bundleName，abilityName，deviceId等。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当Ability设置成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import wantAgent from '@ohos.app.ability.wantAgent';
import { BusinessError } from '@ohos.base';
//WantAgentInfo对象
let wantAgentInfo: wantAgent.WantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.example.myapplication",
abilityName: "EntryAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: wantAgent.OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
}
wantAgent.getWantAgent(wantAgentInfo).then((agent) => {
currentAVSession.setLaunchAbility(agent).then(() => {
console.info(`SetLaunchAbility successfully`);
}).catch((err: BusinessError) => {
console.error(`SetLaunchAbility BusinessError: code: ${err.code}, message: ${err.message}`);
});
});
setLaunchAbility10+
setLaunchAbility(ability: WantAgent, callback: AsyncCallback<void>): void
设置一个WantAgent用于拉起会话的Ability。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| ability | WantAgent | 是 | 应用的相关属性信息，如bundleName，abilityName，deviceId等。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当Ability设置成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import wantAgent from '@ohos.app.ability.wantAgent';
import { BusinessError } from '@ohos.base';
//WantAgentInfo对象
let wantAgentInfo: wantAgent.WantAgentInfo = {
wants: [
{
deviceId: "deviceId",
bundleName: "com.example.myapplication",
abilityName: "EntryAbility",
action: "action1",
entities: ["entity1"],
type: "MIMETYPE",
uri: "key={true,true,false}",
parameters:
{
mykey0: 2222,
mykey1: [1, 2, 3],
mykey2: "[1, 2, 3]",
mykey3: "ssssssssssssssssssssssssss",
mykey4: [false, true, false],
mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
mykey6: true,
}
}
],
operationType: wantAgent.OperationType.START_ABILITIES,
requestCode: 0,
wantAgentFlags:[wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
}
wantAgent.getWantAgent(wantAgentInfo).then((agent) => {
currentAVSession.setLaunchAbility(agent, (err: BusinessError) => {
if (err) {
console.error(`SetLaunchAbility BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`SetLaunchAbility successfully`);
}
});
});
dispatchSessionEvent10+
dispatchSessionEvent(event: string, args: {[key: string]: Object}): Promise<void>
媒体提供方设置一个会话内自定义事件，包括事件名和键值对形式的事件内容, 结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | string | 是 | 需要设置的会话事件的名称 |
| args | {[key: string]: any} | 是 | 需要传递的会话事件键值对 |
说明： 参数args支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等，详细介绍请参见@ohos.app.ability.Want(Want)。
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当事件设置成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
}
});
let eventName = "dynamic_lyric";
if (currentAVSession !== undefined) {
(currentAVSession as avSession.AVSession).dispatchSessionEvent(eventName, {lyric : "This is lyric"}).then(() => {
console.info(`dispatchSessionEvent successfully`);
}).catch((err: BusinessError) => {
console.info(`dispatchSessionEvent BusinessError: code: ${err.code}, message: ${err.message}`);
})
}
dispatchSessionEvent10+
dispatchSessionEvent(event: string, args: {[key: string]: Object}, callback: AsyncCallback<void>): void
媒体提供方设置一个会话内自定义事件，包括事件名和键值对形式的事件内容, 结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | string | 是 | 需要设置的会话事件的名称 |
| args | {[key: string]: any} | 是 | 需要传递的会话事件键值对 |
| callback | AsyncCallback<void> | 是 | 回调函数。当会话事件设置成功，err为undefined，否则返回错误对象。 |
说明：
参数args支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等，详细介绍请参见@ohos.app.ability.Want(Want)。
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
}
});
let eventName: string = "dynamic_lyric";
if (currentAVSession !== undefined) {
(currentAVSession as avSession.AVSession).dispatchSessionEvent(eventName, {lyric : "This is lyric"}, (err: BusinessError) => {
if(err) {
console.error(`dispatchSessionEvent BusinessError: code: ${err.code}, message: ${err.message}`);
}
})
}
setAVQueueItems10+
setAVQueueItems(items: Array<AVQueueItem>): Promise<void>
设置媒体播放列表。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| items | Array<AVQueueItem> | 是 | 播放列表单项的队列，用以表示播放列表。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当播放列表设置成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import image from '@ohos.multimedia.image';
import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';
import avSession from '@ohos.multimedia.avsession';
let value: Uint8Array|undefined = undefined;
let imageSource: image.ImageSource|undefined = undefined;
resourceManager.getSystemResourceManager().getRawFileContent('IMAGE_URI').then((data) => {
value = data;
});
if (value !== undefined) {
imageSource = image.createImageSource((value as Uint8Array).buffer);
}
let imagePixel: image.PixelMap|undefined = undefined;
if (imageSource !== undefined) {
(imageSource as image.ImageSource).createPixelMap({desiredSize:{width: 150, height: 150}}).then((data) => {
imagePixel = data;
}).catch((err: BusinessError) => {
console.error(`createPixelMap BusinessError: code: ${err.code}, message: ${err.message}`);
})
}
let queueItemDescription_1: avSession.AVMediaDescription = {
assetId: '001',
title: 'music_name',
subtitle: 'music_sub_name',
description: 'music_description',
mediaImage : imagePixel,
extras: {extras:'any'}
};
let queueItem_1: avSession.AVQueueItem = {
itemId: 1,
description: queueItemDescription_1
};
let queueItemDescription_2: avSession.AVMediaDescription = {
assetId: '002',
title: 'music_name',
subtitle: 'music_sub_name',
description: 'music_description',
mediaImage: imagePixel,
extras: {extras:'any'}
};
let queueItem_2: avSession.AVQueueItem = {
itemId: 2,
description: queueItemDescription_2
};
let queueItemsArray: avSession.AVQueueItem[] = [queueItem_1, queueItem_2];
currentAVSession.setAVQueueItems(queueItemsArray).then(() => {
console.info(`SetAVQueueItems successfully`);
}).catch((err: BusinessError) => {
console.error(`SetAVQueueItems BusinessError: code: ${err.code}, message: ${err.message}`);
});
setAVQueueItems10+
setAVQueueItems(items: Array<AVQueueItem>, callback: AsyncCallback<void>): void
设置媒体播放列表。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| items | Array<AVQueueItem> | 是 | 播放列表单项的队列，用以表示播放列表。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当播放状态设置成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import image from '@ohos.multimedia.image';
import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';
import avSession from '@ohos.multimedia.avsession';
let value: Uint8Array|undefined = undefined;
let imageSource: image.ImageSource|undefined = undefined;
resourceManager.getSystemResourceManager().getRawFileContent('IMAGE_URI').then((data) => {
value = data;
});
if (value !== undefined) {
imageSource = image.createImageSource((value as Uint8Array).buffer);
}
let imagePixel: image.PixelMap|undefined = undefined;
if (imageSource !== undefined) {
(imageSource as image.ImageSource).createPixelMap({desiredSize:{width: 150, height: 150}}).then((data) => {
imagePixel = data;
}).catch((err: BusinessError) => {
console.error(`createPixelMap BusinessError: code: ${err.code}, message: ${err.message}`);
})
}
let queueItemDescription_1: avSession.AVMediaDescription = {
assetId: '001',
title: 'music_name',
subtitle: 'music_sub_name',
description: 'music_description',
mediaImage : imagePixel,
extras: {extras:'any'}
};
let queueItem_1: avSession.AVQueueItem = {
itemId: 1,
description: queueItemDescription_1
};
let queueItemDescription_2: avSession.AVMediaDescription = {
assetId: '002',
title: 'music_name',
subtitle: 'music_sub_name',
description: 'music_description',
mediaImage: imagePixel,
extras: {extras:'any'}
};
let queueItem_2: avSession.AVQueueItem = {
itemId: 2,
description: queueItemDescription_2
};
let queueItemsArray: avSession.AVQueueItem[] = [queueItem_1, queueItem_2];
currentAVSession.setAVQueueItems(queueItemsArray, (err: BusinessError) => {
if (err) {
console.error(`SetAVQueueItems BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`SetAVQueueItems successfully`);
}
});
setAVQueueTitle10+
setAVQueueTitle(title: string): Promise<void>
设置媒体播放列表名称。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| title | string | 是 | 播放列表的名称。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当播放列表设置成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
let queueTitle = 'QUEUE_TITLE';
currentAVSession.setAVQueueTitle(queueTitle).then(() => {
console.info(`SetAVQueueTitle successfully`);
}).catch((err: BusinessError) => {
console.error(`SetAVQueueTitle BusinessError: code: ${err.code}, message: ${err.message}`);
});
setAVQueueTitle10+
setAVQueueTitle(title: string, callback: AsyncCallback<void>): void
设置媒体播放列表名称。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| title | string | 是 | 播放列表名称字段。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当播放状态设置成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
let queueTitle = 'QUEUE_TITLE';
currentAVSession.setAVQueueTitle(queueTitle, (err: BusinessError) => {
if (err) {
console.info(`SetAVQueueTitle BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.error(`SetAVQueueTitle successfully`);
}
});
setExtras10+
setExtras(extras: {[key: string]: Object}): Promise<void>
媒体提供方设置键值对形式的自定义媒体数据包, 结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| extras | {[key: string]: Object} | 是 | 需要传递的自定义媒体数据包键值对 |
说明：
参数extras支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等，详细介绍请参见@ohos.app.ability.Want(Want)。
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当自定义媒体数据包设置成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
}
});
if (currentAVSession !== undefined) {
(currentAVSession as avSession.AVSession).setExtras({extras : "This is custom media packet"}).then(() => {
console.info(`setExtras successfully`);
}).catch((err: BusinessError) => {
console.info(`setExtras BusinessError: code: ${err.code}, message: ${err.message}`);
})
}
setExtras10+
setExtras(extras: {[key: string]: Object}, callback: AsyncCallback<void>): void
媒体提供方设置键值对形式的自定义媒体数据包, 结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| extras | {[key: string]: any} | 是 | 需要传递的自定义媒体数据包键值对 |
| callback | AsyncCallback<void> | 是 | 回调函数。当自定义媒体数据包设置成功，err为undefined，否则返回错误对象。 |
说明：
参数extras支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等，详细介绍请参见@ohos.app.ability.Want(Want)。
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
}
});
if (currentAVSession !== undefined) {
(currentAVSession as avSession.AVSession).setExtras({extras : "This is custom media packet"}, (err: BusinessError) => {
if(err) {
console.error(`setExtras BusinessError: code: ${err.code}, message: ${err.message}`);
}
})
}
getController10+
getController(): Promise<AVSessionController>
获取本会话对应的控制器。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<AVSessionController> | Promise对象。返回会话控制器。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
let avsessionController: avSession.AVSessionController;
currentAVSession.getController().then((avcontroller: avSession.AVSessionController) => {
avsessionController = avcontroller;
console.info(`GetController : SUCCESS : sessionid : ${avsessionController.sessionId}`);
}).catch((err: BusinessError) => {
console.error(`GetController BusinessError: code: ${err.code}, message: ${err.message}`);
});
getController10+
getController(callback: AsyncCallback<AVSessionController>): void
获取本会话相应的控制器。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<AVSessionController> | 是 | 回调函数。返回会话控制器。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
let avsessionController: avSession.AVSessionController;
currentAVSession.getController((err: BusinessError, avcontroller: avSession.AVSessionController) => {
if (err) {
console.error(`GetController BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
avsessionController = avcontroller;
console.info(`GetController : SUCCESS : sessionid : ${avsessionController.sessionId}`);
}
});
getAVCastController10+
getAVCastController(callback: AsyncCallback<AVCastController>): void
设备建立连接后，获取投播控制器。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<AVCastController> | 是 | 回调函数，返回投播控制器实例。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600102 | The session does not exist. |
| 6600110 | The remote connection does not exist. |
示例：
import { BusinessError } from '@ohos.base';
let aVCastController: avSession.AVCastController;
currentAVSession.getAVCastController().then((avcontroller: avSession.AVCastController) => {
aVCastController = avcontroller;
console.info(`getAVCastController : SUCCESS`);
}).catch((err: BusinessError) => {
console.error(`getAVCastController BusinessError: code: ${err.code}, message: ${err.message}`);
});
getAVCastController10+
getAVCastController(): Promise<AVCastController>;
设备建立连接后，获取投播控制器。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
返回值：
| 类型 | 说明 |
|---|---|
| Promise<AVCastController> | Promise对象。返回投播控制器实例。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600102 | The session does not exist. |
| 6600110 | The remote connection does not exist. |
示例：
import { BusinessError } from '@ohos.base';
let aVCastController: avSession.AVCastController;
currentAVSession.getAVCastController((err: BusinessError, avcontroller: avSession.AVCastController) => {
if (err) {
console.error(`getAVCastController BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
aVCastController = avcontroller;
console.info(`getAVCastController : SUCCESS`);
}
});
getOutputDevice10+
getOutputDevice(): Promise<OutputDeviceInfo>
通过会话获取播放设备信息。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<OutputDeviceInfo> | Promise对象。返回播放设备信息。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
currentAVSession.getOutputDevice().then((outputDeviceInfo: avSession.OutputDeviceInfo) => {
console.info(`GetOutputDevice : SUCCESS : devices length : ${outputDeviceInfo.devices.length}`);
}).catch((err: BusinessError) => {
console.error(`GetOutputDevice BusinessError: code: ${err.code}, message: ${err.message}`);
})
getOutputDevice10+
getOutputDevice(callback: AsyncCallback<OutputDeviceInfo>): void
通过会话获取播放设备相关信息。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<OutputDeviceInfo> | 是 | 回调函数，返回播放设备信息。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
currentAVSession.getOutputDevice((err: BusinessError, outputDeviceInfo: avSession.OutputDeviceInfo) => {
if (err) {
console.error(`GetOutputDevice BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`GetOutputDevice : SUCCESS : devices length : ${outputDeviceInfo.devices.length}`);
}
});
activate10+
activate(): Promise<void>
激活会话，激活后可正常使用会话。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当会话激活成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
currentAVSession.activate().then(() => {
console.info(`Activate : SUCCESS `);
}).catch((err: BusinessError) => {
console.error(`Activate BusinessError: code: ${err.code}, message: ${err.message}`);
});
activate10+
activate(callback: AsyncCallback<void>): void
激活会话，激活后可正常使用会话。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数。当会话激活成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
currentAVSession.activate((err: BusinessError) => {
if (err) {
console.error(`Activate BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`Activate : SUCCESS `);
}
});
deactivate10+
deactivate(): Promise<void>
禁用当前会话的功能，可通过activate恢复。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当禁用会话成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
currentAVSession.deactivate().then(() => {
console.info(`Deactivate : SUCCESS `);
}).catch((err: BusinessError) => {
console.error(`Deactivate BusinessError: code: ${err.code}, message: ${err.message}`);
});
deactivate10+
deactivate(callback: AsyncCallback<void>): void
禁用当前会话。结果通过callback异步回调方式返回。
禁用当前会话的功能，可通过activate恢复。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数。当禁用会话成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
currentAVSession.deactivate((err: BusinessError) => {
if (err) {
console.error(`Deactivate BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`Deactivate : SUCCESS `);
}
});
destroy10+
destroy(): Promise<void>
销毁当前会话，使当前会话完全失效。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当会话销毁成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
currentAVSession.destroy().then(() => {
console.info(`Destroy : SUCCESS `);
}).catch((err: BusinessError) => {
console.error(`Destroy BusinessError: code: ${err.code}, message: ${err.message}`);
});
destroy10+
destroy(callback: AsyncCallback<void>): void
销毁当前会话，使当前会话完全失效。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数。当会话销毁成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
currentAVSession.destroy((err: BusinessError) => {
if (err) {
console.error(`Destroy BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`Destroy : SUCCESS `);
}
});
on(‘play’)10+
on(type: ‘play’, callback: () => void): void
设置播放命令监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持的事件为'play'当播放命令被发送到会话时，触发该事件回调。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.on('play', () => {
console.info(`on play entry`);
});
on(‘pause’)10+
on(type: ‘pause’, callback: () => void): void
设置暂停命令监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持的事件为'pause'，当暂停命令被发送到会话时，触发该事件回调。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.on('pause', () => {
console.info(`on pause entry`);
});
on(‘stop’)10+
on(type:‘stop’, callback: () => void): void
设置停止命令监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持的事件是'stop'，当停止命令被发送到会话时，触发该事件回调。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.on('stop', () => {
console.info(`on stop entry`);
});
on(‘playNext’)10+
on(type:‘playNext’, callback: () => void): void
设置播放下一首命令监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持的事件是'playNext'，当播放下一首命令被发送到会话时，触发该事件回调。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.on('playNext', () => {
console.info(`on playNext entry`);
});
on(‘playPrevious’)10+
on(type:‘playPrevious’, callback: () => void): void
设置播放上一首命令监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持的事件是'playPrevious'当播放上一首命令被发送到会话时，触发该事件回调。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.on('playPrevious', () => {
console.info(`on playPrevious entry`);
});
on(‘fastForward’)10+
on(type: ‘fastForward’, callback: () => void): void
设置快进命令监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持的事件是 'fastForward'，当快进命令被发送到会话时，触发该事件回调。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.on('fastForward', () => {
console.info(`on fastForward entry`);
});
on(‘rewind’)10+
on(type:‘rewind’, callback: () => void): void
设置快退命令监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持的事件是'rewind'，当快退命令被发送到会话时，触发该事件回调。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.on('rewind', () => {
console.info(`on rewind entry`);
});
on(‘seek’)10+
on(type: ‘seek’, callback: (time: number) => void): void
设置跳转节点监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'seek'：当跳转节点命令被发送到会话时，触发该事件。 |
| callback | (time: number) => void | 是 | 回调函数。参数time是时间节点，单位为毫秒。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.on('seek', (time: number) => {
console.info(`on seek entry time : ${time}`);
});
on(‘setSpeed’)10+
on(type: ‘setSpeed’, callback: (speed: number) => void): void
设置播放速率的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'setSpeed'：当设置播放速率的命令被发送到会话时，触发该事件。 |
| callback | (speed: number) => void | 是 | 回调函数。参数speed是播放倍速。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.on('setSpeed', (speed: number) => {
console.info(`on setSpeed speed : ${speed}`);
});
on(‘setLoopMode’)10+
on(type: ‘setLoopMode’, callback: (mode: LoopMode) => void): void
设置循环模式的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'setLoopMode'：当设置循环模式的命令被发送到会话时，触发该事件。 |
| callback | (mode: LoopMode) => void | 是 | 回调函数。参数mode是循环模式。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.on('setLoopMode', (mode: avSession.LoopMode) => {
console.info(`on setLoopMode mode : ${mode}`);
});
on(‘toggleFavorite’)10+
on(type: ‘toggleFavorite’, callback: (assetId: string) => void): void
设置是否收藏的监听事件
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'toggleFavorite'：当是否收藏的命令被发送到会话时，触发该事件。 |
| callback | (assetId: string) => void | 是 | 回调函数。参数assetId是媒体ID。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.on('toggleFavorite', (assetId: string) => {
console.info(`on toggleFavorite mode : ${assetId}`);
});
on(‘skipToQueueItem’)10+
on(type: ‘skipToQueueItem’, callback: (itemId: number) => void): void
设置播放列表其中某项被选中的监听事件，session端可以选择对这个单项歌曲进行播放。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'skipToQueueItem'：当播放列表选中单项的命令被发送到会话时，触发该事件。 |
| callback | (itemId: number) => void | 是 | 回调函数。参数itemId是选中的播放列表项的ID。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.on('skipToQueueItem', (itemId: number) => {
console.info(`on skipToQueueItem id : ${itemId}`);
});
on(‘handleKeyEvent’)10+
on(type: ‘handleKeyEvent’, callback: (event: KeyEvent) => void): void
设置按键事件的监听
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'handleKeyEvent'：当按键事件被发送到会话时，触发该事件。 |
| callback | (event: KeyEvent) => void | 是 | 回调函数。参数event是按键事件。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import keyEvent from '@ohos.multimodalInput.keyEvent';
currentAVSession.on('handleKeyEvent', (event: keyEvent.KeyEvent) => {
console.info(`on handleKeyEvent event : ${event}`);
});
on(‘outputDeviceChange’)10+
on(type: ‘outputDeviceChange’, callback: (state: ConnectionState, device: OutputDeviceInfo) => void): void
设置播放设备变化的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'outputDeviceChange'：当播放设备变化时，触发该事件。 |
| callback | (state: ConnectionState, device: OutputDeviceInfo) => void | 是 | 回调函数，参数device是设备相关信息。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.on('outputDeviceChange', (state: avSession.ConnectionState, device: avSession.OutputDeviceInfo) => {
console.info(`on outputDeviceChange device : ${device}`);
});
on(‘commonCommand’)10+
on(type: ‘commonCommand’, callback: (command: string, args: {[key: string]: Object}) => void): void
设置自定义控制命令变化的监听器。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'commonCommand'：当自定义控制命令变化时，触发该事件。 |
| callback | (commonCommand: string, args: {[key:string]: Object}) => void | 是 | 回调函数，commonCommand为变化的自定义控制命令名，args为自定义控制命令的参数，参数内容与sendCommand方法设置的参数内容完全一致。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
import avSession from '@ohos.multimedia.avsession';
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
}
});
if (currentAVSession !== undefined) {
(currentAVSession as avSession.AVSession).on('commonCommand', (commonCommand, args) => {
console.info(`OnCommonCommand, the command is ${commonCommand}, args: ${JSON.stringify(args)}`);
});
}
off(‘play’)10+
off(type: ‘play’, callback?: () => void): void
取消会话播放事件监听，关闭后，不再进行该事件回调。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 关闭对应的监听事件，支持的事件是'play' |
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('play');
off(‘pause’)10+
off(type: ‘pause’, callback?: () => void): void
取消会话暂停事件监听，关闭后，不再进行该事件回调。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 关闭对应的监听事件，支持的事件是'pause'。 |
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('pause');
off(‘stop’)10+
off(type: ‘stop’, callback?: () => void): void
取消会话停止事件监听，关闭后，不再进行该事件回调。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 关闭对应的监听事件，支持的事件是'stop'。 |
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('stop');
off(‘playNext’)10+
off(type: ‘playNext’, callback?: () => void): void
取消会话播放下一首事件监听，关闭后，不再进行该事件回调。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 关闭对应的监听事件，支持的事件是 'playNext'。 |
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('playNext');
off(‘playPrevious’)10+
off(type: ‘playPrevious’, callback?: () => void): void
取消会话播放上一首事件监听，关闭后，不再进行该事件回调。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 关闭对应的监听事件，支持的事件是'playPrevious'。 |
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('playPrevious');
off(‘fastForward’)10+
off(type: ‘fastForward’, callback?: () => void): void
取消会话快进事件监听，关闭后，不再进行该事件回调。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 关闭对应的监听事件，支持的事件是'fastForward'。 |
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('fastForward');
off(‘rewind’)10+
off(type: ‘rewind’, callback?: () => void): void
取消会话快退事件监听，关闭后，不再进行该事件回调。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 关闭对应的监听事件，支持的事件是'rewind'。 |
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('rewind');
off(‘seek’)10+
off(type: ‘seek’, callback?: (time: number) => void): void
取消监听跳转节点事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 关闭对应的监听事件，支持关闭事件'seek'。 |
| callback | (time: number) => void | 否 | 回调函数，参数time是时间节点，单位为毫秒。 当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('seek');
off(‘setSpeed’)10+
off(type: ‘setSpeed’, callback?: (speed: number) => void): void
取消监听播放速率变化事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 关闭对应的监听事件，支持关闭事件'setSpeed'。 |
| callback | (speed: number) => void | 否 | 回调函数，参数speed是播放倍速。 当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('setSpeed');
off(‘setLoopMode’)10+
off(type: ‘setLoopMode’, callback?: (mode: LoopMode) => void): void
取消监听循环模式变化事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 关闭对应的监听事件，支持关闭事件'setLoopMode'。 |
| callback | (mode: LoopMode) => void | 否 | 回调函数，参数mode是循环模式。 当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('setLoopMode');
off(‘toggleFavorite’)10+
off(type: ‘toggleFavorite’, callback?: (assetId: string) => void): void
取消监听是否收藏的事件
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 关闭对应的监听事件，支持关闭事件'toggleFavorite'。 |
| callback | (assetId: string) => void | 否 | 回调函数，参数assetId是媒体ID。 当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('toggleFavorite');
off(‘skipToQueueItem’)10+
off(type: ‘skipToQueueItem’, callback?: (itemId: number) => void): void
取消监听播放列表单项选中的事件
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 关闭对应的监听事件，支持关闭事件'skipToQueueItem'。 |
| callback | (itemId: number) => void | 否 | 回调函数，参数itemId是播放列表单项ID。 当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('skipToQueueItem');
off(‘handleKeyEvent’)10+
off(type: ‘handleKeyEvent’, callback?: (event: KeyEvent) => void): void
取消监听按键事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 关闭对应的监听事件，支持关闭事件'handleKeyEvent'。 |
| callback | (event: KeyEvent) => void | 否 | 回调函数，参数event是按键事件。 当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('handleKeyEvent');
off(‘outputDeviceChange’)10+
off(type: ‘outputDeviceChange’, callback?: (state: ConnectionState, device: OutputDeviceInfo) => void): void
取消监听播放设备变化的事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 关闭对应的监听事件，支持关闭事件'outputDeviceChange'。 |
| callback | (state: ConnectionState, device: OutputDeviceInfo) => void | 否 | 回调函数，参数device是设备相关信息。 当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('outputDeviceChange');
off(‘commonCommand’)10+
off(type: ‘commonCommand’, callback?: (command: string, args: {[key:string]: Object}) => void): void
取消监听自定义控制命令的变化。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'commonCommand'。 |
| callback | (command: string, args: {[key:string]: Object}) => void | 否 | 回调函数，参数command是变化的自定义控制命令名，args为自定义控制命令的参数。 该参数为可选参数，若不填写该参数，则认为取消所有对command事件的监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
currentAVSession.off('commonCommand');
stopCasting10+
stopCasting(callback: AsyncCallback<void>): void
结束投播。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数。当命令发送成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600109 | The remote connection is not established. |
示例：
import { BusinessError } from '@ohos.base';
currentAVSession.stopCasting((err: BusinessError) => {
if (err) {
console.info(`stopCasting BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`stopCasting successfully`);
}
});
stopCasting10+
stopCasting(): Promise<void>
结束投播。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当成功结束投播，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600109 | The remote connection is not established. |
示例：
import { BusinessError } from '@ohos.base';
currentAVSession.stopCasting().then(() => {
console.info(`stopCasting successfully`);
}).catch((err: BusinessError) => {
console.info(`stopCasting BusinessError: code: ${err.code}, message: ${err.message}`);
});
getOutputDeviceSync10+
getOutputDeviceSync(): OutputDeviceInfo
使用同步方法获取当前输出设备信息。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| OutputDeviceInfo | 当前输出设备信息。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
示例：
import { BusinessError } from '@ohos.base';
try {
let currentOutputDevice: avSession.OutputDeviceInfo = currentAVSession.getOutputDeviceSync();
} catch (err: BusinessError) {
console.info(`getOutputDeviceSync error, error code: ${err.code}, error message: ${err.message}`);
}
AVCastControlCommandType10+
投播控制器可传递的命令。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
| 名称 | 类型 | 说明 |
|---|---|---|
| play | string | 播放 |
| pause | string | 暂停 |
| stop | string | 停止 |
| playNext | string | 下一首 |
| playPrevious | string | 上一首 |
| fastForward | string | 快进 |
| rewind | string | 快退 |
| seek | numbder | 跳转某一节点 |
| setSpeed | number | 设置播放倍速 |
| setLoopMode | string | 设置循环模式 |
| toggleFavorite | string | 是否收藏 |
| setVolume | number | 设置音量 |
AVCastControlCommand10+
投播控制器接受的命令的对象描述。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| command | AVCastControlCommandType | 是 | 命令 |
| parameter | LoopMode | string | number | 否 | 命令对应的参数 |
AVCastController10+
在投播建立后，调用avSession.getAVCastController后，返回会话控制器实例。控制器可查看会话ID，并可完成对会话发送命令及事件，获取会话元数据，播放状态信息等操作。
setDisplaySurface10+
setDisplaySurface(surfaceId: string): Promise<void>
设置播放的surfaceId，在投播sink端使用。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口。
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。返回设置结果。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600109 | The remote connection is not established. |
示例：
import media from '@ohos.multimedia.media';
let surfaceID: string = '';
media.createAVRecorder().then((avRecorder) => {
avRecorder.getInputSurface((err: BusinessError, surfaceId: string) => {
if (err == null) {
console.info('getInputSurface success');
surfaceID = surfaceId;
} else {
console.error('getInputSurface failed and error is ' + err.message);
}
});
})
aVCastController.setDisplaySurface(surfaceID).then(() => {
console.info(`setDisplaySurface : SUCCESS`);
});
setDisplaySurface10+
setDisplaySurface(surfaceId: string, callback: AsyncCallback<void>): void
设置播放的surfaceId，在投播sink端使用。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口。
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数，返回当前设置结果。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600109 | The remote connection is not established. |
示例：
import { BusinessError } from '@ohos.base';
import media from '@ohos.multimedia.media';
let surfaceID: string = '';
media.createAVRecorder().then((avRecorder) => {
avRecorder.getInputSurface((err: BusinessError, surfaceId: string) => {
if (err == null) {
console.info('getInputSurface success');
surfaceID = surfaceId;
} else {
console.error('getInputSurface failed and error is ' + err.message);
}
});
})
aVCastController.setDisplaySurface(surfaceID, (err: BusinessError) => {
if (err) {
console.info(`setDisplaySurface BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`setDisplaySurface : SUCCESS`);
}
});
getAVPlaybackState10+
getAVPlaybackState(callback: AsyncCallback<AVPlaybackState>): void
获取当前的远端播放状态。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<[AVPlaybackState> | 是 | 回调函数，返回远端播放状态。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception |
示例：
import { BusinessError } from '@ohos.base';
aVCastController.getAVPlaybackState((err: BusinessError, state: avSession.AVPlaybackState) => {
if (err) {
console.error(`getAVPlaybackState BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`getAVPlaybackState : SUCCESS`);
}
});
getAVPlaybackState10+
getAVPlaybackState(): Promise<AVPlaybackState>;
获取当前的远端播放状态。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
返回值：
| 类型 | 说明 |
|---|---|
| Promise<AVPlaybackState> | Promise对象。返回远端播放状态。。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception |
示例：
import { BusinessError } from '@ohos.base';
aVCastController.getAVPlaybackState().then((state: avSession.AVPlaybackState) => {
console.info(`getAVPlaybackState : SUCCESS`);
}).catch((err: BusinessError) => {
console.error(`getAVPlaybackState BusinessError: code: ${err.code}, message: ${err.message}`);
});
sendControlCommand10+
sendControlCommand(command: AVCastControlCommand): Promise<void>
通过控制器发送命令到其对应的会话。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| command | AVCastControlCommand | 是 | 会话的相关命令和命令相关参数。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当命令发送成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600105 | Invalid session command. |
| 6600109 | The remote connection is not established. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let avCommand: avSession.AVCastControlCommand = {command:'play'};
// let avCommand = {command:'pause'};
// let avCommand = {command:'stop'};
// let avCommand = {command:'playNext'};
// let avCommand = {command:'playPrevious'};
// let avCommand = {command:'fastForward'};
// let avCommand = {command:'rewind'};
// let avCommand = {command:'seek', parameter:10};
aVCastController.sendControlCommand(avCommand).then(() => {
console.info(`SendControlCommand successfully`);
}).catch((err: BusinessError) => {
console.error(`SendControlCommand BusinessError: code: ${err.code}, message: ${err.message}`);
});
sendControlCommand10+
sendControlCommand(command: AVCastControlCommand, callback: AsyncCallback<void>): void
通过会话控制器发送命令到其对应的会话。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| command | AVCastControlCommand | 是 | 会话的相关命令和命令相关参数。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当命令发送成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600105 | Invalid session command. |
| 6600109 | The remote connection is not established. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let avCommand: avSession.AVCastControlCommand = {command:'play'};
// let avCommand = {command:'pause'};
// let avCommand = {command:'stop'};
// let avCommand = {command:'playNext'};
// let avCommand = {command:'playPrevious'};
// let avCommand = {command:'fastForward'};
// let avCommand = {command:'rewind'};
// let avCommand = {command:'seek', parameter:10};
aVCastController.sendControlCommand(avCommand, (err: BusinessError) => {
if (err) {
console.error(`SendControlCommand BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`SendControlCommand successfully`);
}
});
prepare10+
prepare(item: AVQueueItem, callback: AsyncCallback<void>): void
准备播放媒体资源，即进行播放资源的加载和缓冲。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| item | AVQueueItem | 是 | 播放列表中单项的相关属性。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当命令发送成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600109 | The remote connection is not established. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
// 设置播放参数，开始播放
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'
}
};
// 准备播放，这个不会触发真正的播放，会进行加载和缓冲
aVCastController.prepare(playItem, (err: BusinessError) => {
if (err) {
console.error(`prepare BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`prepare successfully`);
}
});
prepare10+
prepare(item: AVQueueItem): Promise<void>
准备播放媒体资源，即进行播放资源的加载和缓冲。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| item | AVQueueItem | 是 | 播放列表中单项的相关属性。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当命令发送成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600109 | The remote connection is not established. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
// 设置播放参数，开始播放
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'
}
};
// 准备播放，这个不会触发真正的播放，会进行加载和缓冲
aVCastController.prepare(playItem).then(() => {
console.info(`prepare successfully`);
}).catch((err: BusinessError) => {
console.error(`prepare BusinessError: code: ${err.code}, message: ${err.message}`);
});
start10+
start(item: AVQueueItem, callback: AsyncCallback<void>): void
启动播放某个媒体资源。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| item | AVQueueItem | 是 | 播放列表中单项的相关属性。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当命令发送成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600109 | The remote connection is not established. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
// 设置播放参数，开始播放
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'
}
};
// 启动播放
aVCastController.start(playItem, (err: BusinessError) => {
if (err) {
console.error(`start BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`start successfully`);
}
});
start10+
start(item: AVQueueItem): Promise<void>
启动播放某个媒体资源。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| item | AVQueueItem | 是 | 播放列表中单项的相关属性。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当命令发送成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600109 | The remote connection is not established. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
// 设置播放参数，开始播放
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'
}
};
// 启动播放
aVCastController.start(playItem).then(() => {
console.info(`start successfully`);
}).catch((err: BusinessError) => {
console.info(`start BusinessError: code: ${err.code}, message: ${err.message}`);
});
getCurrentItem10+
getCurrentItem(callback: AsyncCallback<AVQueueItem>): void
获取当前投播的资源信息。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<AVQueueItem> | 是 | 回调函数。当命令发送成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
import { BusinessError } from '@ohos.base';
aVCastController.getCurrentItem((err: BusinessError, value: avSession.AVQueueItem) => {
if (err) {
console.error(`getCurrentItem BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`getCurrentItem successfully`);
}
});
getCurrentItem10+
getCurrentItem(): Promise<AVQueueItem>
获取当前投播的资源信息。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
返回值：
| 类型 | 说明 |
|---|---|
| Promise<AVQueueItem> | Promise对象，返回当前的播放资源，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
import { BusinessError } from '@ohos.base';
aVCastController.getCurrentItem().then((value: avSession.AVQueueItem) => {
console.info(`getCurrentItem successfully`);
}).catch((err: BusinessError) => {
console.error(`getCurrentItem BusinessError: code: ${err.code}, message: ${err.message}`);
});
on(‘playbackStateChange’)10+
on(type: ‘playbackStateChange’, filter: Array<keyof AVPlaybackState>|‘all’, callback: (state: AVPlaybackState) => void): void
设置播放状态变化的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'playbackStateChange'：当播放状态变化时，触发该事件。 |
| filter | Array<keyof AVPlaybackState> | ‘all’ | 是 | ‘all’ 表示关注播放状态所有字段变化；Array |
| callback | (state: AVPlaybackState) => void | 是 | 回调函数，参数state是变化后的播放状态。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
aVCastController.on('playbackStateChange', 'all', (playbackState: avSession.AVPlaybackState) => {
console.info(`on playbackStateChange state : ${playbackState.state}`);
});
let playbackFilter = ['state', 'speed', 'loopMode'];
aVCastController.on('playbackStateChange', playbackFilter, (playbackState: avSession.AVPlaybackState) => {
console.info(`on playbackStateChange state : ${playbackState.state}`);
});
off(‘playbackStateChange’)10+
off(type: ‘playbackStateChange’, callback?: (state: AVPlaybackState) => void): void
媒体控制器取消监听播放状态变化的事件。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'playbackStateChange'。 |
| callback | (state: AVPlaybackState) => void | 否 | 回调函数，参数state是变化后的播放状态。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
aVCastController.off('playbackStateChange');
on(‘mediaItemChange’)10+
on(type: ‘mediaItemChange’, callback: Callback<AVQueueItem>): void
设置投播当前播放媒体内容的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'mediaItemChange'：当播放的媒体内容变化时，触发该事件。 |
| callback | (state: AVQueueItem) => void | 是 | 回调函数，参数AVQueueItem是当前正在播放的媒体内容。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
aVCastController.on('mediaItemChange', (item: avSession.AVQueueItem) => {
console.info(`on mediaItemChange state : ${item.itemId}`);
});
off(‘mediaItemChange’)10+
off(type: ‘mediaItemChange’): void
取消设置投播当前播放媒体内容的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'mediaItemChange'。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
aVCastController.off('mediaItemChange');
on(‘playNext’)10+
on(type: ‘playNext’, callback: Callback<void>): void
设置播放下一首资源的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'playNext'：当播放下一首状态变化时，触发该事件。 |
| callback | Callback<void> | 是 | 回调函数 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
aVCastController.on('playNext', () => {
console.info(`on playNext`);
});
off(‘playNext’)10+
off(type: ‘playNext’): void
取消设置播放下一首资源的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'playNext'。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
aVCastController.off('playNext');
on(‘playPrevious’)10+
on(type: ‘playPrevious’, callback: Callback<void>): void
设置播放上一首资源的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'playPrevious'：当播放上一首状态变化时，触发该事件。 |
| callback | Callback<void> | 是 | 回调函数 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
aVCastController.on('playPrevious', () => {
console.info(`on playPrevious`);
});
off(‘playPrevious’)10+
off(type: ‘playPrevious’): void
取消设置播放上一首资源的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'playPrevious'。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
aVCastController.off('playPrevious');
on(‘seekDone’)10+
on(type: ‘seekDone’, callback: Callback<number>): void
设置seek结束的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'seekDone'：当seek结束时，触发该事件。 |
| callback | Callback<number> | 是 | 回调函数，返回seek后播放的位置 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
aVCastController.on('seekDone', (pos: number) => {
console.info(`on seekDone pos：${pos} `);
});
off(‘seekDone’)10+
off(type: ‘seekDone’): void
取消设置seek结束的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'seekDone'。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
aVCastController.off('seekDone');
on(‘videoSizeChange’)10+
on(type: ‘videoSizeChange’, callback: (width:number, height:number) => void): void
设置video尺寸更改监听事件。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'videoSizeChange'：当video尺寸更改时，触发该事件。 |
| callback | (width:number, height:number) => void | 是 | 回调函数，返回video的宽度和高度 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
aVCastController.on('videoSizeChange', (width: number, height: number) => {
console.info(`width ：${width} `);
console.info(`height：${height} `);
});
off(‘videoSizeChange’)10+
off(type: ‘videoSizeChange’): void
取消设置video尺寸更改监听事件。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
系统接口： 该接口为系统接口
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'videoSizeChange'。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
示例：
aVCastController.off('videoSizeChange');
on(‘error’)10+
on(type: ‘error’, callback: ErrorCallback): void
监听远端播放器的错误事件，该事件仅用于错误提示，不需要用户停止播控动作。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 错误事件回调类型，支持的事件：’error’，用户操作和系统都会触发此事件。 |
| callback | function | 是 | 错误事件回调方法：远端播放过程中发生的错误，会提供错误码ID和错误信息。 |
错误码：
以下错误码的详细介绍请参见媒体服务错误码。
| 错误码ID | 错误信息 |
|---|---|
| 5400101 | No memory. |
| 5400102 | Operation not allowed. |
| 5400103 | I/O error. |
| 5400104 | Time out. |
| 5400105 | Service died. |
| 5400106 | Unsupport format. |
| 6600101 | Session service exception. |
示例：
import { BusinessError } from '@ohos.base'
aVCastController.on('error', (error: BusinessError) => {
console.error('error happened,and error message is :' + error.message)
console.error('error happened,and error code is :' + error.code)
})
off(‘error’)10+
off(type: ‘error’): void
取消监听播放的错误事件。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 错误事件回调类型，取消注册的事件：’error’ |
错误码：
以下错误码的详细介绍请参见媒体服务错误码。
| 错误码ID | 错误信息 |
|---|---|
| 5400101 | No memory. |
| 5400102 | Operation not allowed. |
| 5400103 | I/O error. |
| 5400104 | Time out. |
| 5400105 | Service died. |
| 5400106 | Unsupport format. |
| 6600101 | Session service exception. |
示例：
aVCastController.off('error')
ConnectionState10+
连接状态枚举。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 值 | 说明 |
|---|---|---|
| STATE_CONNECTING | 0 | 设备连接中 |
| STATE_CONNECTED | 1 | 设备连接成功 |
| STATE_DISCONNECTED | 6 | 设备断开连接 |
AVMetadata10+
媒体元数据的相关属性。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| assetId | string | 是 | 媒体ID。 |
| title | string | 否 | 标题。 |
| artist | string | 否 | 艺术家。 |
| author | string | 否 | 专辑作者。 |
| album | string | 否 | 专辑名称。 |
| writer | string | 否 | 词作者。 |
| composer | string | 否 | 作曲者。 |
| duration | number | 否 | 媒体时长，单位毫秒（ms）。 |
| mediaImage | image.PixelMap | string | 否 | 图片的像素数据或者图片路径地址(本地路径或网络路径)。 |
| publishDate | Date | 否 | 发行日期。 |
| subtitle | string | 否 | 子标题。 |
| description | string | 否 | 媒体描述。 |
| lyric | string | 否 | 歌词文件路径地址(本地路径或网络路径) |
| previousAssetId | string | 否 | 上一首媒体ID。 |
| nextAssetId | string | 否 | 下一首媒体ID。 |
AVMediaDescription10+
播放列表媒体元数据的相关属性。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| assetId | string | 是 | 播放列表媒体ID。 |
| title | string | 否 | 播放列表媒体标题。 |
| subtitle | string | 否 | 播放列表媒体子标题。 |
| description | string | 否 | 播放列表媒体描述的文本。 |
| mediaImage | image.PixelMap | 否 | 播放列表媒体图片像素数据。 |
| extras | {[key: string]: any} | 否 | 播放列表媒体额外字段。 |
| mediaUri | string | 否 | 播放列表媒体URI。 |
| mediaType | string | 否 | 播放列表媒体类型。 |
| mediaSize | number | 否 | 播放列表媒体的大小。 |
| albumTitle | string | 否 | 播放列表媒体专辑标题。 |
| albumCoverUri | string | 否 | 播放列表媒体专辑标题URI。 |
| lyricContent | string | 否 | 播放列表媒体歌词内容。 |
| lyricUri | string | 否 | 播放列表媒体歌词URI。 |
| artist | string | 否 | 播放列表媒体专辑作者。 |
| fdSrc | media.AVFileDescriptor | 否 | 播放列表媒体本地文件的句柄。 |
| duration | number | 否 | 播放列表媒体播放时长。 |
| startPosition | number | 否 | 播放列表媒体起始播放位置。 |
| creditsPosition | number | 否 | 播放列表媒体的片尾播放位置。 |
| appName | string | 否 | 播放列表提供的应用的名字。 |
AVQueueItem10+
播放列表中单项的相关属性。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| itemId | number | 是 | 播放列表中单项的ID。 |
| description | AVMediaDescription | 是 | 播放列表中单项的媒体元数据。 |
AVPlaybackState10+
媒体播放状态的相关属性。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| state | PlaybackState | 否 | 播放状态 |
| speed | number | 否 | 播放倍速 |
| position | PlaybackPosition | 否 | 播放位置 |
| bufferedTime | number | 否 | 缓冲时间 |
| loopMode | LoopMode | 否 | 循环模式 |
| isFavorite | boolean | 否 | 是否收藏 |
| activeItemId10+ | number | 否 | 正在播放的媒体Id |
| volume10+ | number | 否 | 正在播放的媒体音量 |
| extras10+ | {[key: string]: Object} | 否 | 自定义媒体数据 |
PlaybackPosition10+
媒体播放位置的相关属性。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| elapsedTime | number | 是 | 已用时间，单位毫秒（ms）。 |
| updateTime | number | 是 | 更新时间，单位毫秒（ms）。 |
AVCastCategory10+
投播的类别枚举。
系统能力： SystemCapability.Multimedia.AVSession.AVCast
| 名称 | 值 | 说明 |
|---|---|---|
| CATEGORY_LOCAL | 0 | 本地播放，默认播放设备，声音从本机或者连接的蓝牙耳机设备出声。 |
| CATEGORY_REMOTE | 1 | 远端播放，远端播放设备，声音从其他设备发出声音或者画面。 |
DeviceType10+
播放设备的类型枚举。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 值 | 说明 |
|---|---|---|
| DEVICE_TYPE_LOCAL | 0 | 本地播放类型 |
| DEVICE_TYPE_BLUETOOTH | 10 | 蓝牙设备 |
| DEVICE_TYPE_TV | 2 | 电视 系统能力： SystemCapability.Multimedia.AVSession.AVCast |
| DEVICE_TYPE_SMART_SPEAKER | 3 | 音箱设备 系统能力： SystemCapability.Multimedia.AVSession.AVCast |
DeviceInfo10+
播放设备的相关信息。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| castCategory | AVCastCategory | 是 | 投播的类别。 |
| deviceId | string | 是 | 播放设备的ID。 |
| deviceName | string | 是 | 播放设备的名称。 |
| deviceType | DeviceType | 是 | 播放设备的类型。 |
| ipAddress | string | 否 | 播放设备的ip地址。 此接口为系统接口。 系统能力： SystemCapability.Multimedia.AVSession.AVCast |
| providerId | number | 否 | 播放设备提供商。 此接口为系统接口。 系统能力： SystemCapability.Multimedia.AVSession.AVCast |
OutputDeviceInfo10+
播放设备的相关信息。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| devices | Array<DeviceInfo> | 是 | 播放设备的集合。 |
LoopMode10+
表示媒体播放循环模式的枚举。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 值 | 说明 |
|---|---|---|
| LOOP_MODE_SEQUENCE | 0 | 顺序播放 |
| LOOP_MODE_SINGLE | 1 | 单曲循环 |
| LOOP_MODE_LIST | 2 | 表单循环 |
| LOOP_MODE_SHUFFLE | 3 | 随机播放 |
PlaybackState10+
表示媒体播放状态的枚举。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 值 | 说明 |
|---|---|---|
| PLAYBACK_STATE_INITIAL | 0 | 初始状态 |
| PLAYBACK_STATE_PREPARE | 1 | 播放准备状态 |
| PLAYBACK_STATE_PLAY | 2 | 正在播放 |
| PLAYBACK_STATE_PAUSE | 3 | 暂停 |
| PLAYBACK_STATE_FAST_FORWARD | 4 | 快进 |
| PLAYBACK_STATE_REWIND | 5 | 快退 |
| PLAYBACK_STATE_STOP | 6 | 停止 |
| PLAYBACK_STATE_COMPLETED | 7 | 播放完成 |
| PLAYBACK_STATE_RELEASED | 8 | 释放 |
| PLAYBACK_STATE_ERROR | 9 | 错误 |
AVSessionDescriptor
会话的相关描述信息。
系统能力： SystemCapability.Multimedia.AVSession.Manager
系统接口： 该接口为系统接口。
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| sessionId | string | 是 | 否 | 会话ID |
| type | AVSessionType | 是 | 否 | 会话类型 |
| sessionTag | string | 是 | 否 | 会话的自定义名称 |
| elementName | ElementName | 是 | 否 | 会话所属应用的信息（包含bundleName、abilityName等） |
| isActive | boolean | 是 | 否 | 会话是否被激活 |
| isTopSession | boolean | 是 | 否 | 会话是否为最新的会话 |
| outputDevice | OutputDeviceInfo | 是 | 否 | 分布式设备相关信息 |
AVSessionController10+
调用avSession.createController后，返回会话控制器实例。控制器可查看会话ID，并可完成对会话发送命令及事件，获取会话元数据，播放状态信息等操作。
属性
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
|---|---|---|---|---|
| sessionId | string | 是 | 否 | AVSessionController对象唯一的会话标识。 |
示例：
import { BusinessError } from '@ohos.base';
let AVSessionController: avSession.AVSessionController;
avSession.createController(currentAVSession.sessionId).then((controller: avSession.AVSessionController) => {
AVSessionController = controller;
}).catch((err: BusinessError) => {
console.error(`CreateController BusinessError: code: ${err.code}, message: ${err.message}`);
});
getAVPlaybackState10+
getAVPlaybackState(callback: AsyncCallback<AVPlaybackState>): void
获取当前的远端播放状态。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<[AVPlaybackState> | 是 | 回调函数，返回远端播放状态。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.getAVPlaybackState((err: BusinessError, state: avSession.AVPlaybackState) => {
if (err) {
console.error(`getAVPlaybackState BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`getAVPlaybackState : SUCCESS`);
}
});
getAVPlaybackState10+
getAVPlaybackState(): Promise<AVPlaybackState>;
获取当前的远端播放状态。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<AVPlaybackState> | Promise对象。返回远端播放状态。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.getAVPlaybackState().then((state: avSession.AVPlaybackState) => {
console.info(`getAVPlaybackState : SUCCESS`);
}).catch((err: BusinessError) => {
console.error(`getAVPlaybackState BusinessError: code: ${err.code}, message: ${err.message}`);
});
getAVMetadata10+
getAVMetadata(): Promise<AVMetadata>
获取会话元数据。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<AVMetadata> | Promise对象，返回会话元数据。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.getAVMetadata().then((metadata: avSession.AVMetadata) => {
console.info(`GetAVMetadata : SUCCESS : assetId : ${metadata.assetId}`);
}).catch((err: BusinessError) => {
console.error(`GetAVMetadata BusinessError: code: ${err.code}, message: ${err.message}`);
});
getAVMetadata10+
getAVMetadata(callback: AsyncCallback<AVMetadata>): void
获取会话元数据。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<AVMetadata> | 是 | 回调函数，返回会话元数据。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.getAVMetadata((err: BusinessError, metadata: avSession.AVMetadata) => {
if (err) {
console.error(`GetAVMetadata BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`GetAVMetadata : SUCCESS : assetId : ${metadata.assetId}`);
}
});
getAVQueueTitle10+
getAVQueueTitle(): Promise<string>
获取当前会话播放列表的名称。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise |
Promise对象。返回播放列表名称。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.getAVQueueTitle().then((title: string) => {
console.info(`GetAVQueueTitle : SUCCESS : title : ${title}`);
}).catch((err: BusinessError) => {
console.error(`GetAVQueueTitle BusinessError: code: ${err.code}, message: ${err.message}`);
});
getAVQueueTitle10+
getAVQueueTitle(callback: AsyncCallback<string>): void
获取当前播放列表的名称。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback |
是 | 回调函数，返回播放列表名称。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.getAVQueueTitle((err: BusinessError, title: string) => {
if (err) {
console.error(`GetAVQueueTitle BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`GetAVQueueTitle : SUCCESS : title : ${title}`);
}
});
getAVQueueItems10+
getAVQueueItems(): Promise<Array<AVQueueItem>>
获取当前会话播放列表相关信息。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise |
Promise对象。返回播放列表队列。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.getAVQueueItems().then((items: avSession.AVQueueItem[]) => {
console.info(`GetAVQueueItems : SUCCESS : length : ${items.length}`);
}).catch((err: BusinessError) => {
console.error(`GetAVQueueItems BusinessError: code: ${err.code}, message: ${err.message}`);
});
getAVQueueItems10+
getAVQueueItems(callback: AsyncCallback<Array<AVQueueItem>>): void
获取当前播放列表相关信息。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback |
是 | 回调函数，返回播放列表队列。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.getAVQueueItems((err: BusinessError, items: avSession.AVQueueItem[]) => {
if (err) {
console.error(`GetAVQueueItems BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`GetAVQueueItems : SUCCESS : length : ${items.length}`);
}
});
skipToQueueItem10+
skipToQueueItem(itemId: number): Promise<void>
设置指定播放列表单项的ID，发送给session端处理，session端可以选择对这个单项歌曲进行播放。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| itemId | number | 是 | 播放列表单项的ID值，用以表示选中的播放列表单项。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当播放列表单项ID设置成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
let queueItemId = 0;
avsessionController.skipToQueueItem(queueItemId).then(() => {
console.info(`SkipToQueueItem successfully`);
}).catch((err: BusinessError) => {
console.error(`SkipToQueueItem BusinessError: code: ${err.code}, message: ${err.message}`);
});
skipToQueueItem10+
skipToQueueItem(itemId: number, callback: AsyncCallback<void>): void
设置指定播放列表单项的ID，发送给session端处理，session端可以选择对这个单项歌曲进行播放。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| itemId | number | 是 | 播放列表单项的ID值，用以表示选中的播放列表单项。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当播放状态设置成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
let queueItemId = 0;
avsessionController.skipToQueueItem(queueItemId, (err: BusinessError) => {
if (err) {
console.error(`SkipToQueueItem BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`SkipToQueueItem successfully`);
}
});
getOutputDevice10+
getOutputDevice(): Promise<OutputDeviceInfo>
获取播放设备信息。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<OutputDeviceInfo> | Promise对象，返回播放设备信息。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 600101 | Session service exception. |
| 600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.getOutputDevice().then((deviceInfo: avSession.OutputDeviceInfo) => {
console.info(`GetOutputDevice : SUCCESS`);
}).catch((err: BusinessError) => {
console.error(`GetOutputDevice BusinessError: code: ${err.code}, message: ${err.message}`);
});
getOutputDevice10+
getOutputDevice(callback: AsyncCallback<OutputDeviceInfo>): void
获取播放设备信息。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<OutputDeviceInfo> | 是 | 回调函数，返回播放设备信息。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 600101 | Session service exception. |
| 600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.getOutputDevice((err: BusinessError, deviceInfo: avSession.OutputDeviceInfo) => {
if (err) {
console.error(`GetOutputDevice BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`GetOutputDevice : SUCCESS`);
}
});
sendAVKeyEvent10+
sendAVKeyEvent(event: KeyEvent): Promise<void>
发送按键事件到控制器对应的会话。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | KeyEvent | 是 | 按键事件。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 600101 | Session service exception. |
| 600102 | The session does not exist. |
| 600103 | The session controller does not exist. |
| 600105 | Invalid session command. |
| 600106 | The session is not activated. |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当事件发送成功，无返回结果，否则返回错误对象。 |
示例：
import keyEvent from '@ohos.multimodalInput.keyEvent';
import { BusinessError } from '@ohos.base';
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};
avsessionController.sendAVKeyEvent(event).then(() => {
console.info(`SendAVKeyEvent Successfully`);
}).catch((err: BusinessError) => {
console.error(`SendAVKeyEvent BusinessError: code: ${err.code}, message: ${err.message}`);
});
sendAVKeyEvent10+
sendAVKeyEvent(event: KeyEvent, callback: AsyncCallback<void>): void
发送按键事件到会话。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | KeyEvent | 是 | 按键事件。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当事件发送成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 600101 | Session service exception. |
| 600102 | The session does not exist. |
| 600103 | The session controller does not exist. |
| 600105 | Invalid session command. |
| 600106 | The session is not activated. |
示例：
import keyEvent from '@ohos.multimodalInput.keyEvent';
import { BusinessError } from '@ohos.base';
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};
avsessionController.sendAVKeyEvent(event, (err: BusinessError) => {
if (err) {
console.error(`SendAVKeyEvent BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`SendAVKeyEvent Successfully`);
}
});
getLaunchAbility10+
getLaunchAbility(): Promise<WantAgent>
获取应用在会话中保存的WantAgent对象。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<WantAgent> | Promise对象，返回在setLaunchAbility保存的对象，包括应用的相关属性信息，如bundleName，abilityName，deviceId等。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.getLaunchAbility().then((agent: object) => {
console.info(`GetLaunchAbility : SUCCESS : wantAgent : ${agent}`);
}).catch((err: BusinessError) => {
console.error(`GetLaunchAbility BusinessError: code: ${err.code}, message: ${err.message}`);
});
getLaunchAbility10+
getLaunchAbility(callback: AsyncCallback<WantAgent>): void
获取应用在会话中保存的WantAgent对象。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<WantAgent> | 是 | 回调函数。返回在setLaunchAbility保存的对象，包括应用的相关属性信息，如bundleName，abilityName，deviceId等。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.getLaunchAbility((err: BusinessError, agent: object) => {
if (err) {
console.error(`GetLaunchAbility BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`GetLaunchAbility : SUCCESS : wantAgent : ${agent}`);
}
});
getRealPlaybackPositionSync10+
getRealPlaybackPositionSync(): number
获取当前播放位置。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| number | 时间节点，毫秒数。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
let time: number = avsessionController.getRealPlaybackPositionSync();
isActive10+
isActive(): Promise<boolean>
获取会话是否被激活。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise |
Promise对象，返回会话是否为激活状态，true表示被激活，false表示禁用。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.isActive().then((isActive: boolean) => {
console.info(`IsActive : SUCCESS : isactive : ${isActive}`);
}).catch((err: BusinessError) => {
console.error(`IsActive BusinessError: code: ${err.code}, message: ${err.message}`);
});
isActive10+
isActive(callback: AsyncCallback<boolean>): void
判断会话是否被激活。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback |
是 | 回调函数，返回会话是否为激活状态，true表示被激活，false表示禁用。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.isActive((err: BusinessError, isActive: boolean) => {
if (err) {
console.error(`IsActive BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`IsActive : SUCCESS : isactive : ${isActive}`);
}
});
destroy10+
destroy(): Promise<void>
销毁当前控制器，销毁后当前控制器不可再用。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当控制器销毁成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.destroy().then(() => {
console.info(`Destroy : SUCCESS `);
}).catch((err: BusinessError) => {
console.error(`Destroy BusinessError: code: ${err.code}, message: ${err.message}`);
});
destroy10+
destroy(callback: AsyncCallback<void>): void
销毁当前控制器，销毁后当前控制器不可再用。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<void> | 是 | 回调函数。当控制器销毁成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.destroy((err: BusinessError) => {
if (err) {
console.error(`Destroy BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`Destroy : SUCCESS `);
}
});
getValidCommands10+
getValidCommands(): Promise<Array<AVControlCommandType>>
获取会话支持的有效命令。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise |
Promise对象。返回有效命令的集合。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.getValidCommands().then((validCommands: avSession.AVControlCommandType[]) => {
console.info(`GetValidCommands : SUCCESS : size : ${validCommands.length}`);
}).catch((err: BusinessError) => {
console.error(`GetValidCommands BusinessError: code: ${err.code}, message: ${err.message}`);
});
getValidCommands10+
getValidCommands(callback: AsyncCallback<Array<AVControlCommandType>>): void
获取会话支持的有效命令。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<Array<AVControlCommandType>> | 是 | 回调函数，返回有效命令的集合。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
avsessionController.getValidCommands((err: BusinessError, validCommands: avSession.AVControlCommandType[]) => {
if (err) {
console.error(`GetValidCommands BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`GetValidCommands : SUCCESS : size : ${validCommands.length}`);
}
});
sendControlCommand10+
sendControlCommand(command: AVControlCommand): Promise<void>
通过控制器发送命令到其对应的会话。结果通过Promise异步回调方式返回。
说明：
媒体控制方在使用sendControlCommand命令前，需要确保控制对应的媒体会话注册了对应的监听，注册媒体会话相关监听的方法请参见接口on’play’、on’pause’等。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| command | AVControlCommand | 是 | 会话的相关命令和命令相关参数。 |
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当命令发送成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
| 6600105 | Invalid session command. |
| 6600106 | The session is not activated. |
| 6600107 | Too many commands or events. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let avCommand: avSession.AVControlCommand = {command:'play'};
// let avCommand = {command:'pause'};
// let avCommand = {command:'stop'};
// let avCommand = {command:'playNext'};
// let avCommand = {command:'playPrevious'};
// let avCommand = {command:'fastForward'};
// let avCommand = {command:'rewind'};
// let avCommand = {command:'seek', parameter:10};
// let avCommand = {command:'setSpeed', parameter:2.6};
// let avCommand = {command:'setLoopMode', parameter:avSession.LoopMode.LOOP_MODE_SINGLE};
// let avCommand = {command:'toggleFavorite', parameter:"false"};
avsessionController.sendControlCommand(avCommand).then(() => {
console.info(`SendControlCommand successfully`);
}).catch((err: BusinessError) => {
console.error(`SendControlCommand BusinessError: code: ${err.code}, message: ${err.message}`);
});
sendControlCommand10+
sendControlCommand(command: AVControlCommand, callback: AsyncCallback<void>): void
通过会话控制器发送命令到其对应的会话。结果通过callback异步回调方式返回。
说明：
媒体控制方在使用sendControlCommand命令前，需要确保控制对应的媒体会话注册了对应的监听，注册媒体会话相关监听的方法请参见接口on’play’、on’pause’等。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| command | AVControlCommand | 是 | 会话的相关命令和命令相关参数。 |
| callback | AsyncCallback<void> | 是 | 回调函数。当命令发送成功，err为undefined，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
| 6600105 | Invalid session command. |
| 6600106 | The session is not activated. |
| 6600107 | Too many commands or events. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let avCommand: avSession.AVControlCommand = {command:'play'};
// let avCommand = {command:'pause'};
// let avCommand = {command:'stop'};
// let avCommand = {command:'playNext'};
// let avCommand = {command:'playPrevious'};
// let avCommand = {command:'fastForward'};
// let avCommand = {command:'rewind'};
// let avCommand = {command:'seek', parameter:10};
// let avCommand = {command:'setSpeed', parameter:2.6};
// let avCommand = {command:'setLoopMode', parameter:avSession.LoopMode.LOOP_MODE_SINGLE};
// let avCommand = {command:'toggleFavorite', parameter:"false"};
avsessionController.sendControlCommand(avCommand, (err: BusinessError) => {
if (err) {
console.info(`SendControlCommand BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.error(`SendControlCommand successfully`);
}
});
sendCommonCommand10+
sendCommonCommand(command: string, args: {[key: string]: Object}): Promise<void>
通过会话控制器发送自定义控制命令到其对应的会话。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| command | string | 是 | 需要设置的自定义控制命令的名称 |
| args | {[key: string]: any} | 是 | 需要传递的控制命令键值对 |
说明： 参数args支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等，详细介绍请参见@ohos.app.ability.Want(Want)。
返回值：
| 类型 | 说明 |
|---|---|
| Promise<void> | Promise对象。当命令发送成功，无返回结果，否则返回错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
| 6600105 | Invalid session command. |
| 6600106 | The session is not activated. |
| 6600107 | Too many commands or events. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let avSessionController: avSession.AVSessionController|undefined = undefined;
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
let sessionId: string = "";
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
}
});
if (currentAVSession !== undefined) {
sessionId = (currentAVSession as avSession.AVSession).sessionId;
avSession.createController(sessionId).then((controller: avSession.AVSessionController) => {
avSessionController = controller;
}).catch((err: BusinessError) => {
console.error(`CreateController BusinessError: code: ${err.code}, message: ${err.message}`);
});
}
let commandName = "my_command";
if (avSessionController !== undefined) {
(avSessionController as avSession.AVSessionController).sendCommonCommand(commandName, {command : "This is my command"}).then(() => {
console.info(`SendCommonCommand successfully`);
}).catch((err: BusinessError) => {
console.info(`SendCommonCommand BusinessError: code: ${err.code}, message: ${err.message}`);
})
}
sendCommonCommand10+
sendCommonCommand(command: string, args: {[key: string]: Object}, callback: AsyncCallback<void>): void
通过会话控制器发送自定义命令到其对应的会话。结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| command | string | 是 | 需要设置的自定义控制命令的名称 |
| args | {[key: string]: any} | 是 | 需要传递的控制命令键值对 |
| callback | AsyncCallback<void> | 是 | 回调函数。当命令发送成功，err为undefined，否则返回错误对象。 |
说明： 参数args支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等，详细介绍请参见@ohos.app.ability.Want(Want)。
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
| 6600105 | Invalid session command. |
| 6600106 | The session is not activated. |
| 6600107 | Too many commands or events. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let avSessionController: avSession.AVSessionController|undefined = undefined;
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
}
});
if (currentAVSession !== undefined) {
avSession.createController((currentAVSession as avSession.AVSession).sessionId).then((controller: avSession.AVSessionController) => {
avSessionController = controller;
}).catch((err: BusinessError) => {
console.error(`CreateController BusinessError: code: ${err.code}, message: ${err.message}`);
});
}
let commandName = "my_command";
if (avSessionController !== undefined) {
(avSessionController as avSession.AVSessionController).sendCommonCommand(commandName, {command : "This is my command"}, (err: BusinessError) => {
if(err) {
console.info(`SendCommonCommand BusinessError: code: ${err.code}, message: ${err.message}`);
}
})
}
getExtras10+
getExtras(): Promise<{[key: string]: Object}>
获取媒体提供方设置的自定义媒体数据包。结果通过Promise异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Promise<{[key: string]: Object}> | Promise对象，返回媒体提供方设置的自定义媒体数据包，数据包的内容与setExtras设置的内容完全一致。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
| 6600105 | Invalid session command. |
| 6600107 | Too many commands or events. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let avSessionController: avSession.AVSessionController|undefined = undefined;
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
}
});
if (currentAVSession !== undefined) {
avSession.createController((currentAVSession as avSession.AVSession).sessionId).then((controller: avSession.AVSessionController) => {
avSessionController = controller;
}).catch((err: BusinessError) => {
console.error(`CreateController BusinessError: code: ${err.code}, message: ${err.message}`);
});
}
if (avSessionController !== undefined) {
(avSessionController as avSession.AVSessionController).getExtras().then((extras) => {
console.info(`getExtras : SUCCESS : ${extras}`);
}).catch((err: BusinessError) => {
console.info(`getExtras BusinessError: code: ${err.code}, message: ${err.message}`);
});
}
getExtras10+
getExtras(callback: AsyncCallback<{[key: string]: Object}>): void
获取媒体提供方设置的自定义媒体数据包,结果通过callback异步回调方式返回。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | AsyncCallback<{[key: string]: Object}> | 是 | 回调函数，返回媒体提供方设置的自定义媒体数据包，数据包的内容与setExtras设置的内容完全一致。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
| 6600105 | Invalid session command. |
| 6600107 | Too many commands or events. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let avSessionController: avSession.AVSessionController|undefined = undefined;
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
}
});
if (currentAVSession !== undefined) {
avSession.createController((currentAVSession as avSession.AVSession).sessionId).then((controller: avSession.AVSessionController) => {
avSessionController = controller;
}).catch((err: BusinessError) => {
console.error(`CreateController BusinessError: code: ${err.code}, message: ${err.message}`);
});
}
if (avSessionController !== undefined) {
(avSessionController as avSession.AVSessionController).getExtras((err, extras) => {
if (err) {
console.error(`getExtras BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
console.info(`getExtras : SUCCESS : ${extras}`);
}
});
}
on(‘metadataChange’)10+
on(type: ‘metadataChange’, filter: Array<keyof AVMetadata>|‘all’, callback: (data: AVMetadata) => void)
设置元数据变化的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'metadataChange'：当元数据变化时，触发该事件。 |
| filter | Array<keyof AVMetadata> | ‘all’ | 是 | ‘all’ 表示关注元数据所有字段变化；Array |
| callback | (data: AVMetadata) => void | 是 | 回调函数，参数data是变化后的元数据。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.on('metadataChange', 'all', (metadata: avSession.AVMetadata) => {
console.info(`on metadataChange assetId : ${metadata.assetId}`);
});
avsessionController.on('metadataChange', ['assetId', 'title', 'description'], (metadata: avSession.AVMetadata) => {
console.info(`on metadataChange assetId : ${metadata.assetId}`);
});
off(‘metadataChange’)10+
off(type: ‘metadataChange’, callback?: (data: AVMetadata) => void)
媒体控制器取消监听元数据变化的事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'metadataChange'。 |
| callback | (data: AVMetadata) => void | 否 | 回调函数，参数data是变化后的元数据。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.off('metadataChange');
on(‘playbackStateChange’)10+
on(type: ‘playbackStateChange’, filter: Array<keyof AVPlaybackState>|‘all’, callback: (state: AVPlaybackState) => void)
设置播放状态变化的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'playbackStateChange'：当播放状态变化时，触发该事件。 |
| filter | Array<keyof AVPlaybackState> | ‘all’ | 是 | ‘all’ 表示关注播放状态所有字段变化；Array |
| callback | (state: AVPlaybackState) => void | 是 | 回调函数，参数state是变化后的播放状态。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.on('playbackStateChange', 'all', (playbackState: avSession.AVPlaybackState) => {
console.info(`on playbackStateChange state : ${playbackState.state}`);
});
avsessionController.on('playbackStateChange', ['state', 'speed', 'loopMode'], (playbackState: avSession.AVPlaybackState) => {
console.info(`on playbackStateChange state : ${playbackState.state}`);
});
off(‘playbackStateChange’)10+
off(type: ‘playbackStateChange’, callback?: (state: AVPlaybackState) => void)
媒体控制器取消监听播放状态变化的事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'playbackStateChange'。 |
| callback | (state: AVPlaybackState) => void | 否 | 回调函数，参数state是变化后的播放状态。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.off('playbackStateChange');
on(‘sessionDestroy’)10+
on(type: ‘sessionDestroy’, callback: () => void)
会话销毁的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'sessionDestroy'：当检测到会话销毁时，触发该事件）。 |
| callback | () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.on('sessionDestroy', () => {
console.info(`on sessionDestroy : SUCCESS `);
});
off(‘sessionDestroy’)10+
off(type: ‘sessionDestroy’, callback?: () => void)
媒体控制器取消监听会话的销毁事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'sessionDestroy'。 |
| callback | () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.off('sessionDestroy');
on(‘activeStateChange’)10+
on(type: ‘activeStateChange’, callback: (isActive: boolean) => void)
会话的激活状态的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'activeStateChange'：当检测到会话的激活状态发生改变时，触发该事件。 |
| callback | (isActive: boolean) => void | 是 | 回调函数。参数isActive表示会话是否被激活。true表示被激活，false表示禁用。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.on('activeStateChange', (isActive: boolean) => {
console.info(`on activeStateChange : SUCCESS : isActive ${isActive}`);
});
off(‘activeStateChange’)10+
off(type: ‘activeStateChange’, callback?: (isActive: boolean) => void)
媒体控制器取消监听会话激活状态变化的事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'activeStateChange'。 |
| callback | (isActive: boolean) => void | 否 | 回调函数。参数isActive表示会话是否被激活。true表示被激活，false表示禁用。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.off('activeStateChange');
on(‘validCommandChange’)10+
on(type: ‘validCommandChange’, callback: (commands: Array<AVControlCommandType>) => void)
会话支持的有效命令变化监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'validCommandChange'：当检测到会话的合法命令发生改变时，触发该事件。 |
| callback | (commands: Array<AVControlCommandType>) => void | 是 | 回调函数。参数commands是有效命令的集合。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.on('validCommandChange', (validCommands: avSession.AVControlCommandType[]) => {
console.info(`validCommandChange : SUCCESS : size : ${validCommands.length}`);
console.info(`validCommandChange : SUCCESS : validCommands : ${validCommands.values()}`);
});
off(‘validCommandChange’)10+
off(type: ‘validCommandChange’, callback?: (commands: Array<AVControlCommandType>) => void)
媒体控制器取消监听会话有效命令变化的事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'validCommandChange'。 |
| callback | (commands: Array<AVControlCommandType>) => void | 否 | 回调函数。参数commands是有效命令的集合。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.off('validCommandChange');
on(‘outputDeviceChange’)10+
on(type: ‘outputDeviceChange’, callback: (state: ConnectionState, device: OutputDeviceInfo) => void): void
设置播放设备变化的监听事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件为'outputDeviceChange'：当播放设备变化时，触发该事件）。 |
| callback | (state: ConnectionState, device: OutputDeviceInfo) => void | 是 | 回调函数，参数device是设备相关信息。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.on('outputDeviceChange', (state: avSession.ConnectionState, device: avSession.OutputDeviceInfo) => {
console.info(`on outputDeviceChange state: ${state}, device : ${device}`);
});
off(‘outputDeviceChange’)10+
off(type: ‘outputDeviceChange’, callback?: (state: ConnectionState, device: OutputDeviceInfo) => void): void
媒体控制器取消监听分布式设备变化的事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'outputDeviceChange'。 |
| callback | (state: ConnectionState, device: OutputDeviceInfo) => void | 否 | 回调函数，参数device是设备相关信息。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.off('outputDeviceChange');
on(‘sessionEvent’)10+
on(type: ‘sessionEvent’, callback: (sessionEvent: string, args: {[key:string]: Object}) => void): void
媒体控制器设置会话自定义事件变化的监听器。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'sessionEvent'：当会话事件变化时，触发该事件。 |
| callback | (sessionEvent: string, args: {[key:string]: object}) => void | 是 | 回调函数，sessionEvent为变化的会话事件名，args为事件的参数。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let avSessionController: avSession.AVSessionController|undefined = undefined;
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
}
});
if (currentAVSession !== undefined) {
avSession.createController((currentAVSession as avSession.AVSession).sessionId).then((controller: avSession.AVSessionController) => {
avSessionController = controller;
}).catch((err: BusinessError) => {
console.error(`CreateController BusinessError: code: ${err.code}, message: ${err.message}`);
});
}
if (avSessionController !== undefined) {
(avSessionController as avSession.AVSessionController).on('sessionEvent', (sessionEvent, args) => {
console.info(`OnSessionEvent, sessionEvent is ${sessionEvent}, args: ${JSON.stringify(args)}`);
});
}
off(‘sessionEvent’)10+
off(type: ‘sessionEvent’, callback?: (sessionEvent: string, args: {[key:string]: Object}) => void): void
媒体控制器取消监听会话事件的变化通知。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'sessionEvent'。 |
| callback | (sessionEvent: string, args: {[key:string]: Object}) => void | 否 | 回调函数，参数sessionEvent是变化的事件名，args为事件的参数。 该参数为可选参数，若不填写该参数，则认为取消所有对sessionEvent事件的监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.off('sessionEvent');
on(‘queueItemsChange’)10+
on(type: ‘queueItemsChange’, callback: (items: Array<AVQueueItem>) => void): void
媒体控制器设置会话自定义播放列表变化的监听器。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'queueItemsChange'：当session修改播放列表时，触发该事件。 |
| callback | (items: Array<AVQueueItem>) => void | 是 | 回调函数，items为变化的播放列表。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.on('queueItemsChange', (items: avSession.AVQueueItem[]) => {
console.info(`OnQueueItemsChange, items length is ${items.length}`);
});
off(‘queueItemsChange’)10+
off(type: ‘queueItemsChange’, callback?: (items: Array<AVQueueItem>) => void): void
媒体控制器取消监听播放列表变化的事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'queueItemsChange'。 |
| callback | (items: Array<AVQueueItem>) => void | 否 | 回调函数，参数items是变化的播放列表。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.off('queueItemsChange');
on(‘queueTitleChange’)10+
on(type: ‘queueTitleChange’, callback: (title: string) => void): void
媒体控制器设置会话自定义播放列表的名称变化的监听器。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'queueTitleChange'：当session修改播放列表名称时，触发该事件。 |
| callback | (title: string) => void | 是 | 回调函数，title为变化的播放列表名称。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.on('queueTitleChange', (title: string) => {
console.info(`queueTitleChange, title is ${title}`);
});
off(‘queueTitleChange’)10+
off(type: ‘queueTitleChange’, callback?: (title: string) => void): void
媒体控制器取消监听播放列表名称变化的事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'queueTitleChange'。 |
| callback | (title: string) => void | 否 | 回调函数，参数items是变化的播放列表名称。 该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.off('queueTitleChange');
on(‘extrasChange’)10+
on(type: ‘extrasChange’, callback: (extras: {[key:string]: Object}) => void): void
媒体控制器设置自定义媒体数据包事件变化的监听器。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 事件回调类型，支持事件'extrasChange'：当媒体提供方设置自定义媒体数据包时，触发该事件。 |
| callback | (extras: {[key:string]: object}) => void | 是 | 回调函数，extras为媒体提供方新设置的自定义媒体数据包，该自定义媒体数据包与dispatchSessionEvent方法设置的数据包完全一致。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';
let avSessionController: avSession.AVSessionController|undefined = undefined;
let currentAVSession: avSession.AVSession|undefined = undefined;
let tag = "createNewSession";
let context: Context = getContext(this);
avSession.createAVSession(context, tag, "audio", (err: BusinessError, data: avSession.AVSession) => {
if (err) {
console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
} else {
currentAVSession = data;
}
});
if (currentAVSession !== undefined) {
avSession.createController((currentAVSession as avSession.AVSession).sessionId).then((controller: avSession.AVSessionController) => {
avSessionController = controller;
}).catch((err: BusinessError) => {
console.error(`CreateController BusinessError: code: ${err.code}, message: ${err.message}`);
});
}
if (avSessionController !== undefined) {
(avSessionController as avSession.AVSessionController).on('extrasChange', (extras) => {
console.info(`Caught extrasChange event,the new extra is: ${JSON.stringify(extras)}`);
});
}
off(‘extrasChange’)10+
off(type: ‘extrasChange’, callback?: (extras: {[key:string]: Object}) => void): void
媒体控制器取消监听自定义媒体数据包变化事件。
系统能力： SystemCapability.Multimedia.AVSession.Core
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 取消对应的监听事件，支持事件'extrasChange'。 |
| callback | ({[key:string]: Object}) => void | 否 | 注册监听事件时的回调函数。 该参数为可选参数，若不填写该参数，则认为取消会话所有与此事件相关的监听。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
avsessionController.off('extrasChange');
getAVPlaybackStateSync10+
getAVPlaybackStateSync(): AVPlaybackState;
使用同步方法获取当前会话的播放状态。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| AVPlaybackState | 当前会话的播放状态。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
try {
let playbackState: avsession.AVPlaybackState = avsessionController.getAVPlaybackStateSync();
} catch (err: BusinessError) {
console.info(`getAVPlaybackStateSync error, error code: ${err.code}, error message: ${err.message}`);
}
getAVMetadataSync10+
getAVMetadataSync(): AVMetadata
使用同步方法获取会话元数据。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| AVMetadata | 会话元数据。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
try {
let metaData: avsession.AVMetadata = avsessionController.getAVMetadataSync();
} catch (err: BusinessError) {
console.info(`getAVMetadataSync error, error code: ${err.code}, error message: ${err.message}`);
}
getAVQueueTitleSync10+
getAVQueueTitleSync(): string
使用同步方法获取当前会话播放列表的名称。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| string | 当前会话播放列表名称。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
try {
let currentQueueTitle: string = avsessionController.getAVQueueTitleSync();
} catch (err: BusinessError) {
console.info(`getAVQueueTitleSync error, error code: ${err.code}, error message: ${err.message}`);
}
getAVQueueItemsSync10+
getAVQueueItemsSync(): Array<AVQueueItem>
使用同步方法获取当前会话播放列表相关信息。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Array<AVQueueItem> | 当前会话播放列表队列。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
try {
let currentQueueItems: Array<avsession.AVQueueItem> = avsessionController.getAVQueueItemsSync();
} catch (err: BusinessError) {
console.info(`getAVQueueItemsSync error, error code: ${err.code}, error message: ${err.message}`);
}
getOutputDeviceSync10+
getOutputDeviceSync(): OutputDeviceInfo
使用同步方法获取当前输出设备信息。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| OutputDeviceInfo | 当前输出设备信息。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
try {
let currentOutputDevice: avSession.OutputDeviceInfo = avsessionController.getOutputDeviceSync();
} catch (err: BusinessError) {
console.info(`getOutputDeviceSync error, error code: ${err.code}, error message: ${err.message}`);
}
isActiveSync10+
isActiveSync(): boolean
使用同步方法判断会话是否被激活。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| boolean | 会话是否为激活状态，true表示被激活，false表示禁用。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
try {
let isActive: boolean = avsessionController.isActiveSync();
} catch (err: BusinessError) {
console.info(`isActiveSync error, error code: ${err.code}, error message: ${err.message}`);
}
getValidCommandsSync10+
getValidCommandsSync(): Array<AVControlCommandType>
使用同步方法获取会话支持的有效命令。
系统能力： SystemCapability.Multimedia.AVSession.Core
返回值：
| 类型 | 说明 |
|---|---|
| Array<AVControlCommandType> | 会话支持的有效命令的集合。 |
错误码：
以下错误码的详细介绍请参见媒体会话管理错误码。
| 错误码ID | 错误信息 |
|---|---|
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
示例：
import { BusinessError } from '@ohos.base';
try {
let validCommands: Array<avSession.AVControlCommandType> = avsessionController.getValidCommandsSync();
} catch (err: BusinessError) {
console.info(`getValidCommandsSync error, error code: ${err.code}, error message: ${err.message}`);
}
AVControlCommandType10+
会话可传递的命令。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 类型 | 说明 |
|---|---|---|
| play | string | 播放 |
| pause | string | 暂停 |
| stop | string | 停止 |
| playNext | string | 下一首 |
| playPrevious | string | 上一首 |
| fastForward | string | 快进 |
| rewind | string | 快退 |
| seek | string | 跳转某一节点 |
| setSpeed | string | 设置播放倍速 |
| setLoopMode | string | 设置循环模式 |
| toggleFavorite | string | 是否收藏 |
AVControlCommand10+
会话接受的命令的对象描述。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| command | AVControlCommandType | 是 | 命令 |
| parameter | LoopMode | string | number | 否 | 命令对应的参数 |
AVSessionErrorCode10+
会话发生错误时的错误码。
系统能力： SystemCapability.Multimedia.AVSession.Core
| 名称 | 值 | 说明 |
|---|---|---|
| ERR_CODE_SERVICE_EXCEPTION | 6600101 | Session service exception. |
| ERR_CODE_SESSION_NOT_EXIST | 6600102 | The session does not exist. |
| ERR_CODE_CONTROLLER_NOT_EXIST | 6600103 | The session controller does not exist. |
| ERR_CODE_REMOTE_CONNECTION_ERR | 6600104 | The remote session connection failed. |
| ERR_CODE_COMMAND_INVALID | 6600105 | Invalid session command. |
| ERR_CODE_SESSION_INACTIVE | 6600106 | The session is not activated. |
| ERR_CODE_MESSAGE_OVERLOAD | 6600107 | Too many commands or events. |
| ERR_CODE_DEVICE_CONNECTION_FAILED | 6600108 | Device connecting failed. |
| ERR_CODE_REMOTE_CONNECTION_NOT_EXIST | 6600109 | The remote connection is not established. |
你可能感兴趣的鸿蒙文章
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)
harmony 鸿蒙@ohos.distributedBundle (分布式包管理)
harmony 鸿蒙@ohos.bundle (Bundle模块)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)
- 所属分类： 后端技术
- 本文标签：
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦