1# 媒体会话控制方(仅对系统应用开放) 2 3OpenHarmony系统预置的播控中心，作为媒体会话控制方与音视频应用进行交互，包括获取媒体信息进行展示以及下发播控命令等。 4 5系统应用开发者也可以根据需要，按照本章节的内容自行开发一款新的系统应用（例如新开发一款播控中心或语音助手），作为媒体会话控制方的角色，与系统中的音视频应用进行交互。 6 7## 基本概念 8 9- 媒体会话描述符（AVSessionDescriptor）：描述媒体会话的相关信息，包含标识媒体会话的ID（sessionId），媒体会话的类型type（音频Audio/视频Video），媒体会话自定义名称（sessionTag），媒体会话所属应用的信息（elementName）、是否为置顶会话（isTopSession）等。 10 11- 置顶会话（TopSession）：系统中优先级最高的媒体会话，例如当前处于正在播放状态的会话。一般来说，如果想与媒体会话通信，需要获取会话对应的控制器，而媒体会话控制方可以在不用获取对应控制器的情况下，直接与置顶会话通信，例如直接向置顶会话发送播控命令和按键事件。 12 13## 接口说明 14 15媒体会话控制方使用的关键接口包括两类： 16 171. 直接通过import得到的AVSessionManager来调用，例如接口`AVSessionManager.createController(sessionId)`。 182. 通过AVSessionController对象来调用，例如接口`controller.getAVPlaybackState()`。 19 20异步的JavaScript接口返回值有两种返回形式：callback和promise，本说明仅提供callback形式接口，promise和callback只是返回值方式不一样，功能相同。 21 22更多API说明请参见[API文档](../../reference/apis-avsession-kit/js-apis-avsession.md)。 23 24### 直接通过AVSessionManager调用的接口 25 26| 接口名 | 说明 | 27| -------- | -------- | 28| getAllSessionDescriptors(callback: AsyncCallback<Array<Readonly<AVSessionDescriptor>>>): void | 获取系统中所有媒体会话的描述符。 | 29| createController(sessionId: string, callback: AsyncCallback<AVSessionController>): void | 创建媒体会话控制器。 | 30| sendSystemAVKeyEvent(event: KeyEvent, callback: AsyncCallback<void>): void | 向置顶会话发送按键命令。 | 31| sendSystemControlCommand(command: AVControlCommand, callback: AsyncCallback<void>): void | 向置顶会话发送播控命令。 | 32| getHistoricalSessionDescriptors(maxSize: number, callback: AsyncCallback\<Array\<Readonly\<AVSessionDescriptor>>>): void<sup>10+<sup> | 获取历史会话的描述符。 | 33 34### 通过AVSessionController对象调用的接口 35 36| 接口名 | 说明 | 37| -------- | -------- | 38| getAVPlaybackState(callback: AsyncCallback<AVPlaybackState>): void<sup>10+<sup> | 获取当前会话播放状态相关信息。 | 39| getAVMetadata(callback: AsyncCallback<AVMetadata>): void<sup>10+<sup> | 获取会话元数据。 | 40| getOutputDevice(callback: AsyncCallback<OutputDeviceInfo>): void<sup>10+<sup> | 获取播放设备信息。 | 41| sendAVKeyEvent(event: KeyEvent, callback: AsyncCallback<void>): void<sup>10+<sup> | 发送按键事件到会话。| 42| getLaunchAbility(callback: AsyncCallback<WantAgent>): void<sup>10+<sup> | 获取应用在会话中保存的WantAgent对象。 | 43| isActive(callback: AsyncCallback<boolean>): void<sup>10+<sup> | 判断会话是否被激活。 | 44| destroy(callback: AsyncCallback<void>): void<sup>10+<sup> | 销毁当前控制器，销毁后当前控制器不再可用。 | 45| getValidCommands(callback: AsyncCallback<Array<AVControlCommandType>>): void<sup>10+<sup> | 获取会话支持的有效命令。 | 46| sendControlCommand(command: AVControlCommand, callback: AsyncCallback<void>): void<sup>10+<sup> | 通过会话控制器发送命令到其对应的会话。 | 47| sendCommonCommand(command: string, args: {[key: string]: Object}, callback: AsyncCallback<void>): void<sup>10+<sup> | 通过会话控制器发送自定义命令到其对应的会话。 | 48| getAVQueueItems(callback: AsyncCallback<Array<AVQueueItem>>): void<sup>10+<sup> | 获取当前播放列表相关信息。 | 49| getAVQueueTitle(callback: AsyncCallback<string>): void<sup>10+<sup> | 获取当前播放列表的名称。 | 50| skipToQueueItem(itemId: number, callback: AsyncCallback<void>): void<sup>10+<sup> | 设置指定播放列表单项的ID，发送给session端处理，session端可以选择对这个单项歌曲进行播放。 | 51| getExtras(callback: AsyncCallback<{[key: string]: Object}>): void<sup>10+<sup> | 获取媒体提供方设置的自定义媒体数据包。 | 52| getOutputDeviceSync(): OutputDeviceInfo<sup>10+<sup> | 使用同步方法获取当前输出设备信息。 | 53| getAVPlaybackStateSync(): AVPlaybackState<sup>10+<sup> | 使用同步方法获取当前会话播放状态相关信息。 | 54| getAVMetadataSync(): AVMetadata<sup>10+<sup> | 使用同步方法获取当前会话元数据信息。 | 55| getAVQueueTitleSync(): string<sup>10+<sup> | 使用同步方法当前播放列表的名称。 | 56| getAVQueueItemsSync(): Array<AVQueueItem><sup>10+<sup> | 使用同步方法获取当前播放列表相关信息。 | 57| isActiveSync(): boolean<sup>10+<sup> | 使用同步方法判断会话是否被激活。 | 58| getValidCommandsSync(): Array<AVControlCommandType><sup>10+<sup> | 使用同步方法获取会话支持的有效命令。 | 59 60## 开发步骤 61 62系统应用作为媒体会话控制方接入媒体会话的基本步骤如下所示： 63 641. 通过AVSessionManager获取媒体会话描述符AVSessionDescriptor，创建媒体会话控制器AVSessionController。 65 媒体会话控制方可以获取当前系统中所有的AVSessionDescriptor，并创建每个会话对应的AVSessionController，从而对系统中的音视频应用进行统一的播放控制。 66 67 ```ts 68 //导入AVSessionManager模块 69 import { avSession as AVSessionManager } from '@kit.AVSessionKit'; 70 import { BusinessError } from '@kit.BasicServicesKit'; 71 72 // 全局变量定义 73 let g_controller = new Array<AVSessionManager.AVSessionController>(); 74 let g_centerSupportCmd:Set<AVSessionManager.AVControlCommandType> = new Set(['play', 'pause', 'playNext', 'playPrevious', 'fastForward', 'rewind', 'seek','setSpeed', 'setLoopMode', 'toggleFavorite']); 75 let g_validCmd:Set<AVSessionManager.AVControlCommandType>; 76 // 获取会话描述符，创建控制器 77 AVSessionManager.getAllSessionDescriptors().then((descriptors) => { 78 descriptors.forEach((descriptor) => { 79 AVSessionManager.createController(descriptor.sessionId).then((controller) => { 80 g_controller.push(controller); 81 }).catch((err: BusinessError) => { 82 console.error(`Failed to create controller. Code: ${err.code}, message: ${err.message}`); 83 }); 84 }); 85 }).catch((err: BusinessError) => { 86 console.error(`Failed to get all session descriptors. Code: ${err.code}, message: ${err.message}`); 87 }); 88 89 // 获取历史会话的描述符 90 AVSessionManager.getHistoricalSessionDescriptors().then((descriptors) => { 91 console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors.length : ${descriptors.length}`); 92 if (descriptors.length > 0){ 93 console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].isActive : ${descriptors[0].isActive}`); 94 console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].type : ${descriptors[0].type}`); 95 console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].sessionTag : ${descriptors[0].sessionTag}`); 96 console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].sessionId : ${descriptors[0].sessionId}`); 97 console.info(`getHistoricalSessionDescriptors : SUCCESS : descriptors[0].elementName.bundleName : ${descriptors[0].elementName.bundleName}`); 98 } 99 }).catch((err: BusinessError) => { 100 console.error(`Failed to get historical session descriptors, error code: ${err.code}, error message: ${err.message}`); 101 }); 102 ``` 103 1042. 监听AVSession会话状态及AVSession服务状态事件。 105 106 AVSession会话状态事件包括： 107 108 - sessionCreate：媒体会话创建事件。 109 - sessionDestroy：媒体会话销毁事件。 110 - topSessionChange：置顶会话发生变化事件。 111 112 AVSession服务状态事件指sessionServiceDie，在AVSession服务异常时产生该事件。 113 114 ```ts 115 import { avSession as AVSessionManager } from '@kit.AVSessionKit'; 116 import { BusinessError } from '@kit.BasicServicesKit'; 117 118 let g_controller = new Array<AVSessionManager.AVSessionController>(); 119 // 注册会话创建监听，创建控制器 120 AVSessionManager.on('sessionCreate', (session) => { 121 // 新增会话，需要创建控制器 122 AVSessionManager.createController(session.sessionId).then((controller) => { 123 g_controller.push(controller); 124 }).catch((err: BusinessError) => { 125 console.error(`Failed to create controller. Code: ${err.code}, message: ${err.message}`); 126 }); 127 }); 128 129 // 注册系统会话销毁监听 130 AVSessionManager.on('sessionDestroy', (session) => { 131 let index = g_controller.findIndex((controller) => { 132 return controller.sessionId === session.sessionId; 133 }); 134 if (index !== 0) { 135 g_controller[index].destroy(); 136 g_controller.splice(index, 1); 137 } 138 }); 139 // 注册系统最高优先级会话变更监听 140 AVSessionManager.on('topSessionChange', (session) => { 141 let index = g_controller.findIndex((controller) => { 142 return controller.sessionId === session.sessionId; 143 }); 144 // 将该会话显示排到第一个 145 if (index !== 0) { 146 g_controller.sort((a, b) => { 147 return a.sessionId === session.sessionId ? -1 : 0; 148 }); 149 } 150 }); 151 // 注册服务异常监听 152 AVSessionManager.on('sessionServiceDie', () => { 153 // 服务端异常，应用清理资源 154 console.info(`服务端异常`); 155 }) 156 ``` 157 1583. 监听媒体信息变化及会话其他事件。 159 160 AVSession媒体信息变化事件主要包括： 161 162 - metadataChange：媒体会话元数据变化事件。 163 - playbackStateChange：媒体播放状态变化事件。 164 - activeStateChange：媒体会话激活状态变化事件。 165 - validCommandChange：媒体会话支持的有效命令变化事件。 166 - outputDeviceChange：播放设备变化事件。 167 - sessionDestroy：媒体会话销毁事件。 168 - sessionEvent: 媒体会话自定义事件变化事件。 169 - extrasChange：媒体会话自定义数据包变化事件。 170 - queueItemsChange: 媒体会话自定义播放列表变化事件。 171 - queueTitleChange: 媒体会话自定义播放列表的名称变化事件。 172 173 媒体会话控制方可以根据实际需要监听对应的事件。 174 175 ```ts 176 import { avSession as AVSessionManager } from '@kit.AVSessionKit'; 177 import { BusinessError } from '@kit.BasicServicesKit'; 178 179 let g_controller = new Array<AVSessionManager.AVSessionController>(); 180 let controller = g_controller[0]; 181 let g_validCmd:Set<AVSessionManager.AVControlCommandType>; 182 let g_centerSupportCmd:Set<AVSessionManager.AVControlCommandType> = new Set(['play', 'pause', 'playNext', 'playPrevious', 'fastForward', 'rewind', 'seek','setSpeed', 'setLoopMode', 'toggleFavorite']); 183 // 注册会话激活状态变更监听 184 controller.on('activeStateChange', (isActive) => { 185 if (isActive) { 186 console.info(`控制器卡片按键高亮`); 187 } else { 188 console.info(`控制器卡片按键变更为无效`); 189 } 190 }); 191 // 注册会话销毁监听 192 controller.on('sessionDestroy', () => { 193 console.info(`on sessionDestroy : SUCCESS `); 194 controller.destroy().then(() => { 195 console.info(`destroy : SUCCESS`); 196 }).catch((err: BusinessError) => { 197 console.error(`Failed to destroy session. Code: ${err.code}, message: ${err.message}`); 198 }); 199 }); 200 201 // 注册元数据更新监听 202 controller.on('metadataChange', ['assetId', 'title', 'description'], (metadata: AVSessionManager.AVMetadata) => { 203 console.info(`on metadataChange assetId : ${metadata.assetId}`); 204 }); 205 // 注册播放状态更新监听 206 controller.on('playbackStateChange', ['state', 'speed', 'loopMode'], (playbackState: AVSessionManager.AVPlaybackState) => { 207 console.info(`on playbackStateChange state : ${playbackState.state}`); 208 }); 209 // 注册会话支持的命令变更监听 210 controller.on('validCommandChange', (cmds) => { 211 console.info(`validCommandChange : SUCCESS : size : ${cmds.length}`); 212 console.info(`validCommandChange : SUCCESS : cmds : ${cmds.values()}`); 213 g_validCmd.clear(); 214 let centerSupportCmd = Array.from(g_centerSupportCmd.values()) 215 for (let c of centerSupportCmd) { 216 if (cmds.concat(c)) { 217 g_validCmd.add(c); 218 } 219 } 220 }); 221 // 注册输出设备变更监听 222 controller.on('outputDeviceChange', (state, device) => { 223 console.info(`outputDeviceChange device are : ${JSON.stringify(device)}`); 224 }); 225 // 注册会话自定义事件变更监听 226 controller.on('sessionEvent', (eventName, eventArgs) => { 227 console.info(`Received new session event, event name is ${eventName}, args are ${JSON.stringify(eventArgs)}`); 228 }); 229 // 注册会话自定义媒体数据包变更监听 230 controller.on('extrasChange', (extras) => { 231 console.info(`Received custom media packet, packet data is ${JSON.stringify(extras)}`); 232 }); 233 // 注册会话自定义播放列表变更监听 234 controller.on('queueItemsChange', (items) => { 235 console.info(`Caught queue items change, items length is ${items.length}`); 236 }); 237 // 注册会话自定义播放标题变更监听 238 controller.on('queueTitleChange', (title) => { 239 console.info(`Caught queue title change, title is ${title}`); 240 }); 241 ``` 242 2434. 获取媒体会话提供方传递的媒体信息，可以用于界面展示，例如在播控中心展示当前播放的曲目及对应的播放状态。 244 245 ```ts 246 import { avSession as AVSessionManager } from '@kit.AVSessionKit'; 247 async function getInfoFromSessionByController() { 248 // 假设我们已经有了一个对应session的controller，如何创建controller可以参考之前的案例 249 let controller = await AVSessionManager.createController("") 250 // 获取sessionId 251 let sessionId = controller.sessionId; 252 console.info(`get sessionId by controller : isActive : ${sessionId}`); 253 // 获取session激活状态 254 let isActive = await controller.isActive(); 255 console.info(`get activeState by controller : ${isActive}`); 256 // 获取session的媒体信息 257 let metadata = await controller.getAVMetadata(); 258 console.info(`get media title by controller : ${metadata.title}`); 259 console.info(`get media artist by controller : ${metadata.artist}`); 260 // 获取session的播放信息 261 let avPlaybackState = await controller.getAVPlaybackState(); 262 console.info(`get playbackState by controller : ${avPlaybackState.state}`); 263 console.info(`get favoriteState by controller : ${avPlaybackState.isFavorite}`); 264 // 获取session的播放列表信息 265 let queueItems = await controller.getAVQueueItems(); 266 console.info(`get queueItems length by controller : ${queueItems.length}`); 267 // 获取session的播放标题信息 268 let queueTitle = await controller.getAVQueueTitle(); 269 console.info(`get queueTitle by controller : ${queueTitle}`); 270 // 获取session的自定义媒体数据包 271 let extras = await controller.getExtras(); 272 console.info(`get custom media packets by controller : ${JSON.stringify(extras)}`); 273 // 获取session对应应用提供的ability信息 274 let agent = await controller.getLaunchAbility(); 275 console.info(`get want agent info by controller : ${JSON.stringify(agent)}`); 276 // 获取session的当前播放位置信息 277 let currentTime = controller.getRealPlaybackPositionSync(); 278 console.info(`get current playback time by controller : ${currentTime}`); 279 // 获取session支持的有效命令 280 let validCommands = await controller.getValidCommands(); 281 console.info(`get valid commands by controller : ${JSON.stringify(validCommands)}`); 282 } 283 ``` 284 2855. 控制媒体会话行为，例如发送用户在播控中心对当前曲目的操作（播放/暂停/上一首/下一首等）命令。 286 287 作为媒体会话提供方的音视频应用在监听到相关的播控命令事件后，在相应的逻辑中可以完成对应的操作动作。 288 289 ```ts 290 import { avSession as AVSessionManager } from '@kit.AVSessionKit'; 291 import { BusinessError } from '@kit.BasicServicesKit'; 292 293 async function sendCommandToSessionByController() { 294 // 假设我们已经有了一个对应session的controller，如何创建controller可以参考之前的案例 295 let controller = await AVSessionManager.createController("") 296 // 获取这个session支持的命令种类 297 let validCommandTypeArray = await controller.getValidCommands(); 298 console.info(`get validCommandArray by controller : length : ${validCommandTypeArray.length}`); 299 // 下发播放命令 300 // 如果可用命令包含播放，则下发播放命令，正常session都应该提供并实现播放功能 301 if (validCommandTypeArray.indexOf('play') >= 0) { 302 let avCommand: AVSessionManager.AVControlCommand = {command:'play'}; 303 controller.sendControlCommand(avCommand); 304 } 305 // 下发暂停命令 306 if (validCommandTypeArray.indexOf('pause') >= 0) { 307 let avCommand: AVSessionManager.AVControlCommand = {command:'pause'}; 308 controller.sendControlCommand(avCommand); 309 } 310 // 下发上一首命令 311 if (validCommandTypeArray.indexOf('playPrevious') >= 0) { 312 let avCommand: AVSessionManager.AVControlCommand = {command:'playPrevious'}; 313 controller.sendControlCommand(avCommand); 314 } 315 // 下发下一首命令 316 if (validCommandTypeArray.indexOf('playNext') >= 0) { 317 let avCommand: AVSessionManager.AVControlCommand = {command:'playNext'}; 318 controller.sendControlCommand(avCommand); 319 } 320 // 下发自定义控制命令 321 let commandName = 'custom command'; 322 await controller.sendCommonCommand(commandName, {command : 'This is my custom command'}).then(() => { 323 console.info(`SendCommonCommand successfully`); 324 }).catch((err: BusinessError) => { 325 console.error(`Failed to send common command. Code: ${err.code}, message: ${err.message}`); 326 }) 327 // 设置指定播放列表单项的ID，供session选择播放 328 let queueItemId = 0; 329 await controller.skipToQueueItem(queueItemId).then(() => { 330 console.info(`SkipToQueueItem successfully`); 331 }).catch((err: BusinessError) => { 332 console.error(`Failed to skip to queue item. Code: ${err.code}, message: ${err.message}`); 333 }); 334 } 335 ``` 336 3376. 在媒体会话控制方应用退出时及时取消事件监听，并释放资源。 338 339 ```ts 340 import { avSession as AVSessionManager } from '@kit.AVSessionKit'; 341 import { BusinessError } from '@kit.BasicServicesKit'; 342 343 async function destroyController() { 344 // 假设我们已经有了一个对应session的controller，如何创建controller可以参考之前的案例 345 let controller = await AVSessionManager.createController("") 346 347 // 销毁当前的controller，销毁后这个controller将不在可用 348 controller.destroy((err: BusinessError) => { 349 if (err) { 350 console.error(`Failed to destroy controller. Code: ${err.code}, message: ${err.message}`); 351 } else { 352 console.info(`Destroy controller SUCCESS`); 353 } 354 }); 355 } 356 ``` 357 358## 相关实例 359 360针对媒体会话控制方开发，有以下相关实例可供参考： 361 362- [媒体会话——控制方（仅对系统应用开放）（ArkTS）（Full SDK）（API10）](https://gitee.com/openharmony/applications_app_samples/tree/master/code/SystemFeature/Media/AVSession/MediaController)