1# 使用AVRecorder录制视频(ArkTS) 2 3当前仅支持[AVRecorder](media-kit-intro.md#avrecorder)开发视频录制,集成了音频捕获,音频编码,视频编码,音视频封装功能,适用于实现简单视频录制并直接得到视频本地文件的场景。 4 5本开发指导将以“开始录制-暂停录制-恢复录制-停止录制”的一次流程为示例,向开发者讲解如何使用AVRecorder进行视频录制。 6 7在进行应用开发的过程中,开发者可以通过AVRecorder的state属性主动获取当前状态,或使用on('stateChange')方法监听状态变化。开发过程中应该严格遵循状态机要求,例如只能在started状态下调用pause()接口,只能在paused状态下调用resume()接口。 8 9**图1** 录制状态变化示意图 10 11 12 13状态的详细说明请参考[AVRecorderState](../../reference/apis-media-kit/js-apis-media.md#avrecorderstate9)。 14 15 16## 申请权限 17 18在开发此功能前,开发者应根据实际需求申请相关权限: 19- 当需要使用麦克风时,需要申请**ohos.permission.MICROPHONE**麦克风权限。申请方式请参考:[向用户申请授权](../../security/AccessToken/request-user-authorization.md)。 20- 当需要使用相机拍摄时,需要申请**ohos.permission.CAMERA**相机权限。申请方式请参考:[向用户申请授权](../../security/AccessToken/request-user-authorization.md)。 21- 当需要从图库读取图片或视频文件时,请优先使用媒体库[Picker选择媒体资源](../medialibrary/photoAccessHelper-photoviewpicker.md)。 22- 当需要保存图片或视频文件至图库时,请优先使用[安全控件保存媒体资源](../medialibrary/photoAccessHelper-savebutton.md)。 23 24> **说明:** 25> 26> 仅应用需要克隆、备份或同步用户公共目录的图片、视频类文件时,可申请ohos.permission.READ_IMAGEVIDEO、ohos.permission.WRITE_IMAGEVIDEO权限来读写音频文件,申请方式请参考<!--RP1-->[申请受控权限](../../security/AccessToken/declare-permissions-in-acl.md)<!--RP1End-->。 27 28 29## 开发步骤及注意事项 30 31> **说明:** 32> 33> AVRecorder只负责视频数据的处理,需要与视频数据采集模块配合才能完成视频录制。视频数据采集模块需要通过Surface将视频数据传递给AVRecorder进行数据处理。当前常用的数据采集模块为相机模块,具体请参考[相机-录像](../camera/camera-recording.md)。 34> 文件的创建与存储,请参考[应用文件访问与管理](../../file-management/app-file-access.md),默认存储在应用的沙箱路径之下,如需存储至图库,请使用[安全控件保存媒体资源](../medialibrary/photoAccessHelper-savebutton.md)对沙箱内文件进行存储。 35 36 37AVRecorder详细的API说明请参考[AVRecorder API参考](../../reference/apis-media-kit/js-apis-media.md#avrecorder9)。 38 391. 创建AVRecorder实例,实例创建完成进入idle状态。 40 41 ```ts 42 import { media } from '@kit.MediaKit'; 43 import { BusinessError } from '@kit.BasicServicesKit'; 44 45 let avRecorder: media.AVRecorder; 46 media.createAVRecorder().then((recorder: media.AVRecorder) => { 47 avRecorder = recorder; 48 }, (error: BusinessError) => { 49 console.error('createAVRecorder failed'); 50 }) 51 ``` 52 532. 设置业务需要的监听事件,监听状态变化及错误上报。 54 | 事件类型 | 说明 | 55 | -------- | -------- | 56 | stateChange | 必要事件,监听播放器的state属性改变 | 57 | error | 必要事件,监听播放器的错误信息 | 58 59 ```ts 60 import { media } from '@kit.MediaKit'; 61 import { BusinessError } from '@kit.BasicServicesKit'; 62 63 // 状态上报回调函数 64 avRecorder.on('stateChange', (state: media.AVRecorderState, reason: media.StateChangeReason) => { 65 console.info('current state is: ' + state); 66 }) 67 // 错误上报回调函数 68 avRecorder.on('error', (err: BusinessError) => { 69 console.error('error happened, error message is ' + err); 70 }) 71 ``` 72 733. 配置视频录制参数,调用prepare()接口,此时进入prepared状态。 74 75 > **说明:** 76 > 77 > 配置参数需要注意: 78 > 79 > - 配置参数之前需要确保完成对应权限的申请,请参考[申请权限](#申请权限)。 80 > 81 > - prepare接口的入参avConfig中仅设置视频相关的配置参数,如示例代码所示。 82 > 如果添加了音频参数,系统将认为是“音频+视频录制”。 83 > 84 > - 需要使用支持的[录制规格](media-kit-intro.md#支持的格式),视频比特率、分辨率、帧率以实际硬件设备支持的范围为准。 85 > 86 > - 录制输出的url地址(即示例里avConfig中的url),形式为fd://xx (fd number)。需要调用基础文件操作接口([Core File Kit的ohos.file.fs](../../reference/apis-core-file-kit/js-apis-file-fs.md))实现应用文件访问能力,获取方式参考[应用文件访问与管理](../../file-management/app-file-access.md)。 87 88 ```ts 89 import { media } from '@kit.MediaKit'; 90 import { BusinessError } from '@kit.BasicServicesKit'; 91 92 let avProfile: media.AVRecorderProfile = { 93 fileFormat : media.ContainerFormatType.CFT_MPEG_4, // 视频文件封装格式,只支持MP4 94 videoBitrate : 200000, // 视频比特率 95 videoCodec : media.CodecMimeType.VIDEO_AVC, // 视频文件编码格式,支持avc格式 96 videoFrameWidth : 640, // 视频分辨率的宽 97 videoFrameHeight : 480, // 视频分辨率的高 98 videoFrameRate : 30 // 视频帧率 99 }; 100 101 const context: Context = getContext(this); // 参考应用文件访问与管理 102 let filePath: string = context.filesDir + '/example.mp4'; 103 let videoFile: fs.File = fs.openSync(filePath, OpenMode.READ_WRITE | OpenMode.CREATE); 104 let fileFd = videoFile.fd; // 获取文件fd 105 106 let avConfig: media.AVRecorderConfig = { 107 videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV, // 视频源类型,支持YUV和ES两种格式 108 profile : avProfile, 109 url: 'fd://' + fileFd.toString(), // 参考应用文件访问与管理开发示例新建并读写一个视频文件 110 rotation : 0 // 视频旋转角度,默认为0不旋转,支持的值为0、90、180、270 111 }; 112 avRecorder.prepare(avConfig).then(() => { 113 console.info('avRecorder prepare success'); 114 }, (error: BusinessError) => { 115 console.error('avRecorder prepare failed'); 116 }) 117 ``` 118 1194. 获取视频录制需要的SurfaceID。 120 调用getInputSurface()接口,接口的返回值SurfaceID用于传递给视频数据输入源模块。常用的输入源模块为相机,以下示例代码中,采用相机作为视频输入源为例。 121 122 输入源模块通过SurfaceID可以获取到Surface,通过Surface可以将视频数据流传递给AVRecorder,由AVRecorder再进行视频数据的处理。 123 124 ```ts 125 import { BusinessError } from '@kit.BasicServicesKit'; 126 127 avRecorder.getInputSurface().then((surfaceId: string) => { 128 console.info('avRecorder getInputSurface success'); 129 }, (error: BusinessError) => { 130 console.error('avRecorder getInputSurface failed'); 131 }) 132 ``` 133 1345. 初始化视频数据输入源。该步骤需要在输入源模块完成,以相机为例,需要创建录像输出流,包括创建Camera对象、获取相机列表、创建相机输入流等,相机详细步骤请参考[相机-录像方案](../camera/camera-recording.md)。 135 1366. 开始录制,启动输入源输入视频数据,例如相机模块调用camera.VideoOutput.start接口启动相机录制。然后调用AVRecorder.start()接口,此时AVRecorder进入started状态。 137 1387. 暂停录制,调用pause()接口,此时AVRecorder进入paused状态,同时暂停输入源输入数据。例如相机模块调用camera.VideoOutput.stop停止相机视频数据输入。 139 1408. 恢复录制,调用resume()接口,此时再次进入started状态。 141 1429. 停止录制,调用stop()接口,此时进入stopped状态,同时停止相机录制。 143 14410. 重置资源,调用reset()重新进入idle状态,允许重新配置录制参数。 145 14611. 销毁实例,调用release()进入released状态,退出录制,释放视频数据输入源相关资源,例如相机资源。 147 148 149## 完整示例 150 151参考以下示例,完成“开始录制-暂停录制-恢复录制-停止录制”的完整流程。 152 153 154```ts 155import { media } from '@kit.MediaKit'; 156import { BusinessError } from '@kit.BasicServicesKit'; 157import { fileIo as fs, ReadOptions } from '@kit.CoreFileKit'; 158import { photoAccessHelper } from '@kit.MediaLibraryKit'; 159 160 161const TAG = 'VideoRecorderDemo:'; 162export class VideoRecorderDemo { 163 const context: Context = getContext(this); 164 private avRecorder: media.AVRecorder | undefined = undefined; 165 private videoOutSurfaceId: string = ""; 166 private avProfile: media.AVRecorderProfile = { 167 fileFormat : media.ContainerFormatType.CFT_MPEG_4, // 视频文件封装格式,只支持MP4 168 videoBitrate : 100000, // 视频比特率 169 videoCodec : media.CodecMimeType.VIDEO_AVC, // 视频文件编码格式,支持avc格式 170 videoFrameWidth : 640, // 视频分辨率的宽 171 videoFrameHeight : 480, // 视频分辨率的高 172 videoFrameRate : 30 // 视频帧率 173 }; 174 private avConfig: media.AVRecorderConfig = { 175 videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV, // 视频源类型,支持YUV和ES两种格式 176 profile : this.avProfile, 177 url : 'fd://35', // 参考应用文件访问与管理开发示例新建并读写一个文件 178 rotation : 0 // 视频旋转角度,默认为0不旋转,支持的值为0、90、180、270 179 }; 180 181 private uriPath: string = ''; // 文件uri,可用于安全控件保存媒体资源 182 private filePath: string = ''; // 文件路径 183 private fileFd: number = 0; 184 185 // 创建文件以及设置avConfig.url 186 async createAndSetFd() { 187 const path: string = context.filesDir + '/example.mp4'; // 文件沙箱路径,文件后缀名应与封装格式对应 188 const videoFile: fs.File = fs.openSync(path, OpenMode.READ_WRITE | OpenMode.CREATE); 189 this.avConfig.url = 'fd://' + videoFile.fd; // 设置url 190 this.fileFd = videoFile.fd; // 文件fd 191 this.filePath = path; 192 } 193 194 // 注册avRecorder回调函数 195 setAvRecorderCallback() { 196 if (this.avRecorder != undefined) { 197 // 状态机变化回调函数 198 this.avRecorder.on('stateChange', (state: media.AVRecorderState, reason: media.StateChangeReason) => { 199 console.info(TAG + 'current state is: ' + state); 200 }) 201 // 错误上报回调函数 202 this.avRecorder.on('error', (err: BusinessError) => { 203 console.error(TAG + 'error ocConstantSourceNode, error message is ' + err); 204 }) 205 } 206 } 207 208 // 相机相关准备工作 209 async prepareCamera() { 210 // 具体实现查看相机资料 211 } 212 213 // 启动相机出流 214 async startCameraOutput() { 215 // 调用VideoOutput的start接口开始录像输出 216 } 217 218 // 停止相机出流 219 async stopCameraOutput() { 220 // 调用VideoOutput的stop接口停止录像输出 221 } 222 223 // 释放相机实例 224 async releaseCamera() { 225 // 释放相机准备阶段创建出的实例 226 } 227 228 // 开始录制对应的流程 229 async startRecordingProcess() { 230 if (this.avRecorder === undefined) { 231 // 1.创建录制实例; 232 this.avRecorder = await media.createAVRecorder(); 233 this.setAvRecorderCallback(); 234 } 235 // 2. 获取录制文件fd;获取到的值传递给avConfig里的url,实现略 236 // 3.配置录制参数完成准备工作 237 await this.avRecorder.prepare(this.avConfig); 238 this.videoOutSurfaceId = await this.avRecorder.getInputSurface(); 239 // 4.完成相机相关准备工作 240 await this.prepareCamera(); 241 // 5.启动相机出流 242 await this.startCameraOutput(); 243 // 6. 启动录制 244 await this.avRecorder.start(); 245 246 } 247 248 // 暂停录制对应的流程 249 async pauseRecordingProcess() { 250 if (this.avRecorder != undefined && this.avRecorder.state === 'started') { // 仅在started状态下调用pause为合理状态切换 251 await this.avRecorder.pause(); 252 await this.stopCameraOutput(); // 停止相机出流 253 } 254 } 255 256 // 恢复录制对应的流程 257 async resumeRecordingProcess() { 258 if (this.avRecorder != undefined && this.avRecorder.state === 'paused') { // 仅在paused状态下调用resume为合理状态切换 259 await this.startCameraOutput(); // 启动相机出流 260 await this.avRecorder.resume(); 261 } 262 } 263 264 async stopRecordingProcess() { 265 if (this.avRecorder != undefined) { 266 // 1. 停止录制 267 if (this.avRecorder.state === 'started' 268 || this.avRecorder.state === 'paused' ) { // 仅在started或者paused状态下调用stop为合理状态切换 269 await this.avRecorder.stop(); 270 await this.stopCameraOutput(); 271 } 272 // 2.重置 273 await this.avRecorder.reset(); 274 // 3.释放录制实例 275 await this.avRecorder.release(); 276 // 4.文件录制完成后,关闭fd,实现略 277 await fs.close(videoFile); 278 // 5.释放相机相关实例 279 await this.releaseCamera(); 280 } 281 } 282 283 // 安全控件保存媒体资源至图库 284 async saveRecorderAsset() { 285 let phAccessHelper = photoAccessHelper.getPhotoAccessHelper(this.context); 286 // 需要确保uriPath对应的资源存在 287 this.uriPath = file.Uri.getUriFromPath(this.filePath); // 获取录制文件的uri,用于安全控件保存至图库 288 let assetChangeRequest: photoAccessHelper.MediaAssetChangeRequest = 289 photoAccessHelper.MediaAssetChangeRequest.createVideoAssetRequest(this.context, this.uriPath); 290 await phAccessHelper.applyChanges(assetChangeRequest); 291 } 292 293 // 一个完整的【开始录制-暂停录制-恢复录制-停止录制】示例 294 async videoRecorderDemo() { 295 await this.startRecordingProcess(); // 开始录制 296 // 用户此处可以自行设置录制时长,例如通过设置休眠阻止代码执行 297 await this.pauseRecordingProcess(); //暂停录制 298 await this.resumeRecordingProcess(); // 恢复录制 299 await this.stopRecordingProcess(); // 停止录制 300 // 安全控件保存媒体资源至图库 301 await this.saveRecorderAsset(); 302 } 303} 304``` 305