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