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

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

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

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

说明：

本模块首批接口从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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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.createAVSession¹⁰⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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.error(`CreateAVSession BusinessError: code: ${err.code}, message: ${err.message}`);
  } else {
    currentAVSession = data;
    sessionId = currentAVSession.sessionId;
    console.info(`CreateAVSession : SUCCESS : sessionId = ${sessionId}`);
  }
});

ProtocolType¹⁰⁺

远端设备支持的协议类型。

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

AVSessionType¹⁰⁺

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

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

AVSession¹⁰⁺

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

属性

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

示例：

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

let sessionId: string = currentAVSession.sessionId;
let sessionType: avSession.AVSessionType = currentAVSession.sessionType;

setAVMetadata¹⁰⁺

setAVMetadata(data: AVMetadata): Promise<void>

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

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
});

setAVMetadata¹⁰⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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`);
  }
});

setCallMetadata¹¹⁺

setCallMetadata(data: CallMetadata): Promise<void>

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

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';

let calldata: avSession.CallMetadata = {
  name: "xiaoming",
  phoneNumber: "111xxxxxxxx",
  avatar: "xxx.jpg",
};
currentAVSession.setCallMetadata(calldata).then(() => {
  console.info(`setCallMetadata successfully`);
}).catch((err: BusinessError) => {
  console.error(`setCallMetadata BusinessError: code: ${err.code}, message: ${err.message}`);
});

setCallMetadata¹¹⁺

setCallMetadata(data: CallMetadata, callback: AsyncCallback<void>): void

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';

let calldata: avSession.CallMetadata = {
  name: "xiaoming",
  phoneNumber: "111xxxxxxxx",
  avatar: "xxx.jpg",
};
currentAVSession.setCallMetadata(calldata, (err: BusinessError) => {
  if (err) {
    console.error(`setCallMetadata BusinessError: code: ${err.code}, message: ${err.message}`);
  } else {
    console.info(`setCallMetadata successfully`);
  }
});

setAVCallState¹¹⁺

setAVCallState(state: AVCallState): Promise<void>

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

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';

let calldata: avSession.AVCallState = {
  state: avSession.CallState.CALL_STATE_ACTIVE,
  muted: false
};
currentAVSession.setAVCallState(calldata).then(() => {
  console.info(`setAVCallState successfully`);
}).catch((err: BusinessError) => {
  console.error(`setAVCallState BusinessError: code: ${err.code}, message: ${err.message}`);
});

setAVCallState¹¹⁺

setAVCallState(state: AVCallState, callback: AsyncCallback<void>): void

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';

let avcalldata: avSession.AVCallState = {
  state: avsession.CallState.CALL_STATE_ACTIVE,
  muted: false
};
currentAVSession.setAVCallState(avcalldata, (err: BusinessError) => {
  if (err) {
    console.error(`setAVCallState BusinessError: code: ${err.code}, message: ${err.message}`);
  } else {
    console.info(`setAVCallState successfully`);
  }
});

setAVPlaybackState¹⁰⁺

setAVPlaybackState(state: AVPlaybackState): Promise<void>

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

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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.error(`SetAVPlaybackState BusinessError: code: ${err.code}, message: ${err.message}`);
});

setAVPlaybackState¹⁰⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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.error(`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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
  });
});

setLaunchAbility¹⁰⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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`);
    }
  });
});

dispatchSessionEvent¹⁰⁺

dispatchSessionEvent(event: string, args: {[key: string]: Object}): Promise<void>

媒体提供方设置一个会话内自定义事件，包括事件名和键值对形式的事件内容, 结果通过Promise异步回调方式返回。

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

参数：

说明： 参数args支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等，详细介绍请参见@ohos.app.ability.Want(Want)。

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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.error(`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.error(`dispatchSessionEvent BusinessError: code: ${err.code}, message: ${err.message}`);
  })
}

dispatchSessionEvent¹⁰⁺

dispatchSessionEvent(event: string, args: {[key: string]: Object}, callback: AsyncCallback<void>): void

媒体提供方设置一个会话内自定义事件，包括事件名和键值对形式的事件内容, 结果通过callback异步回调方式返回。

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

参数：

说明：

参数args支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等，详细介绍请参见@ohos.app.ability.Want(Want)。

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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.error(`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}`);
    }
  })
}

setAVQueueItems¹⁰⁺

setAVQueueItems(items: Array<AVQueueItem>): Promise<void>

设置媒体播放列表。结果通过Promise异步回调方式返回。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import image from '@ohos.multimedia.image';
import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';
import avSession from '@ohos.multimedia.avsession';

async function setAVQueueItems() {
  let value = await resourceManager.getSystemResourceManager().getRawFileContent('IMAGE_URI');
  let imageSource= await image.createImageSource(value.buffer);
  let imagePixel = await imageSource.createPixelMap({desiredSize:{width: 150, height: 150}});
  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}`);
  });
}

setAVQueueItems¹⁰⁺

setAVQueueItems(items: Array<AVQueueItem>, callback: AsyncCallback<void>): void

设置媒体播放列表。结果通过callback异步回调方式返回。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import image from '@ohos.multimedia.image';
import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';
import avSession from '@ohos.multimedia.avsession';

async function setAVQueueItems() {
  let value = await resourceManager.getSystemResourceManager().getRawFileContent('IMAGE_URI');
  let imageSource= await image.createImageSource(value.buffer);
  let imagePixel = await imageSource.createPixelMap({desiredSize:{width: 150, height: 150}});
  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`);
    }
  });
}

setAVQueueTitle¹⁰⁺

setAVQueueTitle(title: string): Promise<void>

设置媒体播放列表名称。结果通过Promise异步回调方式返回。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
});

setAVQueueTitle¹⁰⁺

setAVQueueTitle(title: string, callback: AsyncCallback<void>): void

设置媒体播放列表名称。结果通过callback异步回调方式返回。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import { BusinessError } from '@ohos.base';

let queueTitle = 'QUEUE_TITLE';
currentAVSession.setAVQueueTitle(queueTitle, (err: BusinessError) => {
  if (err) {
    console.error(`SetAVQueueTitle BusinessError: code: ${err.code}, message: ${err.message}`);
  } else {
    console.info(`SetAVQueueTitle successfully`);
  }
});

setExtras¹⁰⁺

setExtras(extras: {[key: string]: Object}): Promise<void>

媒体提供方设置键值对形式的自定义媒体数据包, 结果通过Promise异步回调方式返回。

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

参数：

说明：

参数extras支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等，详细介绍请参见@ohos.app.ability.Want(Want)。

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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.error(`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.error(`setExtras BusinessError: code: ${err.code}, message: ${err.message}`);
  })
}

setExtras¹⁰⁺

setExtras(extras: {[key: string]: Object}, callback: AsyncCallback<void>): void

媒体提供方设置键值对形式的自定义媒体数据包, 结果通过callback异步回调方式返回。

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

参数：

说明：

参数extras支持的数据类型有：字符串、数字、布尔、对象、数组和文件描述符等，详细介绍请参见@ohos.app.ability.Want(Want)。

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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.error(`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}`);
    }
  })
}

getController¹⁰⁺

getController(): Promise<AVSessionController>

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

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

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
});

getController¹⁰⁺

getController(callback: AsyncCallback<AVSessionController>): void

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
  }
});

getAVCastController¹⁰⁺

getAVCastController(callback: AsyncCallback<AVCastController>): void

设备建立连接后，获取投播控制器。结果通过callback异步回调方式返回。如果 avsession 未处于投播状态，则控制器将返回 null。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
});

getAVCastController¹⁰⁺

getAVCastController(): Promise<AVCastController>

设备建立连接后，获取投播控制器。结果通过callback异步回调方式返回。如果 avsession 未处于投播状态，则控制器将返回 null。

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

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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`);
  }
});

getOutputDevice¹⁰⁺

getOutputDevice(): Promise<OutputDeviceInfo>

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

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

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
})

getOutputDevice¹⁰⁺

getOutputDevice(callback: AsyncCallback<OutputDeviceInfo>): void

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
  }
});

activate¹⁰⁺

activate(): Promise<void>

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

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

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
});

activate¹⁰⁺

activate(callback: AsyncCallback<void>): void

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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 `);
  }
});

deactivate¹⁰⁺

deactivate(): Promise<void>

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

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

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
});

deactivate¹⁰⁺

deactivate(callback: AsyncCallback<void>): void

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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 `);
  }
});

destroy¹⁰⁺

destroy(): Promise<void>

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

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

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
});

destroy¹⁰⁺

destroy(callback: AsyncCallback<void>): void

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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')¹⁰⁺

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

设置播放命令监听事件。注册该监听，说明应用支持播放指令。

每个播放命令仅支持注册一个回调，如果注册新的回调，将替换前一个回调。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.on('play', () => {
  console.info(`on play entry`);
});

on('pause')¹⁰⁺

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

设置暂停命令监听事件。注册该监听，说明应用支持暂停指令。

每个播放命令仅支持注册一个回调，如果注册新的回调，将替换前一个回调。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.on('pause', () => {
  console.info(`on pause entry`);
});

on('stop')¹⁰⁺

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

设置停止命令监听事件。注册该监听，说明应用支持停止指令。

每个播放命令仅支持注册一个回调，如果注册新的回调，将替换前一个回调。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.on('stop', () => {
  console.info(`on stop entry`);
});

on('playNext')¹⁰⁺

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

设置播放下一首命令监听事件。注册该监听，说明应用支持下一首指令。

每个播放命令仅支持注册一个回调，如果注册新的回调，将替换前一个回调。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.on('playNext', () => {
  console.info(`on playNext entry`);
});

on('playPrevious')¹⁰⁺

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

设置播放上一首命令监听事件。注册该监听，说明应用支持上一首指令。

每个播放命令仅支持注册一个回调，如果注册新的回调，将替换前一个回调。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.on('playPrevious', () => {
  console.info(`on playPrevious entry`);
});

on('fastForward')¹⁰⁺

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

设置快进命令监听事件。注册该监听，说明应用支持快进指令。

每个播放命令仅支持注册一个回调，如果注册新的回调，将替换前一个回调。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.on('fastForward', (time?: number) => {
  console.info(`on fastForward entry`);
});

on('rewind')¹⁰⁺

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

设置快退命令监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.on('rewind', (time?: number) => {
  console.info(`on rewind entry`);
});

on('playFromAssetId')¹¹⁺

on(type:'playFromAssetId', callback: (assetId: number) => void): void

设置媒体id播放监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.on('playFromAssetId', (assetId: number) => {
  console.info(`on playFromAssetId entry`);
});

off('playFromAssetId')¹¹⁺

off(type: 'playFromAssetId', callback?: (assetId: number) => void): void

取消媒体id播放事件监听，关闭后，不再进行该事件回调。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('playFromAssetId');

on('seek')¹⁰⁺

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

设置跳转节点监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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

on('setSpeed')¹⁰⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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

on('setLoopMode')¹⁰⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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

on('toggleFavorite')¹⁰⁺

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

设置是否收藏的监听事件

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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

on('skipToQueueItem')¹⁰⁺

on(type: 'skipToQueueItem', callback: (itemId: number) => void): void

设置播放列表其中某项被选中的监听事件，session端可以选择对这个单项歌曲进行播放。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.on('skipToQueueItem', (itemId: number) => {
  console.info(`on skipToQueueItem id : ${itemId}`);
});

on('handleKeyEvent')¹⁰⁺

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

设置按键事件的监听

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import keyEvent from '@ohos.multimodalInput.keyEvent';

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

on('outputDeviceChange')¹⁰⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.on('outputDeviceChange', (state: avSession.ConnectionState, device: avSession.OutputDeviceInfo) => {
  console.info(`on outputDeviceChange device : ${device}`);
});

on('commonCommand')¹⁰⁺

on(type: 'commonCommand', callback: (command: string, args: {[key: string]: Object}) => void): void

设置自定义控制命令变化的监听器。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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.error(`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')¹⁰⁺

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

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

取消回调时，需要更新支持的命令列表。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('play');

off('pause')¹⁰⁺

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

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

取消回调时，需要更新支持的命令列表。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('pause');

off('stop')¹⁰⁺

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

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

取消回调时，需要更新支持的命令列表。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('stop');

off('playNext')¹⁰⁺

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

取消会话播放下一首事件监听，关闭后，不再进行该事件回调。

取消回调时，需要更新支持的命令列表。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('playNext');

off('playPrevious')¹⁰⁺

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

取消会话播放上一首事件监听，关闭后，不再进行该事件回调。

取消回调时，需要更新支持的命令列表。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('playPrevious');

off('fastForward')¹⁰⁺

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

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

取消回调时，需要更新支持的命令列表。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('fastForward');

off('rewind')¹⁰⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('rewind');

off('seek')¹⁰⁺

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

取消监听跳转节点事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('seek');

off('setSpeed')¹⁰⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('setSpeed');

off('setLoopMode')¹⁰⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('setLoopMode');

off('toggleFavorite')¹⁰⁺

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

取消监听是否收藏的事件

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('toggleFavorite');

off('skipToQueueItem')¹⁰⁺

off(type: 'skipToQueueItem', callback?: (itemId: number) => void): void

取消监听播放列表单项选中的事件

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('skipToQueueItem');

off('handleKeyEvent')¹⁰⁺

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

取消监听按键事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('handleKeyEvent');

off('outputDeviceChange')¹⁰⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('outputDeviceChange');

off('commonCommand')¹⁰⁺

off(type: 'commonCommand', callback?: (command: string, args: {[key:string]: Object}) => void): void

取消监听自定义控制命令的变化。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('commonCommand');

on('answer')¹¹⁺

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

设置通话接听的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.on('answer', () => {
  console.info(`on call answer`);
});

off('answer')¹¹⁺

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

取消通话接听事件的监听。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('answer');

on('hangUp')¹¹⁺

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

设置通话挂断的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.on('hangUp', () => {
  console.info(`on call hangUp`);
});

off('hangUp')¹¹⁺

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

取消通话挂断事件的监听。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('hangUp');

on('toggleCallMute')¹¹⁺

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

设置通话静音的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.on('toggleCallMute', () => {
  console.info(`on call toggleCallMute`);
});

off('toggleCallMute')¹¹⁺

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

取消通话静音事件的监听。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

currentAVSession.off('toggleCallMute');

stopCasting¹⁰⁺

stopCasting(callback: AsyncCallback<void>): void

结束投播。结果通过callback异步回调方式返回。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import { BusinessError } from '@ohos.base';

currentAVSession.stopCasting((err: BusinessError) => {
  if (err) {
    console.error(`stopCasting BusinessError: code: ${err.code}, message: ${err.message}`);
  } else {
    console.info(`stopCasting successfully`);
  }
});

stopCasting¹⁰⁺

stopCasting(): Promise<void>

结束投播。结果通过Promise异步回调方式返回。

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

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import { BusinessError } from '@ohos.base';

currentAVSession.stopCasting().then(() => {
  console.info(`stopCasting successfully`);
}).catch((err: BusinessError) => {
  console.error(`stopCasting BusinessError: code: ${err.code}, message: ${err.message}`);
});

getOutputDeviceSync¹⁰⁺

getOutputDeviceSync(): OutputDeviceInfo

使用同步方法获取当前输出设备信息。

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

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import { BusinessError } from '@ohos.base';

try {
  let currentOutputDevice: avSession.OutputDeviceInfo = currentAVSession.getOutputDeviceSync();
} catch (err) {
  let error = err as BusinessError;
  console.error(`getOutputDeviceSync error, error code: ${error.code}, error message: ${error.message}`);
}

AVCastControlCommandType¹⁰⁺

投播控制器可传递的命令。

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

AVCastControlCommand¹⁰⁺

投播控制器接受的命令的对象描述。

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

AVCastController¹⁰⁺

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

getAVPlaybackState¹⁰⁺

getAVPlaybackState(callback: AsyncCallback<AVPlaybackState>): void

获取当前的远端播放状态。结果通过callback异步回调方式返回。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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`);
  }
});

getAVPlaybackState¹⁰⁺

getAVPlaybackState(): Promise<AVPlaybackState>

获取当前的远端播放状态。结果通过Promise异步回调方式返回。

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

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
});

sendControlCommand¹⁰⁺

sendControlCommand(command: AVCastControlCommand): Promise<void>

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

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';

let avCommand: avSession.AVCastControlCommand = {command:'play'};
aVCastController.sendControlCommand(avCommand).then(() => {
  console.info(`SendControlCommand successfully`);
}).catch((err: BusinessError) => {
  console.error(`SendControlCommand BusinessError: code: ${err.code}, message: ${err.message}`);
});

sendControlCommand¹⁰⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import avSession from '@ohos.multimedia.avsession';
import { BusinessError } from '@ohos.base';

let avCommand: avSession.AVCastControlCommand = {command:'play'};
aVCastController.sendControlCommand(avCommand, (err: BusinessError) => {
  if (err) {
    console.error(`SendControlCommand BusinessError: code: ${err.code}, message: ${err.message}`);
  } else {
    console.info(`SendControlCommand successfully`);
  }
});

prepare¹⁰⁺

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

准备播放媒体资源，即进行播放资源的加载和缓冲。结果通过callback异步回调方式返回。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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`);
  }
});

prepare¹⁰⁺

prepare(item: AVQueueItem): Promise<void>

准备播放媒体资源，即进行播放资源的加载和缓冲。结果通过Promise异步回调方式返回。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
});

start¹⁰⁺

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

启动播放某个媒体资源。结果通过callback异步回调方式返回。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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`);
  }
});

start¹⁰⁺

start(item: AVQueueItem): Promise<void>

启动播放某个媒体资源。结果通过Promise异步回调方式返回。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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.error(`start BusinessError: code: ${err.code}, message: ${err.message}`);
});

getCurrentItem¹⁰⁺

getCurrentItem(callback: AsyncCallback<AVQueueItem>): void

获取当前投播的资源信息。结果通过callback异步回调方式返回。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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`);
  }
});

getCurrentItem¹⁰⁺

getCurrentItem(): Promise<AVQueueItem>

获取当前投播的资源信息。结果通过Promise异步回调方式返回。

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

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
});

release¹¹⁺

release(callback: AsyncCallback<void>): void

销毁当前controller，结果通过callback异步回调方式返回。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import { BusinessError } from '@ohos.base';

aVCastController.release((err: BusinessError) => {
  if (err) {
    console.error(`release BusinessError: code: ${err.code}, message: ${err.message}`);
  } else {
    console.info(`release successfully`);
  }
});

release¹¹⁺

release(): Promise<void>

销毁当前controller。结果通过Promise异步回调方式返回。

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

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

import { BusinessError } from '@ohos.base';

aVCastController.release().then(() => {
  console.info(`release successfully`);
}).catch((err: BusinessError) => {
  console.error(`release BusinessError: code: ${err.code}, message: ${err.message}`);
});

on('playbackStateChange')¹⁰⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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

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

off('playbackStateChange')¹⁰⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

aVCastController.off('playbackStateChange');

on('mediaItemChange')¹⁰⁺

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

设置投播当前播放媒体内容的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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

off('mediaItemChange')¹⁰⁺

off(type: 'mediaItemChange'): void

取消设置投播当前播放媒体内容的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

aVCastController.off('mediaItemChange');

on('playNext')¹⁰⁺

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

设置播放下一首资源的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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

off('playNext')¹⁰⁺

off(type: 'playNext'): void

取消设置播放下一首资源的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

aVCastController.off('playNext');

on('playPrevious')¹⁰⁺

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

设置播放上一首资源的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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

off('playPrevious')¹⁰⁺

off(type: 'playPrevious'): void

取消设置播放上一首资源的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

aVCastController.off('playPrevious');

on('requestPlay')¹¹⁺

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

设置请求播放的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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

off('requestPlay')¹¹⁺

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

取消设置请求播放的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

aVCastController.off('requestPlay');

on('endOfStream')¹¹⁺

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

设置播放结束的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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

off('endOfStream')¹¹⁺

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

取消设置播放结束的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

aVCastController.off('endOfStream');

on('seekDone')¹⁰⁺

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

设置seek结束的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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

off('seekDone')¹⁰⁺

off(type: 'seekDone'): void

取消设置seek结束的监听事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

aVCastController.off('seekDone');

on('validCommandChange')¹¹⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

aVCastController.on('validCommandChange', (validCommands: avSession.AVCastControlCommandType[]) => {
  console.info(`validCommandChange : SUCCESS : size : ${validCommands.length}`);
  console.info(`validCommandChange : SUCCESS : validCommands : ${validCommands.values()}`);
});

off('validCommandChange')¹¹⁺

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

aVCastController.off('validCommandChange');

on('error')¹⁰⁺

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

监听远端播放器的错误事件，该事件仅用于错误提示，不需要用户停止播控动作。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体服务错误码以及媒体会话管理错误码。

示例：

import { BusinessError } from '@ohos.base'

aVCastController.on('error', (error: BusinessError) => {
  console.info('error happened,and error message is :' + error.message)
  console.info('error happened,and error code is :' + error.code)
})

off('error')¹⁰⁺

off(type: 'error'): void

取消监听播放的错误事件。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体服务错误码以及媒体会话管理错误码。

示例：

aVCastController.off('error')

ConnectionState¹⁰⁺

连接状态枚举。

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

AVMetadata¹⁰⁺

媒体元数据的相关属性。

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

AVMediaDescription¹⁰⁺

播放列表媒体元数据的相关属性。

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

AVQueueItem¹⁰⁺

播放列表中单项的相关属性。

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

AVPlaybackState¹⁰⁺

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

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

PlaybackPosition¹⁰⁺

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

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

CallMetadata¹¹⁺

通话会话元数据相关属性。

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

AVCallState¹¹⁺

通话状态相关属性。

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

CallState¹¹⁺

表示通话状态的枚举。

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

DisplayTag¹¹⁺

枚举，表示当前媒体资源的金标，即应用媒体音源的特殊类型标识。

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

AVCastCategory¹⁰⁺

投播的类别枚举。

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

DeviceType¹⁰⁺

播放设备的类型枚举。

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

DeviceInfo¹⁰⁺

播放设备的相关信息。

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

OutputDeviceInfo¹⁰⁺

播放设备的相关信息。

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

LoopMode¹⁰⁺

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

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

PlaybackState¹⁰⁺

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

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

AVSessionController¹⁰⁺

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

属性

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

示例：

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}`);
});

getAVPlaybackState¹⁰⁺

getAVPlaybackState(callback: AsyncCallback<AVPlaybackState>): void

获取当前的远端播放状态。结果通过callback异步回调方式返回。

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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`);
  }
});

getAVPlaybackState¹⁰⁺

getAVPlaybackState(): Promise<AVPlaybackState>

获取当前的远端播放状态。结果通过Promise异步回调方式返回。

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

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
});

getAVMetadata¹⁰⁺

getAVMetadata(): Promise<AVMetadata>

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

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

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
});

getAVMetadata¹⁰⁺

getAVMetadata(callback: AsyncCallback<AVMetadata>): void

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

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

参数：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
  }
});

getAVQueueTitle¹⁰⁺

getAVQueueTitle(): Promise<string>

获取当前会话播放列表的名称。结果通过Promise异步回调方式返回。

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

返回值：

错误码：

以下错误码的详细介绍请参见媒体会话管理错误码。

示例：

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}`);
});

getAVQueueTitle¹⁰⁺