@ohos.multimedia.avsession (媒体会话管理)

媒体会话管理提供媒体播控相关功能的接口，目的是让应用接入播控中心。

该模块提供以下媒体会话相关的常用功能：

• AVSession : 会话，可用于设置元数据、播放状态信息等操作。
• AVSessionController: 会话控制器，可用于查看会话ID，完成对会话发送命令及事件，获取会话元数据、播放状态信息等操作。

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块的所有接口均为系统接口。

导入模块

import avSession from '@ohos.multimedia.avsession';

avSession.createAVSession

createAVSession(context: Context, tag: string, type: AVSessionType): Promise<AVSession>

创建会话对象，一个Ability只能存在一个会话，重复创建会失败，结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

import featureAbility from '@ohos.ability.featureAbility';

let session;
let tag = "createNewSession";
let context = featureAbility.getContext();

await avSession.createAVSession(context, tag, "audio").then((data) => {
    session = data;
    console.info(`CreateAVSession : SUCCESS : sessionId = ${session.sessionId}`);
}).catch((err) => {
    console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
});

avSession.createAVSession

createAVSession(context: Context, tag: string, type: AVSessionType, callback: AsyncCallback<AVSession>): void

创建会话对象，一个Ability只能存在一个会话，重复创建会失败，结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

import featureAbility from '@ohos.ability.featureAbility';

let session;
let tag = "createNewSession";
let context = featureAbility.getContext();

avSession.createAVSession(context, tag, "audio", function (err, data) {
    if (err) {
        console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        session = data;
        console.info(`CreateAVSession : SUCCESS : sessionId = ${session.sessionId}`);
    }
});

avSession.getAllSessionDescriptors

getAllSessionDescriptors(): Promise<Array<Readonly<AVSessionDescriptor>>>

获取所有会话的相关描述。结果通过Promise异步回调方式返回。

需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。

系统能力： SystemCapability.Multimedia.AVSession.Manager

系统接口： 该接口为系统接口。

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

avSession.getAllSessionDescriptors().then((descriptors) => {
    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) => {
    console.info(`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

系统接口： 该接口为系统接口。

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

avSession.getAllSessionDescriptors(function (err, descriptors) {
    if (err) {
        console.info(`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.createController

createController(sessionId: string): Promise<AVSessionController>

根据会话ID创建会话控制器，可以创建多个会话控制器。结果通过Promise异步回调方式返回。

需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。

系统能力： SystemCapability.Multimedia.AVSession.Manager

系统接口： 该接口为系统接口。

参数：

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

import featureAbility from '@ohos.ability.featureAbility';

let session;
let tag = "createNewSession";
let context = featureAbility.getContext();

await avSession.createAVSession(context, tag, "audio").then((data) => {
    session = data;
    console.info(`CreateAVSession : SUCCESS : sessionId = ${session.sessionId}`);
}).catch((err) => {
    console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
});

let controller;
await avSession.createController(session.sessionId).then((avcontroller) => {
    controller = avcontroller;
    console.info(`CreateController : SUCCESS : ${controller.sessionId}`);
}).catch((err) => {
    console.info(`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

系统接口： 该接口为系统接口。

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

import featureAbility from '@ohos.ability.featureAbility';

let session;
let tag = "createNewSession";
let context = featureAbility.getContext();

await avSession.createAVSession(context, tag, "audio").then((data) => {
    session = data;
    console.info(`CreateAVSession : SUCCESS : sessionId = ${session.sessionId}`);
}).catch((err) => {
    console.info(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
});

let controller;
avSession.createController(session.sessionId, function (err, avcontroller) {
    if (err) {
        console.info(`CreateController BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        controller = avcontroller;
        console.info(`CreateController : SUCCESS : ${controller.sessionId}`);
    }
});

avSession.castAudio

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

投播会话到指定设备列表。结果通过Promise异步回调方式返回。

调用此接口之前，需要导入ohos.multimedia.audio模块获取AudioDeviceDescriptor的相关描述。

需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。

系统能力： SystemCapability.Multimedia.AVSession.Manager

系统接口： 该接口为系统接口。

参数：

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

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

let audioManager = audio.getAudioManager();
let audioRoutingManager = audioManager.getRoutingManager();
let audioDevices;
await 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) => {
    console.info(`GetDevices BusinessError: code: ${err.code}, message: ${err.message}`);
});

avSession.castAudio('all', audioDevices).then(() => {
    console.info('CreateController : SUCCESS');
}).catch((err) => {
    console.info(`CreateController BusinessError: code: ${err.code}, message: ${err.message}`);
});

avSession.castAudio

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

投播会话到指定设备列表。结果通过callback异步回调方式返回。

需要导入ohos.multimedia.audio模块获取AudioDeviceDescriptor的相关描述。

需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。

系统能力： SystemCapability.Multimedia.AVSession.Manager

系统接口： 该接口为系统接口。

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

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

let audioManager = audio.getAudioManager();
let audioRoutingManager = audioManager.getRoutingManager();
let audioDevices;
await 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) => {
    console.info(`GetDevices BusinessError: code: ${err.code}, message: ${err.message}`);
});

avSession.castAudio('all', audioDevices, function (err) {
    if (err) {
        console.info(`CastAudio BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info('CastAudio : SUCCESS ');
    }
});

avSession.on('sessionCreate' | 'sessionDestroy' | 'topSessionChange')

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

会话的创建、销毁以及最新会话变更的监听事件。

需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。

系统能力： SystemCapability.Multimedia.AVSession.Manager

系统接口： 该接口为系统接口。

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

avSession.on('sessionCreate', (descriptor) => {
    console.info(`on sessionCreate : isActive : ${descriptor.isActive}`);
    console.info(`on sessionCreate : type : ${descriptor.type}`);
    console.info(`on sessionCreate : sessionTag : ${descriptor.sessionTag}`);
});

avSession.on('sessionDestroy', (descriptor) => {
    console.info(`on sessionDestroy : isActive : ${descriptor.isActive}`);
    console.info(`on sessionDestroy : type : ${descriptor.type}`);
    console.info(`on sessionDestroy : sessionTag : ${descriptor.sessionTag}`);
});

avSession.on('topSessionChange', (descriptor) => {
    console.info(`on topSessionChange : isActive : ${descriptor.isActive}`);
    console.info(`on topSessionChange : type : ${descriptor.type}`);
    console.info(`on topSessionChange : sessionTag : ${descriptor.sessionTag}`);
});

avSession.off('sessionCreate' | 'sessionDestroy' | 'topSessionChange')

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

取消会话相关事件监听，取消后，不再进行相关事件的监听。

需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。

系统能力： SystemCapability.Multimedia.AVSession.Manager

系统接口： 该接口为系统接口。

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

avSession.off('sessionCreate');
avSession.off('sessionDestroy');
avSession.off('topSessionChange');

avSession.on('sessionServiceDie')

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

监听会话的服务死亡事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

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

avSession.off('sessionServiceDie')

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

取消会话服务死亡监听，取消后，不再进行服务死亡监听。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

avSession.off('sessionServiceDie');

avSession.sendSystemAVKeyEvent

sendSystemAVKeyEvent(event: KeyEvent): Promise<void>

发送按键事件给置顶会话。结果通过Promise异步回调方式返回。

需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。

系统能力： SystemCapability.Multimedia.AVSession.Manager

系统接口： 该接口为系统接口。

参数：

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

let keyItem = {code:0x49, pressedTime:2, deviceId:0};
let event = {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) => {
    console.info(`SendSystemAVKeyEvent BusinessError: code: ${err.code}, message: ${err.message}`);
});

avSession.sendSystemAVKeyEvent

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

发送按键事件给置顶会话。结果通过callback异步回调方式返回。

需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。

系统能力： SystemCapability.Multimedia.AVSession.Manager

系统接口： 该接口为系统接口。

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

let keyItem = {code:0x49, pressedTime:2, deviceId:0};
let event = {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, function (err) {
    if (err) {
        console.info(`SendSystemAVKeyEvent BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info('SendSystemAVKeyEvent : SUCCESS ');
    }
});

avSession.sendSystemControlCommand

sendSystemControlCommand(command: AVControlCommand): Promise<void>

发送控制命令给置顶会话。结果通过Promise异步回调方式返回。

需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。

系统能力： SystemCapability.Multimedia.AVSession.Manager

系统接口： 该接口为系统接口。

参数：

返回值：

错误码： 以下错误码的详细介绍请参见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 = {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) => {
    console.info(`SendSystemControlCommand 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

系统接口： 该接口为系统接口。

参数：

错误码： 以下错误码的详细介绍请参见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 = {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, function (err) {
    if (err) {
        console.info(`SendSystemControlCommand BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info('sendSystemControlCommand successfully');
    }
});

AVSession

调用avSession.createAVSession后，返回会话的实例，可以获得会话ID，完成设置元数据，播放状态信息等操作。

属性

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

示例：

let sessionId = session.sessionId;

setAVMetadata

setAVMetadata(data: AVMetadata): Promise<void>

设置会话元数据。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

let metadata  = {
    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",
};
session.setAVMetadata(metadata).then(() => {
    console.info('SetAVMetadata successfully');
}).catch((err) => {
    console.info(`SetAVMetadata BusinessError: code: ${err.code}, message: ${err.message}`);
});

setAVMetadata

setAVMetadata(data: AVMetadata, callback: AsyncCallback<void>): void

设置会话元数据。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

let metadata  = {
    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",
};
session.setAVMetadata(metadata, function (err) {
    if (err) {
        console.info(`SetAVMetadata BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info('SetAVMetadata successfully');
    }
});

setAVPlaybackState

setAVPlaybackState(state: AVPlaybackState): Promise<void>

设置会话播放状态。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

let playbackState = {
    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,
};
session.setAVPlaybackState(playbackState).then(() => {
    console.info('SetAVPlaybackState successfully');
}).catch((err) => {
    console.info(`SetAVPlaybackState BusinessError: code: ${err.code}, message: ${err.message}`);
});

setAVPlaybackState

setAVPlaybackState(state: AVPlaybackState, callback: AsyncCallback<void>): void

设置会话播放状态。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

let PlaybackState = {
    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,
};
session.setAVPlaybackState(PlaybackState, function (err) {
    if (err) {
        console.info(`SetAVPlaybackState BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info('SetAVPlaybackState successfully');
    }
});

setLaunchAbility

setLaunchAbility(ability: WantAgent): Promise<void>

设置一个WantAgent用于拉起会话的Ability。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

import wantAgent from '@ohos.wantAgent';

//WantAgentInfo对象
let wantAgentInfo = {
    wants: [
        {
            deviceId: "deviceId",
            bundleName: "com.neu.setResultOnAbilityResultTest1",
            abilityName: "com.example.test.MainAbility",
            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) => {
    session.setLaunchAbility(agent).then(() => {
        console.info('SetLaunchAbility successfully');
    }).catch((err) => {
        console.info(`SetLaunchAbility BusinessError: code: ${err.code}, message: ${err.message}`);
    });
});

setLaunchAbility

setLaunchAbility(ability: WantAgent, callback: AsyncCallback<void>): void

设置一个WantAgent用于拉起会话的Ability。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

import wantAgent from '@ohos.wantAgent';

//WantAgentInfo对象
let wantAgentInfo = {
    wants: [
        {
            deviceId: "deviceId",
            bundleName: "com.neu.setResultOnAbilityResultTest1",
            abilityName: "com.example.test.MainAbility",
            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) => {
    session.setLaunchAbility(agent, function (err) {
        if (err) {
            console.info(`SetLaunchAbility BusinessError: code: ${err.code}, message: ${err.message}`);
        } else {
            console.info('SetLaunchAbility successfully');
        }
    });
});

getController

getController(): Promise<AVSessionController>

获取本会话对应的控制器。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

let controller;
session.getController().then((avcontroller) => {
    controller = avcontroller;
    console.info(`GetController : SUCCESS : sessionid : ${controller.sessionId}`);
}).catch((err) => {
    console.info(`GetController BusinessError: code: ${err.code}, message: ${err.message}`);
});

getController

getController(callback: AsyncCallback<AVSessionController>): void

获取本会话相应的控制器。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

let controller;
session.getController(function (err, avcontroller) {
    if (err) {
        console.info(`GetController BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        controller = avcontroller;
        console.info(`GetController : SUCCESS : sessionid : ${controller.sessionId}`);
    }
});

getOutputDevice

getOutputDevice(): Promise<OutputDeviceInfo>

通过会话获取播放设备信息。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.getOutputDevice().then((outputDeviceInfo) => {
    console.info(`GetOutputDevice : SUCCESS : isRemote : ${outputDeviceInfo.isRemote}`);
}).catch((err) => {
    console.info(`GetOutputDevice BusinessError: code: ${err.code}, message: ${err.message}`);
});

getOutputDevice

getOutputDevice(callback: AsyncCallback<OutputDeviceInfo>): void

通过会话获取播放设备相关信息。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.getOutputDevice(function (err, outputDeviceInfo) {
    if (err) {
        console.info(`GetOutputDevice BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info(`GetOutputDevice : SUCCESS : isRemote : ${outputDeviceInfo.isRemote}`);
    }
});

activate

activate(): Promise<void>

激活会话，激活后可正常使用会话。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.activate().then(() => {
    console.info('Activate : SUCCESS ');
}).catch((err) => {
    console.info(`Activate BusinessError: code: ${err.code}, message: ${err.message}`);
});

activate

activate(callback: AsyncCallback<void>): void

激活会话，激活后可正常使用会话。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.activate(function (err) {
    if (err) {
        console.info(`Activate BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info('Activate : SUCCESS ');
    }
});

deactivate

deactivate(): Promise<void>

禁用当前会话的功能，可通过activate恢复。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.deactivate().then(() => {
    console.info('Deactivate : SUCCESS ');
}).catch((err) => {
    console.info(`Deactivate BusinessError: code: ${err.code}, message: ${err.message}`);
});

deactivate

deactivate(callback: AsyncCallback<void>): void

禁用当前会话。结果通过callback异步回调方式返回。

禁用当前会话的功能，可通过activate恢复。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.deactivate(function (err) {
    if (err) {
        console.info(`Deactivate BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info('Deactivate : SUCCESS ');
    }
});

destroy

destroy(): Promise<void>

销毁当前会话，使当前会话完全失效。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.destroy().then(() => {
    console.info('Destroy : SUCCESS ');
}).catch((err) => {
    console.info(`Destroy BusinessError: code: ${err.code}, message: ${err.message}`);
});

destroy

destroy(callback: AsyncCallback<void>): void

销毁当前会话，使当前会话完全失效。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.destroy(function (err) {
    if (err) {
        console.info(`Destroy BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info('Destroy : SUCCESS ');
    }
});

on('play'|'pause'|'stop'|'playNext'|'playPrevious'|'fastForward'|'rewind')

on(type: 'play'|'pause'|'stop'|'playNext'|'playPrevious'|'fastForward'|'rewind', callback: () => void): void

设置播放命令监听事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.on('play', () => {
    console.info('on play entry');
});
session.on('pause', () => {
    console.info('on pause entry');
});
session.on('stop', () => {
    console.info('on stop entry');
});
session.on('playNext', () => {
    console.info('on playNext entry');
});
session.on('playPrevious', () => {
    console.info('on playPrevious entry');
});
session.on('fastForward', () => {
    console.info('on fastForward entry');
});
session.on('rewind', () => {
    console.info('on rewind entry');
});

on('seek')

on(type: 'seek', callback: (time: number) => void): void

设置跳转节点监听事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例： The session does not exist

session.on('seek', (time) => {
    console.info(`on seek entry time : ${time}`);
});

on('setSpeed')

on(type: 'setSpeed', callback: (speed: number) => void): void

设置播放速率的监听事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.on('setSpeed', (speed) => {
    console.info(`on setSpeed speed : ${speed}`);
});

on('setLoopMode')

on(type: 'setLoopMode', callback: (mode: LoopMode) => void): void

设置循环模式的监听事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.on('setLoopMode', (mode) => {
    console.info(`on setLoopMode mode : ${mode}`);
});

on('toggleFavorite')

on(type: 'toggleFavorite', callback: (assetId: string) => void): void

设置是否收藏的监听事件

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.on('toggleFavorite', (assetId) => {
    console.info(`on toggleFavorite mode : ${assetId}`);
});

on('handleKeyEvent')

on(type: 'handleKeyEvent', callback: (event: KeyEvent) => void): void

设置按键事件的监听

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.on('handleKeyEvent', (event) => {
    console.info(`on handleKeyEvent event : ${event}`);
});

on('outputDeviceChange')

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

设置播放设备变化的监听事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.on('outputDeviceChange', (device) => {
    console.info(`on outputDeviceChange device isRemote : ${device.isRemote}`);
});

off('play'|'pause'|'stop'|'playNext'|'playPrevious'|'fastForward'|'rewind')

off(type: 'play' | 'pause' | 'stop' | 'playNext' | 'playPrevious' | 'fastForward' | 'rewind', callback?: () => void): void

取消会话相关事件监听，关闭后，不再进行相关事件回调。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.off('play');
session.off('pause');
session.off('stop');
session.off('playNext');
session.off('playPrevious');
session.off('fastForward');
session.off('rewind');

off('seek')

off(type: 'seek', callback?: (time: number) => void): void

取消监听跳转节点事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.off('seek');

off('setSpeed')

off(type: 'setSpeed', callback?: (speed: number) => void): void

取消监听播放速率变化事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.off('setSpeed');

off('setLoopMode')

off(type: 'setLoopMode', callback?: (mode: LoopMode) => void): void

取消监听循环模式变化事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.off('setLoopMode');

off('toggleFavorite')

off(type: 'toggleFavorite', callback?: (assetId: string) => void): void

取消监听是否收藏的事件

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.off('toggleFavorite');

off('handleKeyEvent')

off(type: 'handleKeyEvent', callback?: (event: KeyEvent) => void): void

取消监听按键事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.off('handleKeyEvent');

off('outputDeviceChange')

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

取消监听播放设备变化的事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

session.off('outputDeviceChange');

AVSessionController

调用avSession.createController后，返回会话控制器实例。控制器可查看会话ID，并可完成对会话发送命令及事件，获取会话元数据，播放状态信息等操作。

属性

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

示例：

let sessionId;
await avSession.createController(session.sessionId).then((controller) => {
    sessionId = controller.sessionId;
}).catch((err) => {
    console.info(`CreateController BusinessError: code: ${err.code}, message: ${err.message}`);
});

getAVPlaybackState

getAVPlaybackState(): Promise<AVPlaybackState>

获取当前会话播放状态相关信息。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.getAVPlaybackState().then((playbackState) => {
    console.info(`GetAVPlaybackState : SUCCESS : state : ${playbackState.state}`);
}).catch((err) => {
    console.info(`GetAVPlaybackState BusinessError: code: ${err.code}, message: ${err.message}`);
});

getAVPlaybackState

getAVPlaybackState(callback: AsyncCallback<AVPlaybackState>): void

获取当前播放状态相关信息。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.getAVPlaybackState(function (err, playbackState) {
    if (err) {
        console.info(`GetAVPlaybackState BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info(`GetAVPlaybackState : SUCCESS : state : ${playbackState.state}`);
    }
});

getAVMetadata

getAVMetadata(): Promise<AVMetadata>

获取会话元数据。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.getAVMetadata().then((metadata) => {
    console.info(`GetAVMetadata : SUCCESS : assetId : ${metadata.assetId}`);
}).catch((err) => {
    console.info(`GetAVMetadata BusinessError: code: ${err.code}, message: ${err.message}`);
});

getAVMetadata

getAVMetadata(callback: AsyncCallback<AVMetadata>): void

获取会话元数据。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.getAVMetadata(function (err, metadata) {
    if (err) {
        console.info(`GetAVMetadata BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info(`GetAVMetadata : SUCCESS : assetId : ${metadata.assetId}`);
    }
});

getOutputDevice

getOutputDevice(): Promise<OutputDeviceInfo>

获取播放设备信息。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.getOutputDevice().then((deviceInfo) => {
    console.info(`GetOutputDevice : SUCCESS : isRemote : ${deviceInfo.isRemote}`);
}).catch((err) => {
    console.info(`GetOutputDevice BusinessError: code: ${err.code}, message: ${err.message}`);
});

getOutputDevice

getOutputDevice(callback: AsyncCallback<OutputDeviceInfo>): void

获取播放设备信息。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.getOutputDevice(function (err, deviceInfo) {
    if (err) {
        console.info(`GetOutputDevice BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info(`GetOutputDevice : SUCCESS : isRemote : ${deviceInfo.isRemote}`);
    }
});

sendAVKeyEvent

sendAVKeyEvent(event: KeyEvent): Promise<void>

发送按键事件到控制器对应的会话。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

返回值：

示例：

let keyItem = {code:0x49, pressedTime:2, deviceId:0};
let event = {action:2, key:keyItem, keys:[keyItem]};

controller.sendAVKeyEvent(event).then(() => {
    console.info('SendAVKeyEvent Successfully');
}).catch((err) => {
    console.info(`SendAVKeyEvent BusinessError: code: ${err.code}, message: ${err.message}`);
});

sendAVKeyEvent

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

发送按键事件到会话。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

let keyItem = {code:0x49, pressedTime:2, deviceId:0};
let event = {action:2, key:keyItem, keys:[keyItem]};

controller.sendAVKeyEvent(event, function (err) {
    if (err) {
        console.info(`SendAVKeyEvent BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info('SendAVKeyEvent Successfully');
    }
});

getLaunchAbility

getLaunchAbility(): Promise<WantAgent>

获取应用在会话中保存的WantAgent对象。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

import wantAgent from '@ohos.wantAgent';

controller.getLaunchAbility().then((agent) => {
    console.info(`GetLaunchAbility : SUCCESS : wantAgent : ${agent}`);
}).catch((err) => {
    console.info(`GetLaunchAbility BusinessError: code: ${err.code}, message: ${err.message}`);
});

getLaunchAbility

getLaunchAbility(callback: AsyncCallback<WantAgent>): void

获取应用在会话中保存的WantAgent对象。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

import wantAgent from '@ohos.wantAgent';

controller.getLaunchAbility(function (err, agent) {
    if (err) {
        console.info(`GetLaunchAbility BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info(`GetLaunchAbility : SUCCESS : wantAgent : ${agent}`);
    }
});

getRealPlaybackPositionSync

getRealPlaybackPositionSync(): number

获取当前播放位置。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

let time = controller.getRealPlaybackPositionSync();

isActive

isActive(): Promise<boolean>

获取会话是否被激活。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.isActive().then((isActive) => {
    console.info(`IsActive : SUCCESS : isactive : ${isActive}`);
}).catch((err) => {
    console.info(`IsActive BusinessError: code: ${err.code}, message: ${err.message}`);
});

isActive

isActive(callback: AsyncCallback<boolean>): void

判断会话是否被激活。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.isActive(function (err, isActive) {
    if (err) {
        console.info(`IsActive BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info(`IsActive : SUCCESS : isactive : ${isActive}`);
    }
});

destroy

destroy(): Promise<void>

销毁当前控制器，销毁后当前控制器不可再用。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.destroy().then(() => {
    console.info('Destroy : SUCCESS ');
}).catch((err) => {
    console.info(`Destroy BusinessError: code: ${err.code}, message: ${err.message}`);
});

destroy

destroy(callback: AsyncCallback<void>): void

销毁当前控制器，销毁后当前控制器不可再用。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.destroy(function (err) {
    if (err) {
        console.info(`Destroy BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info('Destroy : SUCCESS ');
    }
});

getValidCommands

getValidCommands(): Promise<Array<AVControlCommandType>>

获取会话支持的有效命令。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.getValidCommands.then((validCommands) => {
    console.info(`GetValidCommands : SUCCESS : size : ${validCommands.length}`);
}).catch((err) => {
    console.info(`GetValidCommands BusinessError: code: ${err.code}, message: ${err.message}`);
});

getValidCommands

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

获取会话支持的有效命令。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.getValidCommands(function (err, validCommands) {
    if (err) {
        console.info(`GetValidCommands BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info(`GetValidCommands : SUCCESS : size : ${validCommands.length}`);
    }
});

sendControlCommand

sendControlCommand(command: AVControlCommand): Promise<void>

通过控制器发送命令到其对应的会话。结果通过Promise异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

返回值：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

let avCommand = {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"};
controller.sendControlCommand(avCommand).then(() => {
    console.info('SendControlCommand successfully');
}).catch((err) => {
    console.info(`SendControlCommand BusinessError: code: ${err.code}, message: ${err.message}`);
});

sendControlCommand

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

通过会话控制器发送命令到其对应的会话。结果通过callback异步回调方式返回。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

let avCommand = {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"};
controller.sendControlCommand(avCommand, function (err) {
    if (err) {
        console.info(`SendControlCommand BusinessError: code: ${err.code}, message: ${err.message}`);
    } else {
        console.info('SendControlCommand successfully');
    }
});

on('metadataChange')

on(type: 'metadataChange', filter: Array<keyof AVMetadata> | 'all', callback: (data: AVMetadata) => void)

设置元数据变化的监听事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.on('metadataChange', 'all', (metadata) => {
    console.info(`on metadataChange assetId : ${metadata.assetId}`);
});

let metaFilter = ['assetId', 'title', 'description'];
controller.on('metadataChange', metaFilter, (metadata) => {
    console.info(`on metadataChange assetId : ${metadata.assetId}`);
});

on('playbackStateChange')

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

设置播放状态变化的监听事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

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

let playbackFilter = ['state', 'speed', 'loopMode'];
controller.on('playbackStateChange', playbackFilter, (playbackState) => {
    console.info(`on playbackStateChange state : ${playbackState.state}`);
});

on('sessionDestroy')

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

会话销毁的监听事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.on('sessionDestroy', () => {
    console.info('on sessionDestroy : SUCCESS ');
});

on('activeStateChange')

on(type: 'activeStateChange', callback: (isActive: boolean) => void)

会话的激活状态的监听事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.on('activeStateChange', (isActive) => {
    console.info(`on activeStateChange : SUCCESS : isActive ${isActive}`);
});

on('validCommandChange')

on(type: 'validCommandChange', callback: (commands: Array<AVControlCommandType>) => void)

会话支持的有效命令变化监听事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.on('validCommandChange', (validCommands) => {
    console.info(`validCommandChange : SUCCESS : size : ${validCommands.size}`);
    console.info(`validCommandChange : SUCCESS : validCommands : ${validCommands.values()}`);
});

on('outputDeviceChange')

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

设置播放设备变化的监听事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.on('outputDeviceChange', (device) => {
    console.info(`on outputDeviceChange device isRemote : ${device.isRemote}`);
});

off('metadataChange')

off(type: 'metadataChange', callback?: (data: AVMetadata) => void)

控制器取消监听元数据变化的事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.off('metadataChange');

off('playbackStateChange')

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

控制器取消监听播放状态变化的事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.off('playbackStateChange');

off('sessionDestroy')

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

控制器取消监听会话的销毁事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.off('sessionDestroy');

off('activeStateChange')

off(type: 'activeStateChange', callback?: (isActive: boolean) => void)

控制器取消监听会话激活状态变化的事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.off('activeStateChange');

off('validCommandChange')

off(type: 'validCommandChange', callback?: (commands: Array<AVControlCommandType>) => void)

控制器取消监听会话有效命令变化的事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.off('validCommandChange');

off('outputDeviceChange')

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

控制器取消监听分布式设备变化的事件。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

参数：

错误码： 以下错误码的详细介绍请参见ohos.multimedia.avsession(多媒体会话)错误码。

示例：

controller.off('outputDeviceChange');

SessionToken

会话令牌的信息。

需要权限： ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。

系统能力： SystemCapability.Multimedia.AVSession.Manager

系统接口： 该接口为系统接口。

AVSessionType

当前会话支持的会话类型。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口。

AVSessionDescriptor

会话的相关描述信息。

系统能力： SystemCapability.Multimedia.AVSession.Manager

系统接口： 该接口为系统接口。

AVControlCommandType

会话可传递的命令。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

AVControlCommand

会话接受的命令的对象描述。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

AVMetadata

媒体元数据的相关属性。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

AVPlaybackState

媒体播放状态的相关属性。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

PlaybackPosition

媒体播放位置的相关属性。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

OutputDeviceInfo

播放设备的相关信息。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

PlaybackState

表示媒体播放状态的枚举。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

LoopMode

表示媒体播放循环模式的枚举。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口

AVSessionErrorCode

会话发生错误时的错误码。

系统能力： SystemCapability.Multimedia.AVSession.Core

系统接口： 该接口为系统接口