Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 c342360b 编写于 作者: M m00472246
浏览文件
操作

API说明文档优化 Signed-off-by: m00472246 <majingtao1@huawei.com> 

Signed-off-by: Nm00472246 <majingtao1@huawei.com>
上级 64756443
隐藏空白更改
内联 并排
Showing with 6 addition and 379 deletion
1.patch 已删除 100644 → 0
浏览文件 @ 64756443
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 dab4a75c0..ed5519e84 100644
--- a/zh-cn/application-dev/reference/apis/js-apis-media.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-media.md
@@ -52,7 +52,7 @@ createVideoPlayer(callback: AsyncCallback\<[VideoPlayer](#videoplayer8)>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------- | ---- | ------------------------------ |
-| callback | AsyncCallback<[VideoPlayer](#videoplayer8)> | 是 | 回调函数。异步返回VideoPlayer实例，可用于管理和播放视频媒体。 |
+| callback | AsyncCallback<[VideoPlayer](#videoplayer8)> | 是 | 回调函数。异步返回VideoPlayer实例，失败时返回null。可用于管理和播放视频媒体。 |
**示例：**
@@ -79,9 +79,9 @@ createVideoPlayer(): Promise<[VideoPlayer](#videoplayer8)>
**返回值：**
-| 类型 | 说明 |
-| ------------------------------------- | ----------------------------------- |
-| Promise<[VideoPlayer](#videoplayer8)> | Promise对象。异步返回VideoPlayer实例，可用于管理和播放视频媒体。 |
+| 类型 | 说明 |
+| ------------------------------------- | ------------------------------------------------------------ |
+| Promise<[VideoPlayer](#videoplayer8)> | 异步返回VideoPlayer实例，失败时返回null。可用于管理和播放视频媒体。 |
**示例：**
@@ -134,7 +134,7 @@ createVideoRecorder(callback: AsyncCallback\<[VideoRecorder](#videorecorder9)>):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------ |
-| callback | AsyncCallback<[VideoRecorder](#videorecorder9)> | 是 | 回调函数。异步返回VideoRecorder实例，可用于录制视频媒体。 |
+| callback | AsyncCallback<[VideoRecorder](#videorecorder9)> | 是 | 回调函数。异步返回VideoRecorder实例，失败时返回null。可用于录制视频媒体。 |
**示例：**
@@ -162,9 +162,9 @@ createVideoRecorder(): Promise<[VideoRecorder](#videorecorder9)>
**返回值：**
-| 类型 | 说明 |
-| ----------------------------------------- | ----------------------------------- |
-| Promise<[VideoRecorder](#videorecorder9)> | Promise对象。异步返回VideoRecorder实例，可用于录制视频媒体。 |
+| 类型 | 说明 |
+| ----------------------------------------- | ------------------------------------------------------------ |
+| Promise<[VideoRecorder](#videorecorder9)> | Promise对象。异步返回VideoRecorder实例，失败时返回null。可用于录制视频媒体。 |
**示例：**
@@ -361,9 +361,9 @@ seek(timeMs: number): void
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| ------ | ------ | ---- | ------------------------------------ |
-| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms）。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| ------ | ------ | ---- | ----------------------------------------------------------- |
+| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms），取值范围[0, duration]。 |
**示例：**
@@ -426,9 +426,9 @@ getTrackDescription(callback: AsyncCallback<Array\<MediaDescription>>): void
**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | ------------------------------------------------------------ | ---- | -------------------------- |
-| callback | AsyncCallback<Array<[MediaDescription](#mediadescription8)>> | 是 | 获取音频轨道信息回调方法。 |
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | ------------------------------------------------------------ | ---- | ---------------------------------- |
+| callback | AsyncCallback<Array<[MediaDescription](#mediadescription8)>> | 是 | 音频轨道信息MediaDescription数组。 |
**示例：**
@@ -462,9 +462,9 @@ getTrackDescription(): Promise<Array\<MediaDescription>>
**返回值：**
-| 类型 | 说明 |
-| ------------------------------------------------------ | ------------------------------- |
-| Promise<Array<[MediaDescription](#mediadescription8)>> | 获取音频轨道信息Promise返回值。 |
+| 类型 | 说明 |
+| ------------------------------------------------------ | ---------------------------------- |
+| Promise<Array<[MediaDescription](#mediadescription8)>> | 音频轨道信息MediaDescription数组。 |
**示例：**
@@ -738,9 +738,9 @@ setDisplaySurface(surfaceId: string): Promise\<void>
**返回值：**
-| 类型 | 说明 |
-| -------------- | ------------------------------ |
-| Promise\<void> | 设置SurfaceId的Promise返回值。 |
+| 类型 | 说明 | |
+| -------------- | ------------------------------ | ---- |
+| Promise\<void> | 设置SurfaceId的Promise返回值。 | |
**示例：**
@@ -789,9 +789,9 @@ prepare(): Promise\<void>
**返回值：**
-| 类型 | 说明 |
-| -------------- | ----------------------------- |
-| Promise\<void> | 准备播放视频的Promise返回值。 |
+| 类型 | 说明 | |
+| -------------- | ----------------------------- | ---- |
+| Promise\<void> | 准备播放视频的Promise返回值。 | |
**示例：**
@@ -839,9 +839,9 @@ play(): Promise\<void>;
**返回值：**
-| 类型 | 说明 |
-| -------------- | ----------------------------- |
-| Promise\<void> | 开始播放视频的Promise返回值。 |
+| 类型 | 说明 | |
+| -------------- | ----------------------------- | ---- |
+| Promise\<void> | 开始播放视频的Promise返回值。 | |
**示例：**
@@ -889,9 +889,9 @@ pause(): Promise\<void>
**返回值：**
-| 类型 | 说明 |
-| -------------- | ----------------------------- |
-| Promise\<void> | 暂停播放视频的Promise返回值。 |
+| 类型 | 说明 | |
+| -------------- | ----------------------------- | ---- |
+| Promise\<void> | 暂停播放视频的Promise返回值。 | |
**示例：**
@@ -939,9 +939,9 @@ stop(): Promise\<void>
**返回值：**
-| 类型 | 说明 |
-| -------------- | ----------------------------- |
-| Promise\<void> | 停止播放视频的Promise返回值。 |
+| 类型 | 说明 | |
+| -------------- | ----------------------------- | ---- |
+| Promise\<void> | 停止播放视频的Promise返回值。 | |
**示例：**
@@ -989,9 +989,9 @@ reset(): Promise\<void>
**返回值：**
-| 类型 | 说明 |
-| -------------- | ----------------------------- |
-| Promise\<void> | 切换播放视频的Promise返回值。 |
+| 类型 | 说明 | |
+| -------------- | ----------------------------- | ---- |
+| Promise\<void> | 切换播放视频的Promise返回值。 | |
**示例：**
@@ -1078,9 +1078,9 @@ seek(timeMs: number, mode?:SeekMode): Promise\<number>
**返回值：**
-| 类型 | 说明 |
-| -------------- | ----------------------------------- |
-| Promise\<void> | 跳转到指定播放位置的Promise返回值。 |
+| 类型 | 说明 |
+| ---------------- | ----------------------------------------------------- |
+| Promise\<number> | 指定的播放时间节点，单位ms，取值范围为[0, duration]。 |
**示例：**
@@ -1136,18 +1136,18 @@ setVolume(vol: number): Promise\<void>
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
+**返回值：**
+
+| 类型 | 说明 | |
+| -------------- | ------------------------- | ---- |
+| Promise\<void> | 设置音量的Promise返回值。 | |
+
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| vol | number | 是 | 指定的相对音量大小，取值范围为[0.00-1.00]，1表示最大音量，即100%。 |
-**返回值：**
-
-| 类型 | 说明 |
-| -------------- | ------------------------- |
-| Promise\<void> | 设置音量的Promise返回值。 |
-
**示例：**
```js
@@ -1195,9 +1195,9 @@ release(): Promise\<void>
**返回值：**
-| 类型 | 说明 |
-| -------------- | ----------------------------- |
-| Promise\<void> | 释放视频资源的Promise返回值。 |
+| 类型 | 说明 | |
+| -------------- | ----------------------------- | ---- |
+| Promise\<void> | 释放视频资源的Promise返回值。 | |
**示例：**
@@ -1255,9 +1255,9 @@ getTrackDescription(): Promise<Array\<MediaDescription>>
**返回值：**
-| 类型 | 说明 |
-| ------------------------------------------------------ | ------------------------------- |
-| Promise<Array<[MediaDescription](#mediadescription8)>> | 获取视频轨道信息Promise返回值。 |
+| 类型 | 说明 |
+| ------------------------------------------------------ | ---------------------------------- |
+| Promise<Array<[MediaDescription](#mediadescription8)>> | 视频轨道信息MediaDescription数组。 |
**示例：**
@@ -1331,9 +1331,9 @@ setSpeed(speed:number): Promise\<number>
**返回值：**
-| 类型 | 说明 |
-| ---------------- | ------------------------- |
-| Promise\<number> | 通过Promise获取设置结果。 |
+| 类型 | 说明 |
+| ---------------- | ------------------------------------------------------ |
+| Promise\<number> | 播放视频速度，具体见[PlaybackSpeed](#playbackspeed8)。 |
**示例：**
@@ -1341,7 +1341,7 @@ setSpeed(speed:number): Promise\<number>
import media from '@ohos.multimedia.media'
let speed = media.PlaybackSpeed.SPEED_FORWARD_2_00_X;
-videoPlayer.setSpeed(speed).then(() => {
+videoPlayer.setSpeed(speed).then((result) => {
console.info('setSpeed success');
}).catch((error) => {
console.info(`video catchCallback, error:${error}`);
@@ -1388,13 +1388,13 @@ selectBitrate(bitrate:number): Promise\<number>
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | -------------------------------------------- |
-| bitrate | number | 是 | 指定码率播放，用于hls多码率场景，单位为bps。 |
+| bitrate | number | 是 | 指定播放码率，用于hls多码率场景，单位为bps。 |
**返回值：**
-| 类型 | 说明 |
-| ---------------- | ------------------------- |
-| Promise\<number> | 通过Promise获取设置结果。 |
+| 类型 | 说明 |
+| ---------------- | -------------------------------------------- |
+| Promise\<number> | 指定播放码率，设置的码率：成功，其他：失败。 |
**示例：**
@@ -1998,12 +1998,6 @@ prepare(config: VideoRecorderConfig): Promise\<void>;
| ------ | -------------------------------------------- | ---- | ------------------------ |
| config | [VideoRecorderConfig](#videorecorderconfig9) | 是 | 配置视频录制的相关参数。 |
-**返回值：**
-
-| 类型 | 说明 |
-| -------------- | ---------------------------------------- |
-| Promise\<void> | 异步视频录制prepare方法的Promise返回值。 |
-
**示例：**
```js
@@ -2084,9 +2078,9 @@ getInputSurface(): Promise\<string>;
**返回值：**
-| 类型 | 说明 |
-| ---------------- | -------------------------------- |
-| Promise\<string> | 异步获得surface的Promise返回值。 |
+| 类型 | 说明 |
+| ---------------- | ------------------- |
+| Promise\<string> | surface的id字符串。 |
**示例：**
@@ -2140,12 +2134,6 @@ start(): Promise\<void>;
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
-**返回值：**
-
-| 类型 | 说明 |
-| -------------- | ------------------------------------- |
-| Promise\<void> | 异步开始视频录制方法的Promise返回值。 |
-
**示例：**
```js
@@ -2196,12 +2184,6 @@ pause(): Promise\<void>;
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
-**返回值：**
-
-| 类型 | 说明 |
-| -------------- | ------------------------------------- |
-| Promise\<void> | 异步暂停视频录制方法的Promise返回值。 |
-
**示例：**
```js
@@ -2248,12 +2230,6 @@ resume(): Promise\<void>;
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
-**返回值：**
-
-| 类型 | 说明 |
-| -------------- | ------------------------------------- |
-| Promise\<void> | 异步恢复视频录制方法的Promise返回值。 |
-
**示例：**
```js
@@ -2304,12 +2280,6 @@ stop(): Promise\<void>;
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
-**返回值：**
-
-| 类型 | 说明 |
-| -------------- | ------------------------------------- |
-| Promise\<void> | 异步停止视频录制方法的Promise返回值。 |
-
**示例：**
```js
@@ -2356,12 +2326,6 @@ release(): Promise\<void>;
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
-**返回值：**
-
-| 类型 | 说明 |
-| -------------- | ----------------------------------------- |
-| Promise\<void> | 异步释放视频录制资源方法的Promise返回值。 |
-
**示例：**
```js
@@ -2412,12 +2376,6 @@ reset(): Promise\<void>;
**系统能力：** SystemCapability.Multimedia.Media.VideoRecorder
-**返回值：**
-
-| 类型 | 说明 |
-| -------------- | ------------------------------------- |
-| Promise\<void> | 异步重置视频录制方法的Promise返回值。 |
-
**示例：**
```js
zh-cn/application-dev/media/audio-recorder.md
浏览文件 @ c342360b
......@@ -18,7 +18,7 @@
![zh-ch_image_audio_recorder_zero](figures/zh-ch_image_audio_recorder_zero.png)
**说明**：三方录音应用或录音机通过调用JS接口层提供的js接口实现相应功能时，框架层会通过Native Framework的媒体服务，调用音频部件将软件编码后的音频数据输出至硬件接口层的音频HDI，实现音频录制功能。
**说明**：三方录音应用或录音机通过调用JS接口层提供的js接口实现相应功能时，框架层会通过Native Framework的媒体服务，调用音频部件获取通过音频HDI捕获的音频数据，再通过软件编码输出编码封装后的音频数据保存至文件中，实现音频录制功能。
## 约束与限制
......@@ -30,7 +30,7 @@
### 全流程场景
音频录制的全流程场景包含：创建实例，设置录制参数，录制音频，暂停录制，恢复录制，停止录制，释放资源等流程。
音频录制的全流程场景包含：创建实例，设置录制参数，开始录制，暂停录制，恢复录制，停止录制，释放资源等流程。
```js
import media from '@ohos.multimedia.media'
......
zh-cn/application-dev/media/video-playback.md
浏览文件 @ c342360b
......@@ -16,7 +16,7 @@
![zh-ch_image_video_player](figures/zh-ch_image_video_player.png)
**说明**：三方应用通过调用JS接口层提供的js接口实现相应功能时，框架层会通过Native Framework的媒体服务，调用音频部件将软件编码后的音频数据，输出至音频HDI，和图形子系统将硬件接口层的解码HDI部件的解码后的图像数据，输出至显示HDI，实现视频播放功能。
**说明**：三方应用通过调用JS接口层提供的js接口实现相应功能时，框架层会通过Native Framework的媒体服务，调用音频部件将软件解码后的音频数据，输出至音频HDI，和图形子系统将硬件接口层的解码HDI部件的解码后的图像数据，输出至显示HDI，实现视频播放功能。
*注意：视频播放需要显示、音频、编解码等硬件能力。*
......
zh-cn/application-dev/media/video-recorder.md
浏览文件 @ c342360b
......@@ -2,7 +2,7 @@
## 简介
视频录制的主要工作是捕获音视频信号，完成音视频编码并保存到文件中，帮助开发者轻松实现音视频录制功能，包括录制视频、暂停录制、恢复录制、停止录制、释放资源等功能控制。它允许调用者指定录制的编码格式、封装格式、文件路径等参数。
视频录制的主要工作是捕获音视频信号，完成音视频编码并保存到文件中，帮助开发者轻松实现音视频录制功能，包括开始录制、暂停录制、恢复录制、停止录制、释放资源等功能控制。它允许调用者指定录制的编码格式、封装格式、文件路径等参数。
## 运作机制
......@@ -16,7 +16,7 @@
![zh-ch_image_video_recorder_zero](figures/zh-ch_image_video_recorder_zero.png)
**说明**：三方相机应用或系统相机通过调用JS接口层提供的js接口实现相应功能时，框架层会通过Native Framework的媒体服务，调用音频部件将软件编码后的音频数据，输出至音频HDI，和图形子系统将硬件接口层的视频编码HDI部件的编码后的图像数据，输出至视频HDI，实现视频录制功能。
**说明**：三方相机应用或系统相机通过调用JS接口层提供的js接口实现相应功能时，框架层会通过Native Framework的媒体服务，调用音频部件通过音频HDI捕获的音频数据，再通过软件编码输出编码封装后的音频数据保存至文件中，和图形子系统通过视频HDI捕获的图像数据，再通过视频编码HDI编码，将编码后的图像数据保存至文件中，实现视频录制功能。
## 约束与限制
......@@ -28,7 +28,7 @@
### 全流程场景
视频录制全流程场景包含：创建实例、设置录制参数、录制视频、暂停录制、恢复录制、停止录制、释放资源等流程。
视频录制全流程场景包含：创建实例、设置录制参数、开始录制、暂停录制、恢复录制、停止录制、释放资源等流程。
```js
import media from '@ohos.multimedia.media'
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或