Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 95090887 编写于 作者: M m00472246
浏览文件
操作

js-apis-media错误修改 Signed-off-by: m00472246 <majingtao1@huawei.com> 

Signed-off-by: Nm00472246 <majingtao1@huawei.com>
Change-Id: If4e415a683ddcaa110d7ab70d876863daf1fac74
Signed-off-by: Nm00472246 <majingtao1@huawei.com>
上级 66a0fb33 8e755f44
隐藏空白更改
内联 并排
Showing with 44 addition and 42 deletion
zh-cn/application-dev/reference/apis/js-apis-media.md
浏览文件 @ 95090887
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
- 音频播放（[AudioPlayer](#audioplayer)） - 音频播放（[AudioPlayer](#audioplayer)）
- 视频播放（[VideoPlayer](#videoplayer8)） - 视频播放（[VideoPlayer](#videoplayer8)）
- 音频录制（[AudioRecorder](#audiorecorder)） - 音频录制（[AudioRecorder](#audiorecorder)）
- 视频录制（[VideoRecorder](#videoRecorder8)） - 视频录制（[VideoRecorder](#videoRecorder9)）
后续将提供以下功能：DataSource音视频播放、音视频编解码、容器封装解封装、媒体能力查询等功能。 后续将提供以下功能：DataSource音视频播放、音视频编解码、容器封装解封装、媒体能力查询等功能。
...@@ -125,9 +125,9 @@ createAudioRecorder(): AudioRecorder ...@@ -125,9 +125,9 @@ createAudioRecorder(): AudioRecorder
let audiorecorder = media.createAudioRecorder(); let audiorecorder = media.createAudioRecorder();
``` ```
## media.createVideoRecorder<sup>8+</sup> ## media.createVideoRecorder<sup>9+</sup>
createVideoRecorder(callback: AsyncCallback\<[VideoRecorder](#videorecorder8)>): void createVideoRecorder(callback: AsyncCallback\<[VideoRecorder](#videorecorder9)>): void
异步方式创建视频录制实例。通过注册回调函数获取返回值。 异步方式创建视频录制实例。通过注册回调函数获取返回值。
...@@ -137,7 +137,7 @@ createVideoRecorder(callback: AsyncCallback\<[VideoRecorder](#videorecorder8)>): ...@@ -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) => { ...@@ -154,9 +154,9 @@ media.createVideoRecorder((error, video) => {
}); });
``` ```
## media.createVideoRecorder<sup>8+</sup> ## media.createVideoRecorder<sup>9+</sup>
createVideoRecorder(): Promise<[VideoRecorder](#videorecorder8)> createVideoRecorder(): Promise<[VideoRecorder](#videorecorder9)>
异步方式创建视频录制实例。通过Promise获取返回值。 异步方式创建视频录制实例。通过Promise获取返回值。
...@@ -166,7 +166,7 @@ createVideoRecorder(): Promise<[VideoRecorder](#videorecorder8)> ...@@ -166,7 +166,7 @@ createVideoRecorder(): Promise<[VideoRecorder](#videorecorder8)>
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------- | ----------------------------------- | | ----------------------------------------- | ----------------------------------- |
| Promise<[VideoRecorder](#videorecorder8)> | 异步创建视频录制实例Promise返回值。 | | Promise<[VideoRecorder](#videorecorder9)> | 异步创建视频录制实例Promise返回值。 |
**示例：** **示例：**
...@@ -1796,8 +1796,8 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error' ...@@ -1796,8 +1796,8 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error'
| audioSampleRate | number | 否 | 音频采集采样率，默认值为48000。 | | audioSampleRate | number | 否 | 音频采集采样率，默认值为48000。 |
| numberOfChannels | number | 否 | 音频采集声道数，默认值为2。 | | numberOfChannels | number | 否 | 音频采集声道数，默认值为2。 |
| format | [AudioOutputFormat](#audiooutputformat) | 否 | 音量输出封装格式，默认设置为MPEG_4。 | | format | [AudioOutputFormat](#audiooutputformat) | 否 | 音量输出封装格式，默认设置为MPEG_4。 |
| location<sup>8+</sup> | [Location](#location8) | 否 | 音频采集的地理位置。 | | location | [Location](#location) | 否 | 音频采集的地理位置。 |
| uri | string | 是 | 视频输出URI：fd://xx&nbsp;(fd&nbsp;number)<br/>![zh-cn_image_0000001164217678](figures/zh-cn_image_url.png) <br/>文件需要由调用者创建，并赋予适当的权限。 | | uri | string | 是 | 音频输出URI：fd://xx&nbsp;(fd&nbsp;number)<br/>![zh-cn_image_0000001164217678](figures/zh-cn_image_url.png) <br/>文件需要由调用者创建，并赋予适当的权限。 |
| audioEncoderMime | [CodecMimeType](#codecmimetype8) | 否 | 音频编码格式。 | | audioEncoderMime | [CodecMimeType](#codecmimetype8) | 否 | 音频编码格式。 |
...@@ -1830,9 +1830,9 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error' ...@@ -1830,9 +1830,9 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error'
| AMR_WB | 4 | 封装为AMR_WB格式。<br/>本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 | | AMR_WB | 4 | 封装为AMR_WB格式。<br/>本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| AAC_ADTS | 6 | 封装为ADTS（Audio&nbsp;Data&nbsp;Transport&nbsp;Stream）格式，是AAC音频的传输流格式。 | | AAC_ADTS | 6 | 封装为ADTS（Audio&nbsp;Data&nbsp;Transport&nbsp;Stream）格式，是AAC音频的传输流格式。 |
## VideoRecorder<sup>8+</sup> ## VideoRecorder<sup>9+</sup>
视频录制管理类，用于录制视频媒体。在调用VideoRecorder的方法前，需要先通过[createVideoRecorder()](#mediacreatevideorecorder8)构建一个[VideoRecorder](#videorecorder8)实例。 视频录制管理类，用于录制视频媒体。在调用VideoRecorder的方法前，需要先通过[createVideoRecorder()](#mediacreatevideorecorder9)构建一个[VideoRecorder](#videorecorder9)实例。
视频录制demo可参考：[视频录制开发指导](../../media/video-recorder.md) 视频录制demo可参考：[视频录制开发指导](../../media/video-recorder.md)
...@@ -1842,9 +1842,9 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error' ...@@ -1842,9 +1842,9 @@ audioRecorder.prepare(); // prepare不设置参数，触发'error'
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------ | -------------------------------------- | ---- | ---- | ---------------- | | ------------------ | -------------------------------------- | ---- | ---- | ---------------- |
| state<sup>8+</sup> | [VideoRecordState](#videorecordstate8) | 是 | 否 | 视频录制的状态。 | | state<sup>8+</sup> | [VideoRecordState](#videorecordstate9) | 是 | 否 | 视频录制的状态。 |
### prepare<sup>8+</sup><a name=videorecorder_prepare1></a> ### prepare<sup>9+</sup><a name=videorecorder_prepare1></a>
prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void; prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void;
...@@ -1858,7 +1858,7 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void; ...@@ -1858,7 +1858,7 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------- | ---- | ----------------------------------- | | -------- | -------------------------------------------- | ---- | ----------------------------------- |
| config | [VideoRecorderConfig](#videorecorderconfig8) | 是 | 配置视频录制的相关参数。 | | config | [VideoRecorderConfig](#videorecorderconfig9) | 是 | 配置视频录制的相关参数。 |
| callback | AsyncCallback\<void> | 是 | 异步视频录制prepare方法的回调方法。 | | callback | AsyncCallback\<void> | 是 | 异步视频录制prepare方法的回调方法。 |
**示例：** **示例：**
...@@ -1912,7 +1912,7 @@ media.createVideoRecorder((err, recorder) => { ...@@ -1912,7 +1912,7 @@ media.createVideoRecorder((err, recorder) => {
}); });
``` ```
### prepare<sup>8+</sup><a name=videorecorder_prepare2></a> ### prepare<sup>9+</sup><a name=videorecorder_prepare2></a>
prepare(config: VideoRecorderConfig): Promise\<void>; prepare(config: VideoRecorderConfig): Promise\<void>;
...@@ -1926,7 +1926,7 @@ prepare(config: VideoRecorderConfig): Promise\<void>; ...@@ -1926,7 +1926,7 @@ prepare(config: VideoRecorderConfig): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------------------------------- | ---- | ------------------------ | | ------ | -------------------------------------------- | ---- | ------------------------ |
| config | [VideoRecorderConfig](#videorecorderconfig8) | 是 | 配置视频录制的相关参数。 | | config | [VideoRecorderConfig](#videorecorderconfig9) | 是 | 配置视频录制的相关参数。 |
**返回值：** **返回值：**
...@@ -1983,7 +1983,7 @@ await videoRecorder.prepare(videoConfig).then(() => { ...@@ -1983,7 +1983,7 @@ await videoRecorder.prepare(videoConfig).then(() => {
}); });
``` ```
### getInputSurface<sup>8+</sup> ### getInputSurface<sup>9+</sup>
getInputSurface(callback: AsyncCallback\<string>): void; getInputSurface(callback: AsyncCallback\<string>): void;
...@@ -2016,7 +2016,7 @@ videoRecorder.getInputSurface((err, surfaceId) => { ...@@ -2016,7 +2016,7 @@ videoRecorder.getInputSurface((err, surfaceId) => {
}); });
``` ```
### getInputSurface<sup>8+</sup> ### getInputSurface<sup>9+</sup>
getInputSurface(): Promise\<string>; getInputSurface(): Promise\<string>;
...@@ -2049,7 +2049,7 @@ await videoRecorder.getInputSurface().then((surfaceId) => { ...@@ -2049,7 +2049,7 @@ await videoRecorder.getInputSurface().then((surfaceId) => {
}); });
``` ```
### start<sup>8+</sup><a name=videorecorder_start1></a> ### start<sup>9+</sup><a name=videorecorder_start1></a>
start(callback: AsyncCallback\<void>): void; start(callback: AsyncCallback\<void>): void;
...@@ -2078,7 +2078,7 @@ videoRecorder.start((err) => { ...@@ -2078,7 +2078,7 @@ videoRecorder.start((err) => {
}); });
``` ```
### start<sup>8+</sup><a name=videorecorder_start2></a> ### start<sup>9+</sup><a name=videorecorder_start2></a>
start(): Promise\<void>; start(): Promise\<void>;
...@@ -2107,7 +2107,7 @@ await videoRecorder.start().then(() => { ...@@ -2107,7 +2107,7 @@ await videoRecorder.start().then(() => {
}); });
``` ```
### pause<sup>8+</sup><a name=videorecorder_pause1></a> ### pause<sup>9+</sup><a name=videorecorder_pause1></a>
pause(callback: AsyncCallback\<void>): void; pause(callback: AsyncCallback\<void>): void;
...@@ -2136,7 +2136,7 @@ videoRecorder.pause((err) => { ...@@ -2136,7 +2136,7 @@ videoRecorder.pause((err) => {
}); });
``` ```
### pause<sup>8+</sup><a name=videorecorder_pause2></a> ### pause<sup>9+</sup><a name=videorecorder_pause2></a>
pause(): Promise\<void>; pause(): Promise\<void>;
...@@ -2165,7 +2165,7 @@ await videoRecorder.pause().then(() => { ...@@ -2165,7 +2165,7 @@ await videoRecorder.pause().then(() => {
}); });
``` ```
### resume<sup>8+</sup><a name=videorecorder_resume1></a> ### resume<sup>9+</sup><a name=videorecorder_resume1></a>
resume(callback: AsyncCallback\<void>): void; resume(callback: AsyncCallback\<void>): void;
...@@ -2192,7 +2192,7 @@ videoRecorder.resume((err) => { ...@@ -2192,7 +2192,7 @@ videoRecorder.resume((err) => {
}); });
``` ```
### resume<sup>8+</sup><a name=videorecorder_resume2></a> ### resume<sup>9+</sup><a name=videorecorder_resume2></a>
resume(): Promise\<void>; resume(): Promise\<void>;
...@@ -2219,7 +2219,7 @@ await videoRecorder.resume().then(() => { ...@@ -2219,7 +2219,7 @@ await videoRecorder.resume().then(() => {
}); });
``` ```
### stop<sup>8+</sup><a name=videorecorder_stop1></a> ### stop<sup>9+</sup><a name=videorecorder_stop1></a>
stop(callback: AsyncCallback\<void>): void; stop(callback: AsyncCallback\<void>): void;
...@@ -2248,7 +2248,7 @@ videoRecorder.stop((err) => { ...@@ -2248,7 +2248,7 @@ videoRecorder.stop((err) => {
}); });
``` ```
### stop<sup>8+</sup><a name=videorecorder_stop2></a> ### stop<sup>9+</sup><a name=videorecorder_stop2></a>
stop(): Promise\<void>; stop(): Promise\<void>;
...@@ -2277,7 +2277,7 @@ await videoRecorder.stop().then(() => { ...@@ -2277,7 +2277,7 @@ await videoRecorder.stop().then(() => {
}); });
``` ```
### release<sup>8+</sup><a name=videorecorder_release1></a> ### release<sup>9+</sup><a name=videorecorder_release1></a>
release(callback: AsyncCallback\<void>): void; release(callback: AsyncCallback\<void>): void;
...@@ -2304,7 +2304,7 @@ videoRecorder.release((err) => { ...@@ -2304,7 +2304,7 @@ videoRecorder.release((err) => {
}); });
``` ```
### release<sup>8+</sup><a name=videorecorder_release2></a> ### release<sup>9+</sup><a name=videorecorder_release2></a>
release(): Promise\<void>; release(): Promise\<void>;
...@@ -2331,7 +2331,7 @@ await videoRecorder.release().then(() => { ...@@ -2331,7 +2331,7 @@ await videoRecorder.release().then(() => {
}); });
``` ```
### reset<sup>8+</sup><a name=videorecorder_reset1></a> ### reset<sup>9+</sup><a name=videorecorder_reset1></a>
reset(callback: AsyncCallback\<void>): void; reset(callback: AsyncCallback\<void>): void;
...@@ -2360,7 +2360,7 @@ videoRecorder.reset((err) => { ...@@ -2360,7 +2360,7 @@ videoRecorder.reset((err) => {
}); });
``` ```
### reset<sup>8+</sup><a name=videorecorder_reset2></a> ### reset<sup>9+</sup><a name=videorecorder_reset2></a>
reset(): Promise\<void>; reset(): Promise\<void>;
...@@ -2389,7 +2389,7 @@ await videoRecorder.reset().then(() => { ...@@ -2389,7 +2389,7 @@ await videoRecorder.reset().then(() => {
}); });
``` ```
### on('error')<sup>8+</sup> ### on('error')<sup>9+</sup>
on(type: 'error', callback: ErrorCallback): void on(type: 'error', callback: ErrorCallback): void
...@@ -2415,7 +2415,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 ...@@ -2415,7 +2415,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
// 当获取videoRecordState接口出错时通过此订阅事件上报 // 当获取videoRecordState接口出错时通过此订阅事件上报
``` ```
## VideoRecordState<sup>8+</sup> ## VideoRecordState<sup>9+</sup>
视频录制的状态机。可通过state属性获取当前状态。 视频录制的状态机。可通过state属性获取当前状态。
...@@ -2430,7 +2430,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 ...@@ -2430,7 +2430,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
| stopped | string | 视频录制停止。 | | stopped | string | 视频录制停止。 |
| error | string | 错误状态。 | | error | string | 错误状态。 |
## VideoRecorderConfig<sup>8+</sup> ## VideoRecorderConfig<sup>9+</sup>
表示视频录制的参数设置。 表示视频录制的参数设置。
...@@ -2438,14 +2438,14 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 ...@@ -2438,14 +2438,14 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| --------------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ | | --------------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ |
| audioSourceType | [AudioSourceType](#audiosourcetype8) | 是 | 视频录制的音频源类型。 | | audioSourceType | [AudioSourceType](#audiosourcetype9) | 是 | 视频录制的音频源类型。 |
| videoSourceType | [VideoSourceType](#videosourcetype8) | 是 | 视频录制的视频源类型。 | | videoSourceType | [VideoSourceType](#videosourcetype9) | 是 | 视频录制的视频源类型。 |
| profile | [VideoRecorderProfile](#videorecorderprofile8) | 是 | 视频录制的profile。 | | profile | [VideoRecorderProfile](#videorecorderprofile9) | 是 | 视频录制的profile。 |
| rotation | number | 否 | 录制视频的旋转角度。 | | rotation | number | 否 | 录制视频的旋转角度。 |
| location | [Location](#location8) | 否 | 录制视频的地理位置。 | | location | [Location](#location) | 否 | 录制视频的地理位置。 |
| url | string | 是 | 视频输出URL：fd://xx&nbsp;(fd&nbsp;number)<br/>![](figures/zh-cn_image_url.png) <br/>文件需要由调用者创建，并赋予适当的权限。 | | url | string | 是 | 视频输出URL：fd://xx&nbsp;(fd&nbsp;number)<br/>![](figures/zh-cn_image_url.png) <br/>文件需要由调用者创建，并赋予适当的权限。 |
## AudioSourceType<sup>8+</sup> ## AudioSourceType<sup>9+</sup>
表示视频录制中音频源类型的枚举。 表示视频录制中音频源类型的枚举。
...@@ -2456,7 +2456,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 ...@@ -2456,7 +2456,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
| AUDIO_SOURCE_TYPE_DEFAULT | 0 | 默认的音频输入源类型。 | | AUDIO_SOURCE_TYPE_DEFAULT | 0 | 默认的音频输入源类型。 |
| AUDIO_SOURCE_TYPE_MIC | 1 | 表示MIC的音频输入源。 | | AUDIO_SOURCE_TYPE_MIC | 1 | 表示MIC的音频输入源。 |
## VideoSourceType<sup>8+</sup> ## VideoSourceType<sup>9+</sup>
表示视频录制中视频源类型的枚举。 表示视频录制中视频源类型的枚举。
...@@ -2467,7 +2467,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 ...@@ -2467,7 +2467,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
| VIDEO_SOURCE_TYPE_SURFACE_YUV | 0 | 输入surface中携带的是raw data。 | | VIDEO_SOURCE_TYPE_SURFACE_YUV | 0 | 输入surface中携带的是raw data。 |
| VIDEO_SOURCE_TYPE_SURFACE_ES | 1 | 输入surface中携带的是ES data。 | | VIDEO_SOURCE_TYPE_SURFACE_ES | 1 | 输入surface中携带的是ES data。 |
## VideoRecorderProfile<sup>8+</sup> ## VideoRecorderProfile<sup>9+</sup>
视频录制的配置文件。 视频录制的配置文件。
...@@ -2480,9 +2480,11 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 ...@@ -2480,9 +2480,11 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
| audioCodec | [CodecMimeType](#codecmimetype8) | 是 | 音频编码格式。 | | audioCodec | [CodecMimeType](#codecmimetype8) | 是 | 音频编码格式。 |
| audioSampleRate | number | 是 | 音频采样率。 | | audioSampleRate | number | 是 | 音频采样率。 |
| fileFormat | [ContainerFormatType](#containerformattype8) | 是 | 文件的容器格式。 | | fileFormat | [ContainerFormatType](#containerformattype8) | 是 | 文件的容器格式。 |
| videoCodec | [CodecMimeType](#codecmimetype8) | 是 | 视频编码格式。 | | videoBitrate | number | 是 | 视频编码比特率。 |
| videoCodec | [CodecMimeType](#CodecMimeType8) | 是 | 视频编码格式。 |
| videoFrameWidth | number | 是 | 录制视频帧的宽。 | | videoFrameWidth | number | 是 | 录制视频帧的宽。 |
| videoFrameHeight | number | 是 | 录制视频帧的高。 | | videoFrameHeight | number | 是 | 录制视频帧的高。 |
| videoFrameRate | number | 是 | 录制视频帧率。 |
## ContainerFormatType<sup>8+</sup> ## ContainerFormatType<sup>8+</sup>
...@@ -2495,7 +2497,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调 ...@@ -2495,7 +2497,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
| CFT_MPEG_4 | "mp4" | 视频的容器格式，MP4。 | | CFT_MPEG_4 | "mp4" | 视频的容器格式，MP4。 |
| CFT_MPEG_4A | "m4a" | 音频的容器格式，M4A。 | | CFT_MPEG_4A | "m4a" | 音频的容器格式，M4A。 |
## Location<sup>8+</sup> ## Location
视频录制的地理位置。 视频录制的地理位置。
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或