diff --git a/zh-cn/application-dev/reference/apis/js-apis-media.md b/zh-cn/application-dev/reference/apis/js-apis-media.md index eb19641c2015e90fb225ae49722782940c735d61..fb9cca77a8aab56e9a2cd00aff20d7a33d5369e5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-media.md +++ b/zh-cn/application-dev/reference/apis/js-apis-media.md @@ -10,7 +10,7 @@ - 音频播放（[AudioPlayer](#audioplayer)） - 视频播放（[VideoPlayer](#videoplayer8)） - 音频录制（[AudioRecorder](#audiorecorder)） -- 视频录制（[VideoRecorder](#videoRecorder8)） +- 视频录制（[VideoRecorder](#videoRecorder9)） 后续将提供以下功能：DataSource音视频播放、音视频编解码、容器封装解封装、媒体能力查询等功能。 @@ -125,9 +125,9 @@ createAudioRecorder(): AudioRecorder let audiorecorder = media.createAudioRecorder(); ``` -## media.createVideoRecorder8+ +## media.createVideoRecorder9+ -createVideoRecorder(callback: AsyncCallback\<[VideoRecorder](#videorecorder8)>): void +createVideoRecorder(callback: AsyncCallback\<[VideoRecorder](#videorecorder9)>): void 异步方式创建视频录制实例。通过注册回调函数获取返回值。 @@ -137,7 +137,7 @@ createVideoRecorder(callback: AsyncCallback\<[VideoRecorder](#videorecorder8)>): | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------- | ---- | ------------------------------ | -| callback | AsyncCallback<[VideoRecorder](#videorecorder8)> | 是 | 异步创建视频录制实例回调方法。 | +| callback | AsyncCallback<[VideoRecorder](#videorecorder9)> | 是 | 异步创建视频录制实例回调方法。 | **示例：** @@ -154,9 +154,9 @@ media.createVideoRecorder((error, video) => { }); ``` -## media.createVideoRecorder8+ +## media.createVideoRecorder9+ -createVideoRecorder(): Promise<[VideoRecorder](#videorecorder8)> +createVideoRecorder(): Promise<[VideoRecorder](#videorecorder9)> 异步方式创建视频录制实例。通过Promise获取返回值。 @@ -166,7 +166,7 @@ createVideoRecorder(): Promise<[VideoRecorder](#videorecorder8)> | 类型 | 说明 | | ----------------------------------------- | ----------------------------------- | -| Promise<[VideoRecorder](#videorecorder8)> | 异步创建视频录制实例Promise返回值。 | +| Promise<[VideoRecorder](#videorecorder9)> | 异步创建视频录制实例Promise返回值。 | **示例：** @@ -1802,7 +1802,7 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error' | audioSampleRate | number | 否 | 音频采集采样率，默认值为48000。 | | numberOfChannels | number | 否 | 音频采集声道数，默认值为2。 | | format | [AudioOutputFormat](#audiooutputformat) | 否 | 音量输出封装格式，默认设置为MPEG_4。 | -| location8+ | [Location](#location8) | 否 | 音频采集的地理位置。 | +| location | [Location](#location) | 否 | 音频采集的地理位置。 | | uri | string | 是 | 音频输出URI：fd://xx (fd number)
![zh-cn_image_0000001164217678](figures/zh-cn_image_url.png)
文件需要由调用者创建，并赋予适当的权限。 | | audioEncoderMime | [CodecMimeType](#codecmimetype8) | 否 | 音频编码格式。 | @@ -1836,9 +1836,9 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error' | AMR_WB | 4 | 封装为AMR_WB格式。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | | AAC_ADTS | 6 | 封装为ADTS（Audio Data Transport Stream）格式，是AAC音频的传输流格式。 | -## VideoRecorder8+ +## VideoRecorder9+ -视频录制管理类，用于录制视频媒体。在调用VideoRecorder的方法前，需要先通过[createVideoRecorder()](#mediacreatevideorecorder8)构建一个[VideoRecorder](#videorecorder8)实例。 +视频录制管理类，用于录制视频媒体。在调用VideoRecorder的方法前，需要先通过[createVideoRecorder()](#mediacreatevideorecorder9)构建一个[VideoRecorder](#videorecorder9)实例。 视频录制demo可参考：[视频录制开发指导](../../media/video-recorder.md) @@ -1848,9 +1848,9 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error' | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------------ | -------------------------------------- | ---- | ---- | ---------------- | -| state8+ | [VideoRecordState](#videorecordstate8) | 是 | 否 | 视频录制的状态。 | +| state8+ | [VideoRecordState](#videorecordstate9) | 是 | 否 | 视频录制的状态。 | -### prepare8+ +### prepare9+ prepare(config: VideoRecorderConfig, callback: AsyncCallback\): void; @@ -1864,7 +1864,7 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------------------------------- | ---- | ----------------------------------- | -| config | [VideoRecorderConfig](#videorecorderconfig8) | 是 | 配置视频录制的相关参数。 | +| config | [VideoRecorderConfig](#videorecorderconfig9) | 是 | 配置视频录制的相关参数。 | | callback | AsyncCallback\ | 是 | 异步视频录制prepare方法的回调方法。 | **示例：** @@ -1918,7 +1918,7 @@ media.createVideoRecorder((err, recorder) => { }); ``` -### prepare8+ +### prepare9+ prepare(config: VideoRecorderConfig): Promise\; @@ -1932,7 +1932,7 @@ prepare(config: VideoRecorderConfig): Promise\; | 参数名 | 类型 | 必填 | 说明 | | ------ | -------------------------------------------- | ---- | ------------------------ | -| config | [VideoRecorderConfig](#videorecorderconfig8) | 是 | 配置视频录制的相关参数。 | +| config | [VideoRecorderConfig](#videorecorderconfig9) | 是 | 配置视频录制的相关参数。 | **返回值：** @@ -1989,7 +1989,7 @@ await videoRecorder.prepare(videoConfig).then(() => { }); ``` -### getInputSurface8+ +### getInputSurface9+ getInputSurface(callback: AsyncCallback\): void; @@ -2022,7 +2022,7 @@ videoRecorder.getInputSurface((err, surfaceId) => { }); ``` -### getInputSurface8+ +### getInputSurface9+ getInputSurface(): Promise\; @@ -2055,7 +2055,7 @@ await videoRecorder.getInputSurface().then((surfaceId) => { }); ``` -### start8+ +### start9+ start(callback: AsyncCallback\): void; @@ -2084,7 +2084,7 @@ videoRecorder.start((err) => { }); ``` -### start8+ +### start9+ start(): Promise\; @@ -2113,7 +2113,7 @@ await videoRecorder.start().then(() => { }); ``` -### pause8+ +### pause9+ pause(callback: AsyncCallback\): void; @@ -2142,7 +2142,7 @@ videoRecorder.pause((err) => { }); ``` -### pause8+ +### pause9+ pause(): Promise\; @@ -2171,7 +2171,7 @@ await videoRecorder.pause().then(() => { }); ``` -### resume8+ +### resume9+ resume(callback: AsyncCallback\): void; @@ -2198,7 +2198,7 @@ videoRecorder.resume((err) => { }); ``` -### resume8+ +### resume9+ resume(): Promise\; @@ -2225,7 +2225,7 @@ await videoRecorder.resume().then(() => { }); ``` -### stop8+ +### stop9+ stop(callback: AsyncCallback\): void; @@ -2254,7 +2254,7 @@ videoRecorder.stop((err) => { }); ``` -### stop8+ +### stop9+ stop(): Promise\; @@ -2283,7 +2283,7 @@ await videoRecorder.stop().then(() => { }); ``` -### release8+ +### release9+ release(callback: AsyncCallback\): void; @@ -2310,7 +2310,7 @@ videoRecorder.release((err) => { }); ``` -### release8+ +### release9+ release(): Promise\; @@ -2337,7 +2337,7 @@ await videoRecorder.release().then(() => { }); ``` -### reset8+ +### reset9+ reset(callback: AsyncCallback\): void; @@ -2366,7 +2366,7 @@ videoRecorder.reset((err) => { }); ``` -### reset8+ +### reset9+ reset(): Promise\; @@ -2395,7 +2395,7 @@ await videoRecorder.reset().then(() => { }); ``` -### on('error')8+ +### on('error')9+ on(type: 'error', callback: ErrorCallback): void @@ -2421,7 +2421,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 // 当获取videoRecordState接口出错时通过此订阅事件上报 ``` -## VideoRecordState8+ +## VideoRecordState9+ 视频录制的状态机。可通过state属性获取当前状态。 @@ -2436,7 +2436,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 | stopped | string | 视频录制停止。 | | error | string | 错误状态。 | -## VideoRecorderConfig8+ +## VideoRecorderConfig9+ 表示视频录制的参数设置。 @@ -2444,14 +2444,14 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 | 名称 | 参数类型 | 必填 | 说明 | | --------------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ | -| audioSourceType | [AudioSourceType](#audiosourcetype8) | 是 | 视频录制的音频源类型。 | -| videoSourceType | [VideoSourceType](#videosourcetype8) | 是 | 视频录制的视频源类型。 | -| profile | [VideoRecorderProfile](#videorecorderprofile8) | 是 | 视频录制的profile。 | +| audioSourceType | [AudioSourceType](#audiosourcetype9) | 是 | 视频录制的音频源类型。 | +| videoSourceType | [VideoSourceType](#videosourcetype9) | 是 | 视频录制的视频源类型。 | +| profile | [VideoRecorderProfile](#videorecorderprofile9) | 是 | 视频录制的profile。 | | rotation | number | 否 | 录制视频的旋转角度。 | -| location | [Location](#location8) | 否 | 录制视频的地理位置。 | +| location | [Location](#location) | 否 | 录制视频的地理位置。 | | url | string | 是 | 视频输出URL：fd://xx (fd number)
![](figures/zh-cn_image_url.png)
文件需要由调用者创建，并赋予适当的权限。 | -## AudioSourceType8+ +## AudioSourceType9+ 表示视频录制中音频源类型的枚举。 @@ -2462,7 +2462,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 | AUDIO_SOURCE_TYPE_DEFAULT | 0 | 默认的音频输入源类型。 | | AUDIO_SOURCE_TYPE_MIC | 1 | 表示MIC的音频输入源。 | -## VideoSourceType8+ +## VideoSourceType9+ 表示视频录制中视频源类型的枚举。 @@ -2473,7 +2473,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 | VIDEO_SOURCE_TYPE_SURFACE_YUV | 0 | 输入surface中携带的是raw data。 | | VIDEO_SOURCE_TYPE_SURFACE_ES | 1 | 输入surface中携带的是ES data。 | -## VideoRecorderProfile8+ +## VideoRecorderProfile9+ 视频录制的配置文件。 @@ -2486,9 +2486,11 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 | audioCodec | [CodecMimeType](#codecmimetype8) | 是 | 音频编码格式。 | | audioSampleRate | number | 是 | 音频采样率。 | | fileFormat | [ContainerFormatType](#containerformattype8) | 是 | 文件的容器格式。 | -| videoCodec | [CodecMimeType](#codecmimetype8) | 是 | 视频编码格式。 | +| videoBitrate | number | 是 | 视频编码比特率。 | +| videoCodec | [CodecMimeType](#CodecMimeType8) | 是 | 视频编码格式。 | | videoFrameWidth | number | 是 | 录制视频帧的宽。 | | videoFrameHeight | number | 是 | 录制视频帧的高。 | +| videoFrameRate | number | 是 | 录制视频帧率。 | ## ContainerFormatType8+ @@ -2501,7 +2503,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 | CFT_MPEG_4 | "mp4" | 视频的容器格式，MP4。 | | CFT_MPEG_4A | "m4a" | 音频的容器格式，M4A。 | -## Location8+ +## Location 视频录制的地理位置。