From 2c51f2cc3a3d86b60eab15ee4019eaa2503414e8 Mon Sep 17 00:00:00 2001 From: lixiangpeng5 Date: Wed, 14 Jun 2023 07:21:59 +0000 Subject: [PATCH] fix page of guideline Signed-off-by: lixiangpeng5 Change-Id: I67eae9b9a1472ad45830b939c6547a2c805aaaa1 --- .../device/vibrator-guidelines.md | 39 ++++++++++++------- .../reference/apis/js-apis-vibrator.md | 2 +- 2 files changed, 26 insertions(+), 15 deletions(-) diff --git a/zh-cn/application-dev/device/vibrator-guidelines.md b/zh-cn/application-dev/device/vibrator-guidelines.md index f4cadfd273..8644041a65 100644 --- a/zh-cn/application-dev/device/vibrator-guidelines.md +++ b/zh-cn/application-dev/device/vibrator-guidelines.md @@ -28,7 +28,7 @@ 自定义振动配置文件为Json格式，在形式上如下所示： -```js +```json { "MetaData": { "Create": "2023-01-09", @@ -69,9 +69,15 @@ } ``` -Json文件共包含2个属性。"MetaData"为文件头信息，可在相应属性中添加描述，其中包含必填项："Version"表示文件格式的版本号，向前兼容，目前起步仅支持版本1.0；"ChannelNumber"表示马达振动的通道数，目前仅支持单通道，规定为1；其他为选填项："Create"可记录文件创作时间；"Description"可指明振动效果、创建信息等附加说明。"Channels"为马达振动通道的相关信息。 +Json文件共包含2个属性。 +- "MetaData"属性中为文件头信息，可在如下属性中添加描述。
+"Version"：必填项，文件格式的版本号，向前兼容，目前起步仅支持版本1.0；
+"ChannelNumber"：必填项，表示马达振动的通道数，目前仅支持单通道，规定为1；
+"Create"：可选项，可记录文件创作时间；
+"Description"：可选项，可指明振动效果、创建信息等附加说明。
+- "Channels"属性中为马达振动通道的相关信息。
-```js +```json { "MetaData": { "Create": "2023-01-09", @@ -79,26 +85,31 @@ Json文件共包含2个属性。"MetaData"为文件头信息，可在相应属 "Version": 1.0, "ChannelNumber": 1 }, - "Channels": [ ... ] + "Channels": [ ] } ``` -"Channels"是Json数组，表示各个通道的信息，包含两个属性。"Parameters"为通道参数，其中，"Index"为通道编号，单通道下规定为1，其他参数待后续扩展。"Pattern"为马达振动序列，为Json数组。 +"Channels"是Json数组，表示各个通道的信息，包含两个属性。 +- "Parameters"属性中为通道参数。
+"Index"：必填项，表示通道编号，单通道下规定为1。
+- "Pattern"属性中为马达振动序列，为Json数组。
-```js +```json "Channels": [ { "Parameters": { "Index": 1 }, - "Pattern": [ ... ] + "Pattern": [ ] } ] ``` -"Pattern"中每个"Event"属性代表1个振动事件，支持添加2种振动类型。类型1："transient"类型，瞬态短振动，干脆有力；类型2："continuous"类型，稳态长振动，具备长时间输出强劲有力振动的能力。 +"Pattern"中每个"Event"属性代表1个振动事件，支持添加2种振动类型。 +- 类型1："transient"类型，瞬态短振动，干脆有力；
+- 类型2："continuous"类型，稳态长振动，具备长时间输出强劲有力振动的能力。
-```js +```json "Pattern": [ { "Event": { @@ -128,11 +139,11 @@ Json文件共包含2个属性。"MetaData"为文件头信息，可在相应属 | 参数 | 说明 | 范围| | --- | ------------------------ | ---| -| Type | 振动事件类型 | "transient" 或"continuous"| -| StartTime | 振动的起始时间 | 单位ms，有效范围为[0, 1800 000]，振动事件不能重叠| -| Duration | 振动持续时间，仅当类型为"continuous"时可用 | 单位ms，有效范围为(10, 1600)| -| Intensity | 振动强度 | 有效范围为[0, 100]，这里的强度值为相对值，并不代表真实强度| -| Frequency | 振动频率 | 有效范围为[0, 100]，这里的频率值为相对值，并不代表真实频率| +| Type | 振动事件类型，必填 | "transient" 或"continuous"| +| StartTime | 振动的起始时间，必填 | 单位ms，有效范围为[0, 1800 000]，振动事件不能重叠| +| Duration | 振动持续时间，仅当类型为"continuous"时有效 | 单位ms，有效范围为(10, 1600)| +| Intensity | 振动强度，必填 | 有效范围为[0, 100]，这里的强度值为相对值，并不代表真实强度| +| Frequency | 振动频率，必填 | 有效范围为[0, 100]，这里的频率值为相对值，并不代表真实频率| 其他要求： diff --git a/zh-cn/application-dev/reference/apis/js-apis-vibrator.md b/zh-cn/application-dev/reference/apis/js-apis-vibrator.md index 327b0f56a8..7f64ab88d1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-vibrator.md +++ b/zh-cn/application-dev/reference/apis/js-apis-vibrator.md @@ -500,7 +500,7 @@ try { ## HapticFileDescriptor10+ -自定义振动配置文件的描述符，必须确认资源文件可用，可通过[文件管理API](js-apis-file-fs.md#fsopen)从沙箱路径获取或者通过[资源管理API](js-apis-resource-manager.md#getrawfd9)从HAP资源获取。使用场景：振动序列被存储在一个文件中，需要根据偏移量和长度进行振动，振动序列存储格式，请参考[自定义振动格式](../../device/vibrator-guidelines.md#自定义振动格式)。 +自定义振动配置文件的描述符，必须确认资源文件可用，其参数可通过[文件管理API](js-apis-file-fs.md#fsopen)从沙箱路径获取或者通过[资源管理API](js-apis-resource-manager.md#getrawfd9)从HAP资源获取。使用场景：振动序列被存储在一个文件中，需要根据偏移量和长度进行振动，振动序列存储格式，请参考[自定义振动格式](../../device/vibrator-guidelines.md#自定义振动格式)。 **系统能力**：SystemCapability.Sensors.MiscDevice -- GitLab