From 0518ec849b590d549b753b9b2c6e72cf2b2e95b5 Mon Sep 17 00:00:00 2001 From: zengyawen Date: Thu, 24 Mar 2022 20:42:47 +0800 Subject: [PATCH] update docs Signed-off-by: zengyawen --- .../reference/apis/js-apis-camera.md | 72 +++++++++---------- .../apis/js-apis-distributed-data.md | 4 +- .../reference/apis/js-apis-huks.md | 2 +- .../reference/apis/js-apis-media.md | 56 +++++++-------- 4 files changed, 67 insertions(+), 67 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-camera.md b/zh-cn/application-dev/reference/apis/js-apis-camera.md index 2b1893eb50..b985e17724 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-camera.md +++ b/zh-cn/application-dev/reference/apis/js-apis-camera.md @@ -240,11 +240,11 @@ createCameraInput(position: CameraPosition, type: CameraType, callback: AsyncCal **参数：** -| 名称 | 类型 | 必填 | 说明 | -| -------------- | ------------------------------------------- | ---- | ----------------------------------- | -| cameraPosition | [CameraPosition](#cameraposition) | 是 | 相机位置。 | -| cameraType | [CameraType](#cameratype) | 是 | 相机类型。 | -| callback | AsyncCallback<[CameraInput](#camerainput)\> | 是 | 回调函数，用于获取CameraInput实例。 | +| 名称 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------- | ---- | ----------------------------------- | +| position | [CameraPosition](#cameraposition) | 是 | 相机位置。 | +| type | [CameraType](#cameratype) | 是 | 相机类型。 | +| callback | AsyncCallback<[CameraInput](#camerainput)\> | 是 | 回调函数，用于获取CameraInput实例。 | **示例：** @@ -268,10 +268,10 @@ createCameraInput(position: CameraPosition, type: CameraType): Promise): void **参数：** -| 名称 | 类型 | 必填 | 说明 | -| :------- | :---------------------------------------------------- | :--- | :----------------------------------- | -| type | string | 是 | 监听事件。 | -| callback | AsyncCallback<[CameraStatusInfo](#camerastatusinfo)\> | 是 | 回调函数，用于获取相机状态变化信息。 | +| 名称 | 类型 | 必填 | 说明 | +| :------- | :---------------------------------------------------- | :--- | :--------------------------------------------------- | +| type | string | 是 | 监听事件，固定为'cameraStatus'，即相机状态变化事件。 | +| callback | AsyncCallback<[CameraStatusInfo](#camerastatusinfo)\> | 是 | 回调函数，用于获取相机状态变化信息。 | **示例：** @@ -1014,10 +1014,10 @@ on(type: 'error', callback: ErrorCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | -| :------- | :------------------------------- | :--- | :------------------------ | -| type | string | 是 | 监听事件，固定为'error'。 | -| callback | ErrorCallback | 是 | 回调函数，用于获取结果。 | +| 名称 | 类型 | 必填 | 说明 | +| :------- | :------------------------------- | :--- | :---------------------------------------------- | +| type | string | 是 | 监听事件，固定为'error'，即CamerInput错误事件。 | +| callback | ErrorCallback | 是 | 回调函数，用于获取结果。 | **示例：** @@ -1823,10 +1823,10 @@ on(type: 'error', callback: ErrorCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | -| :------- | :---------------------------------- | :--- | :--------------------------- | -| type | string | 是 | 监听事件，固定为'error'。 | -| callback | ErrorCallback | 是 | 回调函数，用于获取错误信息。 | +| 名称 | 类型 | 必填 | 说明 | +| :------- | :---------------------------------- | :--- | :-------------------------------------------- | +| type | string | 是 | 监听事件，固定为'error'，即拍照会话错误事件。 | +| callback | ErrorCallback | 是 | 回调函数，用于获取错误信息。 | **示例：** @@ -2000,10 +2000,10 @@ on(type: 'error', callback: ErrorCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | -| :------- | :--------------------------------- | :--- | :--------------------------- | -| type | string | 是 | 监听事件，固定为'error'。 | -| callback | ErrorCallback | 是 | 回调函数，用于获取错误信息。 | +| 名称 | 类型 | 必填 | 说明 | +| :------- | :--------------------------------- | :--- | :-------------------------------------------- | +| type | string | 是 | 监听事件，固定为'error'，即预览输出错误事件。 | +| callback | ErrorCallback | 是 | 回调函数，用于获取错误信息。 | **示例：** @@ -2323,10 +2323,10 @@ on(type: 'error', callback: ErrorCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | -| :------- | :------------------------------- | :--- | :--------------------------- | -| type | string | 是 | 监听事件，固定为'error'。 | -| callback | ErrorCallback | 是 | 回调函数，用于获取错误信息。 | +| 名称 | 类型 | 必填 | 说明 | +| :------- | :------------------------------- | :--- | :---------------------------------------- | +| type | string | 是 | 监听事件，固定为'error'，即拍照错误事件。 | +| callback | ErrorCallback | 是 | 回调函数，用于获取错误信息。 | **示例：** @@ -2379,9 +2379,9 @@ createVideoOutput(surfaceId: string): Promise **返回值：** -| 类型 | 说明 | -| --------------------- | -------------------------------------- | -| Promise | 使用Promise的方式获取VideoOutput实例。 | +| 类型 | 说明 | +| ------------------------------------- | -------------------------------------- | +| Promise<[VideoOutput](#videooutput)\> | 使用Promise的方式获取VideoOutput实例。 | **示例：** @@ -2597,10 +2597,10 @@ on(type: 'error', callback: ErrorCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | -| :------- | :-------------------------- | :--- | :--------------------------- | -| type | string | 是 | 监听事件，固定为'error'。 | -| callback | Callback | 是 | 回调函数，用于获取错误信息。 | +| 名称 | 类型 | 必填 | 说明 | +| :------- | :-------------------------- | :--- | :-------------------------------------------- | +| type | string | 是 | 监听事件，固定为'error'，即视频输出错误事件。 | +| callback | Callback | 是 | 回调函数，用于获取错误信息。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md index 5329495bc7..b6d4e0390b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md @@ -779,8 +779,8 @@ getPosition(): number }).catch((err) => { console.log('getResultSet fail ' + err); }); - const positon = resultSet.getPosition(); - console.log("getPosition " + positon); + const position = resultSet.getPosition(); + console.log("getPosition " + position); } catch (e) { console.log("GetPosition fail " + e); } diff --git a/zh-cn/application-dev/reference/apis/js-apis-huks.md b/zh-cn/application-dev/reference/apis/js-apis-huks.md index 2b81cdd093..8eb5c87bdb 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-huks.md +++ b/zh-cn/application-dev/reference/apis/js-apis-huks.md @@ -20,7 +20,7 @@ import huks from '@ohos.security.huks' | 名称 | 值 | 说明 | | -------------------------- | ----- | ---- | -| HUKS_SUCCESS | 0 |表示成功。表示当前设备连接的充电器类型。| +| HUKS_SUCCESS | 0 |表示成功。| | HUKS_FAILURE | -1 |表示失败。| | HUKS_ERROR_BAD_STATE | -2 |表示错误的状态。| | HUKS_ERROR_INVALID_ARGUMENT | -3 |表示无效的数据。| 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 1b41aab576..4b41804aaf 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-media.md +++ b/zh-cn/application-dev/reference/apis/js-apis-media.md @@ -250,13 +250,13 @@ Codec MIME类型枚举。 | MD_KEY_TRACK_INDEX | "track_index" | 表示轨道序号，其对应键值类型为number。 | | MD_KEY_TRACK_TYPE | "track_type" | 表示轨道类型，其对应键值类型为number，参考[MediaType](#mediatype8)。 | | MD_KEY_CODEC_MIME | "codec_mime" | 表示codec_mime类型，其对应键值类型为string。 | -| MD_KEY_DURATION | "duration" | 表示媒体时长，其对应键值类型为number，单位为ms。 | -| MD_KEY_BITRATE | "bitrate" | 表示比特率，其对应键值类型为number，单位为bps。 | -| MD_KEY_WIDTH | "width" | 表示视频宽度，其对应键值类型为number，单位为像素。 | -| MD_KEY_HEIGHT | "height" | 表示视频高度，其对应键值类型为number，单位为像素。 | -| MD_KEY_FRAME_RATE | "frame_rate" | 表示视频帧率，其对应键值类型为number，单位为100fps。 | +| MD_KEY_DURATION | "duration" | 表示媒体时长，其对应键值类型为number，单位为毫秒（ms）。 | +| MD_KEY_BITRATE | "bitrate" | 表示比特率，其对应键值类型为number，单位为比特率（bps）。 | +| MD_KEY_WIDTH | "width" | 表示视频宽度，其对应键值类型为number，单位为像素（px）。 | +| MD_KEY_HEIGHT | "height" | 表示视频高度，其对应键值类型为number，单位为像素（px）。 | +| MD_KEY_FRAME_RATE | "frame_rate" | 表示视频帧率，其对应键值类型为number，单位为100帧每秒（100fps）。 | | MD_KEY_AUD_CHANNEL_COUNT | "channel_count" | 表示声道数，其对应键值类型为number。 | -| MD_KEY_AUD_SAMPLE_RATE | "sample_rate" | 表示采样率，其对应键值类型为number，单位为HZ。 | +| MD_KEY_AUD_SAMPLE_RATE | "sample_rate" | 表示采样率，其对应键值类型为number，单位为赫兹（Hz）。 | ## BufferingInfoType8+ @@ -264,12 +264,12 @@ Codec MIME类型枚举。 **系统能力：** 以下各项对应的系统能力均为 SystemCapability.Multimedia.Media.Core。 -| 名称 | 值 | 说明 | -| ----------------- | ---- | -------------------------- | -| BUFFERING_START | 1 | 表示开始缓存。 | -| BUFFERING_END | 2 | 表示结束缓存。 | -| BUFFERING_PERCENT | 3 | 表示缓存百分比。 | -| CACHED_DURATION | 4 | 表示缓存时长，单位为毫秒。 | +| 名称 | 值 | 说明 | +| ----------------- | ---- | -------------------------------- | +| BUFFERING_START | 1 | 表示开始缓存。 | +| BUFFERING_END | 2 | 表示结束缓存。 | +| BUFFERING_PERCENT | 3 | 表示缓存百分比。 | +| CACHED_DURATION | 4 | 表示缓存时长，单位为毫秒（ms）。 | ## AudioPlayer @@ -367,9 +367,9 @@ seek(timeMs: number): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------------------------------ | -| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------ | +| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms）。 | **示例：** @@ -1026,10 +1026,10 @@ seek(timeMs: number, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | ---- | ------------------------------ | -| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒。 | -| callback | function | 是 | 跳转到指定播放位置的回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | ---- | ------------------------------------ | +| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms）。 | +| callback | function | 是 | 跳转到指定播放位置的回调方法。 | **示例：** @@ -1053,11 +1053,11 @@ seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\): void **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------- | ---- | ------------------------------ | -| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒。 | -| mode | [SeekMode](#seekmode8) | 是 | 跳转模式。 | -| callback | function | 是 | 跳转到指定播放位置的回调方法。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ------------------------------------ | +| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms）。 | +| mode | [SeekMode](#seekmode8) | 是 | 跳转模式。 | +| callback | function | 是 | 跳转到指定播放位置的回调方法。 | **示例：** @@ -1081,10 +1081,10 @@ seek(timeMs: number, mode?:SeekMode): Promise\ **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------------------- | ---- | ------------------------------ | -| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒。 | -| mode | [SeekMode](#seekmode8) | 否 | 跳转模式。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------------------- | ---- | ------------------------------------ | +| timeMs | number | 是 | 指定的跳转时间节点，单位毫秒（ms）。 | +| mode | [SeekMode](#seekmode8) | 否 | 跳转模式。 | **返回值：** -- GitLab