Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
001ecef8
D
Docs
项目概览
OpenHarmony
/
Docs
12 个月 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
001ecef8
编写于
3月 21, 2022
作者:
O
openharmony_ci
提交者:
Gitee
3月 21, 2022
浏览文件
操作
浏览文件
下载
差异文件
!2253 js-apis-media检视错误修改
Merge pull request !2253 from 马靖涛/master
上级
19e5fa4f
d8367186
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
43 addition
and
41 deletion
+43
-41
zh-cn/application-dev/reference/apis/js-apis-media.md
zh-cn/application-dev/reference/apis/js-apis-media.md
+43
-41
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-media.md
浏览文件 @
001ecef8
...
...
@@ -10,7 +10,7 @@
-
音频播放(
[
AudioPlayer
](
#audioplayer
)
)
-
视频播放(
[
VideoPlayer
](
#videoplayer8
)
)
-
音频录制(
[
AudioRecorder
](
#audiorecorder
)
)
-
视频录制(
[
VideoRecorder
](
#videoRecorder
8
)
)
-
视频录制(
[
VideoRecorder
](
#videoRecorder
9
)
)
后续将提供以下功能:DataSource音视频播放、音视频编解码、容器封装解封装、媒体能力查询等功能。
...
...
@@ -125,9 +125,9 @@ createAudioRecorder(): AudioRecorder
let
audiorecorder
=
media
.
createAudioRecorder
();
```
## media.createVideoRecorder<sup>
8
+</sup>
## media.createVideoRecorder<sup>
9
+</sup>
createVideoRecorder(callback: AsyncCallback
\<
[
VideoRecorder
](
#videorecorder
8
)
>): void
createVideoRecorder(callback: AsyncCallback
\<
[
VideoRecorder
](
#videorecorder
9
)
>): void
异步方式创建视频录制实例。通过注册回调函数获取返回值。
...
...
@@ -137,7 +137,7 @@ createVideoRecorder(callback: AsyncCallback\<[VideoRecorder](#videorecorder8)>):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------ |
| callback | AsyncCallback
<
[
VideoRecorder
](
#videorecorder
8
)
>
| 是 | 异步创建视频录制实例回调方法。 |
| callback | AsyncCallback
<
[
VideoRecorder
](
#videorecorder
9
)
>
| 是 | 异步创建视频录制实例回调方法。 |
**示例:**
...
...
@@ -154,9 +154,9 @@ media.createVideoRecorder((error, video) => {
});
```
## media.createVideoRecorder<sup>
8
+</sup>
## media.createVideoRecorder<sup>
9
+</sup>
createVideoRecorder(): Promise
<
[
VideoRecorder
](
#videorecorder
8
)
>
createVideoRecorder(): Promise
<
[
VideoRecorder
](
#videorecorder
9
)
>
异步方式创建视频录制实例。通过Promise获取返回值。
...
...
@@ -166,7 +166,7 @@ createVideoRecorder(): Promise<[VideoRecorder](#videorecorder8)>
| 类型 | 说明 |
| ----------------------------------------- | ----------------------------------- |
| Promise
<
[
VideoRecorder
](
#videorecorder
8
)
>
| 异步创建视频录制实例Promise返回值。 |
| Promise
<
[
VideoRecorder
](
#videorecorder
9
)
>
| 异步创建视频录制实例Promise返回值。 |
**示例:**
...
...
@@ -1802,7 +1802,7 @@ audioRecorder.prepare(); // prepare不设置参数,触发'error'
| audioSampleRate | number | 否 | 音频采集采样率,默认值为48000。 |
| numberOfChannels | number | 否 | 音频采集声道数,默认值为2。 |
| format |
[
AudioOutputFormat
](
#audiooutputformat
)
| 否 | 音量输出封装格式,默认设置为MPEG_4。 |
| location
<sup>
8+
</sup>
|
[
Location
](
#location8
)
| 否 | 音频采集的地理位置。 |
| location
|
[
Location
](
#location
)
| 否 | 音频采集的地理位置。 |
| uri | string | 是 | 音频输出URI:fd://xx
(fd
number)
<br/>
![
zh-cn_image_0000001164217678
](
figures/zh-cn_image_url.png
)
<br/>
文件需要由调用者创建,并赋予适当的权限。 |
| audioEncoderMime |
[
CodecMimeType
](
#codecmimetype8
)
| 否 | 音频编码格式。 |
...
...
@@ -1836,9 +1836,9 @@ audioRecorder.prepare(); // prepare不设置参数,触发'error'
| AMR_WB | 4 | 封装为AMR_WB格式。
<br/>
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| AAC_ADTS | 6 | 封装为ADTS(Audio
Data
Transport
Stream)格式,是AAC音频的传输流格式。 |
## VideoRecorder<sup>
8
+</sup>
## VideoRecorder<sup>
9
+</sup>
视频录制管理类,用于录制视频媒体。在调用VideoRecorder的方法前,需要先通过
[
createVideoRecorder()
](
#mediacreatevideorecorder
8
)
构建一个
[
VideoRecorder
](
#videorecorder8
)
实例。
视频录制管理类,用于录制视频媒体。在调用VideoRecorder的方法前,需要先通过
[
createVideoRecorder()
](
#mediacreatevideorecorder
9
)
构建一个
[
VideoRecorder
](
#videorecorder9
)
实例。
视频录制demo可参考:
[
视频录制开发指导
](
../../media/video-recorder.md
)
...
...
@@ -1848,9 +1848,9 @@ audioRecorder.prepare(); // prepare不设置参数,触发'error'
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------ | -------------------------------------- | ---- | ---- | ---------------- |
| state
<sup>
8+
</sup>
|
[
VideoRecordState
](
#videorecordstate
8
)
| 是 | 否 | 视频录制的状态。 |
| state
<sup>
8+
</sup>
|
[
VideoRecordState
](
#videorecordstate
9
)
| 是 | 否 | 视频录制的状态。 |
### 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;
...
...
@@ -1864,7 +1864,7 @@ prepare(config: VideoRecorderConfig, callback: AsyncCallback\<void>): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------- | ---- | ----------------------------------- |
| config |
[
VideoRecorderConfig
](
#videorecorderconfig
8
)
| 是 | 配置视频录制的相关参数。 |
| config |
[
VideoRecorderConfig
](
#videorecorderconfig
9
)
| 是 | 配置视频录制的相关参数。 |
| callback | AsyncCallback
\<
void> | 是 | 异步视频录制prepare方法的回调方法。 |
**示例:**
...
...
@@ -1918,7 +1918,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>;
...
...
@@ -1932,7 +1932,7 @@ prepare(config: VideoRecorderConfig): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------------------------------- | ---- | ------------------------ |
| config |
[
VideoRecorderConfig
](
#videorecorderconfig
8
)
| 是 | 配置视频录制的相关参数。 |
| config |
[
VideoRecorderConfig
](
#videorecorderconfig
9
)
| 是 | 配置视频录制的相关参数。 |
**返回值:**
...
...
@@ -1989,7 +1989,7 @@ await videoRecorder.prepare(videoConfig).then(() => {
});
```
### getInputSurface<sup>
8
+</sup>
### getInputSurface<sup>
9
+</sup>
getInputSurface(callback: AsyncCallback
\<
string>): void;
...
...
@@ -2022,7 +2022,7 @@ videoRecorder.getInputSurface((err, surfaceId) => {
});
```
### getInputSurface<sup>
8
+</sup>
### getInputSurface<sup>
9
+</sup>
getInputSurface(): Promise
\<
string>;
...
...
@@ -2055,7 +2055,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;
...
...
@@ -2084,7 +2084,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>;
...
...
@@ -2113,7 +2113,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;
...
...
@@ -2142,7 +2142,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>;
...
...
@@ -2171,7 +2171,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;
...
...
@@ -2198,7 +2198,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>;
...
...
@@ -2225,7 +2225,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;
...
...
@@ -2254,7 +2254,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>;
...
...
@@ -2283,7 +2283,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;
...
...
@@ -2310,7 +2310,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>;
...
...
@@ -2337,7 +2337,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;
...
...
@@ -2366,7 +2366,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>;
...
...
@@ -2395,7 +2395,7 @@ await videoRecorder.reset().then(() => {
});
```
### on('error')<sup>
8
+</sup>
### on('error')<sup>
9
+</sup>
on(type: 'error', callback: ErrorCallback): void
...
...
@@ -2421,7 +2421,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
// 当获取videoRecordState接口出错时通过此订阅事件上报
```
## VideoRecordState<sup>
8
+</sup>
## VideoRecordState<sup>
9
+</sup>
视频录制的状态机。可通过state属性获取当前状态。
...
...
@@ -2436,7 +2436,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
| stopped | string | 视频录制停止。 |
| error | string | 错误状态。 |
## VideoRecorderConfig<sup>
8
+</sup>
## VideoRecorderConfig<sup>
9
+</sup>
表示视频录制的参数设置。
...
...
@@ -2444,14 +2444,14 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
| 名称 | 参数类型 | 必填 | 说明 |
| --------------- | ---------------------------------------------- | ---- | ------------------------------------------------------------ |
| audioSourceType |
[
AudioSourceType
](
#audiosourcetype
8
)
| 是 | 视频录制的音频源类型。 |
| videoSourceType |
[
VideoSourceType
](
#videosourcetype
8
)
| 是 | 视频录制的视频源类型。 |
| profile |
[
VideoRecorderProfile
](
#videorecorderprofile
8
)
| 是 | 视频录制的profile。 |
| audioSourceType |
[
AudioSourceType
](
#audiosourcetype
9
)
| 是 | 视频录制的音频源类型。 |
| videoSourceType |
[
VideoSourceType
](
#videosourcetype
9
)
| 是 | 视频录制的视频源类型。 |
| profile |
[
VideoRecorderProfile
](
#videorecorderprofile
9
)
| 是 | 视频录制的profile。 |
| rotation | number | 否 | 录制视频的旋转角度。 |
| location |
[
Location
](
#location
8
)
| 否 | 录制视频的地理位置。 |
| location |
[
Location
](
#location
)
| 否 | 录制视频的地理位置。 |
| url | string | 是 | 视频输出URL:fd://xx
(fd
number)
<br/>
![](
figures/zh-cn_image_url.png
)
<br/>
文件需要由调用者创建,并赋予适当的权限。 |
## AudioSourceType<sup>
8
+</sup>
## AudioSourceType<sup>
9
+</sup>
表示视频录制中音频源类型的枚举。
...
...
@@ -2462,7 +2462,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
| AUDIO_SOURCE_TYPE_DEFAULT | 0 | 默认的音频输入源类型。 |
| AUDIO_SOURCE_TYPE_MIC | 1 | 表示MIC的音频输入源。 |
## VideoSourceType<sup>
8
+</sup>
## VideoSourceType<sup>
9
+</sup>
表示视频录制中视频源类型的枚举。
...
...
@@ -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。 |
## VideoRecorderProfile<sup>
8
+</sup>
## VideoRecorderProfile<sup>
9
+</sup>
视频录制的配置文件。
...
...
@@ -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 | 是 | 录制视频帧率。 |
## ContainerFormatType<sup>8+</sup>
...
...
@@ -2501,7 +2503,7 @@ videoRecorder.on('error', (error) => { // 设置'error'事件回调
| CFT_MPEG_4 | "mp4" | 视频的容器格式,MP4。 |
| 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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录