1# 视频播放 2 3在OpenHarmony系统中，提供两种视频播放开发的方案： 4 5- [AVPlayer](using-avplayer-for-playback.md)：功能较完善的音视频播放ArkTS/JS API，集成了流媒体和本地资源解析，媒体资源解封装，视频解码和渲染功能，适用于对媒体资源进行端到端播放的场景，可直接播放mp4、mkv等格式的视频文件。 6 7- Video组件：封装了视频播放的基础能力，需要设置数据源以及基础信息即可播放视频，但相对扩展能力较弱。Video组件由ArkUI提供能力，相关指导请参考UI开发文档-[Video组件](../ui/arkts-common-components-video-player.md)。 8 9本开发指导将介绍如何使用AVPlayer开发视频播放功能，以完整地播放一个视频作为示例，实现端到端播放原始媒体资源。如果要实现后台播放或熄屏播放，需要使用[AVSession（媒体会话）](avsession-overview.md)和[申请长时任务](../task-management/continuous-task.md)，避免播放过程中音频模块被系统强制中断。 10 11## 开发指导 12 13播放的全流程包含：创建AVPlayer，设置播放资源和窗口，设置播放参数（音量/倍速/缩放模式），播放控制（播放/暂停/跳转/停止），重置，销毁资源。在进行应用开发的过程中，开发者可以通过AVPlayer的state属性主动获取当前状态或使用on('stateChange')方法监听状态变化。如果应用在视频播放器处于错误状态时执行操作，系统可能会抛出异常或生成其他未定义的行为。 14 15**图1** 播放状态变化示意图 16 17 18 19状态的详细说明请参考[AVPlayerState](../reference/apis/js-apis-media.md#avplayerstate9)。当播放处于prepared / playing / paused / completed状态时，播放引擎处于工作状态，这需要占用系统较多的运行内存。当客户端暂时不使用播放器时，调用reset()或release()回收内存资源，做好资源利用。 20 21### 开发步骤及注意事项 22 23详细的API说明请参考[AVPlayer API参考](../reference/apis/js-apis-media.md#avplayer9)。 24 251. 创建实例createAVPlayer()，AVPlayer初始化idle状态。 26 272. 设置业务需要的监听事件，搭配全流程场景使用。支持的监听事件包括： 28 | 事件类型 | 说明 | 29 | -------- | -------- | 30 | stateChange | 必要事件，监听播放器的state属性改变。 | 31 | error | 必要事件，监听播放器的错误信息。 | 32 | durationUpdate | 用于进度条，监听进度条长度，刷新资源时长。 | 33 | timeUpdate | 用于进度条，监听进度条当前位置，刷新当前时间。 | 34 | seekDone | 响应API调用，监听seek()请求完成情况。<br/>当使用seek()跳转到指定播放位置后，如果seek操作成功，将上报该事件。 | 35 | speedDone | 响应API调用，监听setSpeed()请求完成情况。<br/>当使用setSpeed()设置播放倍速后，如果setSpeed操作成功，将上报该事件。 | 36 | volumeChange | 响应API调用，监听setVolume()请求完成情况。<br/>当使用setVolume()调节播放音量后，如果setVolume操作成功，将上报该事件。 | 37 | bitrateDone | 响应API调用，用于HLS协议流，监听setBitrate()请求完成情况。<br/>当使用setBitrate()指定播放比特率后，如果setBitrate操作成功，将上报该事件。 | 38 | availableBitrates | 用于HLS协议流，监听HLS资源的可选bitrates，用于setBitrate()。 | 39 | bufferingUpdate | 用于网络播放，监听网络播放缓冲信息。 | 40 | startRenderFrame | 用于视频播放，监听视频播放首帧渲染时间。 | 41 | videoSizeChange | 用于视频播放，监听视频播放的宽高信息，可用于调整窗口大小、比例。 | 42 | audioInterrupt | 监听音频焦点切换信息，搭配属性audioInterruptMode使用。<br/>如果当前设备存在多个媒体正在播放，音频焦点被切换（即播放其他媒体如通话等）时将上报该事件，应用可以及时处理。 | 43 443. 设置资源：设置属性url，AVPlayer进入initialized状态。 45 > **说明：** 46 > 47 > 下面代码示例中的url仅作示意使用，开发者需根据实际情况，确认资源有效性并设置： 48 > 49 > - 如果使用本地资源播放，必须确认资源文件可用，并使用应用沙箱路径访问对应资源，参考[获取应用文件路径](../application-models/application-context-stage.md#获取应用文件路径)。应用沙箱的介绍及如何向应用沙箱推送文件，请参考[文件管理](../file-management/app-sandbox-directory.md)。 50 > 51 > - 如果使用网络播放路径，需[申请相关权限](../security/accesstoken-guidelines.md)：ohos.permission.INTERNET。 52 > 53 > - 如果使用ResourceManager.getRawFd打开HAP资源文件描述符，使用方法可参考[ResourceManager API参考](../reference/apis/js-apis-resource-manager.md#getrawfd9)。 54 > 55 > - 需要使用[支持的播放格式与协议](avplayer-avrecorder-overview.md#支持的格式与协议)。 56 574. 设置窗口：获取并设置属性SurfaceID，用于设置显示画面。 58 应用需要从XComponent组件获取surfaceID，获取方式请参考[XComponent](../reference/arkui-ts/ts-basic-components-xcomponent.md)。 59 605. 准备播放：调用prepare()，AVPlayer进入prepared状态，此时可以获取duration，设置缩放模式、音量等。 61 626. 视频播控：播放play()，暂停pause()，跳转seek()，停止stop() 等操作。 63 647. （可选）更换资源：调用reset()重置资源，AVPlayer重新进入idle状态，允许更换资源url。 65 668. 退出播放：调用release()销毁实例，AVPlayer进入released状态，退出播放。 67 68 69### 完整示例 70 71 72```ts 73import media from '@ohos.multimedia.media'; 74import fs from '@ohos.file.fs'; 75import common from '@ohos.app.ability.common'; 76import { BusinessError } from '@ohos.base'; 77 78export class AVPlayerDemo { 79 private count: number = 0; 80 private surfaceID: string = ''; // surfaceID用于播放画面显示，具体的值需要通过Xcomponent接口获取，相关文档链接见上面Xcomponent创建方法 81 private isSeek: boolean = true; // 用于区分模式是否支持seek操作 82 private fileSize: number = -1; 83 private fd: number = 0; 84 // 注册avplayer回调函数 85 setAVPlayerCallback(avPlayer: media.AVPlayer) { 86 // seek操作结果回调函数 87 avPlayer.on('seekDone', (seekDoneTime: number) => { 88 console.info(`AVPlayer seek succeeded, seek time is ${seekDoneTime}`); 89 }) 90 // error回调监听函数,当avPlayer在操作过程中出现错误时调用reset接口触发重置流程 91 avPlayer.on('error', (err: BusinessError) => { 92 console.error(`Invoke avPlayer failed, code is ${err.code}, message is ${err.message}`); 93 avPlayer.reset(); // 调用reset重置资源，触发idle状态 94 }) 95 // 状态机变化回调函数 96 avPlayer.on('stateChange', async (state: string, reason: media.StateChangeReason) => { 97 switch (state) { 98 case 'idle': // 成功调用reset接口后触发该状态机上报 99 console.info('AVPlayer state idle called.'); 100 avPlayer.release(); // 调用release接口销毁实例对象 101 break; 102 case 'initialized': // avplayer 设置播放源后触发该状态上报 103 console.info('AVPlayer state initialized called.'); 104 avPlayer.surfaceId = this.surfaceID; // 设置显示画面，当播放的资源为纯音频时无需设置 105 avPlayer.prepare(); 106 break; 107 case 'prepared': // prepare调用成功后上报该状态机 108 console.info('AVPlayer state prepared called.'); 109 avPlayer.play(); // 调用播放接口开始播放 110 break; 111 case 'playing': // play成功调用后触发该状态机上报 112 console.info('AVPlayer state playing called.'); 113 if (this.count !== 0) { 114 if (this.isSeek) { 115 console.info('AVPlayer start to seek.'); 116 avPlayer.seek(avPlayer.duration); //seek到视频末尾 117 } else { 118 // 当播放模式不支持seek操作时继续播放到结尾 119 console.info('AVPlayer wait to play end.'); 120 } 121 } else { 122 avPlayer.pause(); // 调用暂停接口暂停播放 123 } 124 this.count++; 125 break; 126 case 'paused': // pause成功调用后触发该状态机上报 127 console.info('AVPlayer state paused called.'); 128 avPlayer.play(); // 再次播放接口开始播放 129 break; 130 case 'completed': // 播放结束后触发该状态机上报 131 console.info('AVPlayer state completed called.'); 132 avPlayer.stop(); //调用播放结束接口 133 break; 134 case 'stopped': // stop接口成功调用后触发该状态机上报 135 console.info('AVPlayer state stopped called.'); 136 avPlayer.reset(); // 调用reset接口初始化avplayer状态 137 break; 138 case 'released': 139 console.info('AVPlayer state released called.'); 140 break; 141 default: 142 console.info('AVPlayer state unknown called.'); 143 break; 144 } 145 }) 146 } 147 148 // 以下demo为使用fs文件系统打开沙箱地址获取媒体文件地址并通过url属性进行播放示例 149 async avPlayerUrlDemo() { 150 // 创建avPlayer实例对象 151 let avPlayer: media.AVPlayer = await media.createAVPlayer(); 152 // 创建状态机变化回调函数 153 this.setAVPlayerCallback(avPlayer); 154 let fdPath = 'fd://'; 155 let context = getContext(this) as common.UIAbilityContext; 156 // 通过UIAbilityContext获取沙箱地址filesDir，以Stage模型为例 157 let pathDir = context.filesDir; 158 let path = pathDir + '/H264_AAC.mp4'; 159 // 打开相应的资源文件地址获取fd，并为url赋值触发initialized状态机上报 160 let file = await fs.open(path); 161 fdPath = fdPath + '' + file.fd; 162 this.isSeek = true; // 支持seek操作 163 avPlayer.url = fdPath; 164 } 165 166 // 以下demo为使用资源管理接口获取打包在HAP内的媒体资源文件并通过fdSrc属性进行播放示例 167 async avPlayerFdSrcDemo() { 168 // 创建avPlayer实例对象 169 let avPlayer: media.AVPlayer = await media.createAVPlayer(); 170 // 创建状态机变化回调函数 171 this.setAVPlayerCallback(avPlayer); 172 // 通过UIAbilityContext的resourceManager成员的getRawFd接口获取媒体资源播放地址 173 // 返回类型为{fd,offset,length},fd为HAP包fd地址，offset为媒体资源偏移量，length为播放长度 174 let context = getContext(this) as common.UIAbilityContext; 175 let fileDescriptor = await context.resourceManager.getRawFd('H264_AAC.mp4'); 176 let avFileDescriptor: media.AVFileDescriptor = 177 { fd: fileDescriptor.fd, offset: fileDescriptor.offset, length: fileDescriptor.length }; 178 this.isSeek = true; // 支持seek操作 179 // 为fdSrc赋值触发initialized状态机上报 180 avPlayer.fdSrc = avFileDescriptor; 181 } 182 183 // 以下demo为使用fs文件系统打开沙箱地址获取媒体文件地址并通过dataSrc属性进行播放(seek模式)示例 184 async avPlayerDataSrcSeekDemo() { 185 // 创建avPlayer实例对象 186 let avPlayer: media.AVPlayer = await media.createAVPlayer(); 187 // 创建状态机变化回调函数 188 this.setAVPlayerCallback(avPlayer); 189 // dataSrc播放模式的的播放源地址，当播放为Seek模式时fileSize为播放文件的具体大小，下面会对fileSize赋值 190 let src: media.AVDataSrcDescriptor = { 191 fileSize: -1, 192 callback: (buf: ArrayBuffer, length: number, pos: number | undefined) => { 193 let num = 0; 194 if (buf == undefined || length == undefined || pos == undefined) { 195 return -1; 196 } 197 num = fs.readSync(this.fd, buf, { offset: pos, length: length }); 198 if (num > 0 && (this.fileSize >= pos)) { 199 return num; 200 } 201 return -1; 202 } 203 } 204 let context = getContext(this) as common.UIAbilityContext; 205 // 通过UIAbilityContext获取沙箱地址filesDir，以Stage模型为例 206 let pathDir = context.filesDir; 207 let path = pathDir + '/H264_AAC.mp4'; 208 await fs.open(path).then((file: fs.File) => { 209 this.fd = file.fd; 210 }) 211 // 获取播放文件的大小 212 this.fileSize = fs.statSync(path).size; 213 src.fileSize = this.fileSize; 214 this.isSeek = true; // 支持seek操作 215 avPlayer.dataSrc = src; 216 } 217 218 // 以下demo为使用fs文件系统打开沙箱地址获取媒体文件地址并通过dataSrc属性进行播放(No seek模式)示例 219 async avPlayerDataSrcNoSeekDemo() { 220 // 创建avPlayer实例对象 221 let avPlayer: media.AVPlayer = await media.createAVPlayer(); 222 // 创建状态机变化回调函数 223 this.setAVPlayerCallback(avPlayer); 224 let context = getContext(this) as common.UIAbilityContext; 225 let src: media.AVDataSrcDescriptor = { 226 fileSize: -1, 227 callback: (buf: ArrayBuffer, length: number) => { 228 let num = 0; 229 if (buf == undefined || length == undefined) { 230 return -1; 231 } 232 num = fs.readSync(this.fd, buf); 233 if (num > 0) { 234 return num; 235 } 236 return -1; 237 } 238 } 239 // 通过UIAbilityContext获取沙箱地址filesDir，以Stage模型为例 240 let pathDir = context.filesDir; 241 let path = pathDir + '/H264_AAC.mp4'; 242 await fs.open(path).then((file: fs.File) => { 243 this.fd = file.fd; 244 }) 245 this.isSeek = false; // 不支持seek操作 246 avPlayer.dataSrc = src; 247 } 248 249 // 以下demo为通过url设置网络地址来实现播放直播码流的demo 250 async avPlayerLiveDemo() { 251 // 创建avPlayer实例对象 252 let avPlayer: media.AVPlayer = await media.createAVPlayer(); 253 // 创建状态机变化回调函数 254 this.setAVPlayerCallback(avPlayer); 255 this.isSeek = false; // 不支持seek操作 256 avPlayer.url = 'http://xxx.xxx.xxx.xxx:xx/xx/index.m3u8'; // 播放hls网络直播码流 257 } 258} 259``` 260 261## 相关实例 262 263针对视频播放，有以下相关实例可供参考： 264 265- [视频播放（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/OpenHarmony-4.0-Release/code/BasicFeature/Media/VideoPlay) 266 267- [视频播放器（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Media/VideoPlayer)
