Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 664ff94d 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!10218 马达新增两个接口的资料修改 

Merge pull request !10218 from 白露/master
上级 f443fff4 a11cdc51
显示空白变更内容
内联 并排
Showing with 273 addition and 179 deletion
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
浏览文件 @ 664ff94d
......@@ -13,11 +13,11 @@ vibrator模块提供控制马达振动的能力，如通过接口控制马达启
import vibrator from '@ohos.vibrator';
```
## vibrator.vibrate
## vibrator.startVibration<sup>9+</sup>
vibrate(duration: number): Promise&lt;void&gt;
startVibration(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallback&lt;void&gt;): void
按照指定持续时间触发马达振动。
按照指定振动效果和振动属性触发马达振动。
**需要权限**：ohos.permission.VIBRATE
......@@ -26,28 +26,36 @@ vibrate(duration: number): Promise&lt;void&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------- |
| duration | number | 是 | 马达振动时长, 单位ms。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
| --------- | -------------------------------------- | ---- | :--------------------------------------------------------- |
| effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 |
| attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
**示例：**
示例：
```js
vibrator.vibrate(1000).then(()=>{
console.log("Promise returned to indicate a successful vibration.");
```js
try {
vibrator.startVibration({
type:'time',
duration:1000,
},{
id:0,
usage: 'alarm'
}, (error)=>{
console.log("error.code"+error.code+"error.message"+error.message);
if(error){
console.log('vibrate fail, error.code: ' + error.code + 'error.message: ', + error.message);
}else{
console.log('Callback returned to indicate a successful vibration.');
}
});
```
} catch(err) {
console.info('errCode: ' + err.code + ' ,msg: ' + err.message);
}
```
## vibrator.vibrate<sup>9+</sup>
## vibrator.startVibration<sup>9+</sup>
vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt;
startVibration(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt;
按照指定振动效果和振动属性触发马达振动。
......@@ -58,7 +66,7 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- | :------------- |
| --------- | -------------------------------------- | ---- | -------------- |
| effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 |
| attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 |
......@@ -70,112 +78,219 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt;
**示例：**
```js
vibrator.vibrate({
```js
try {
vibrator.startVibration({
type: 'time',
duration: 1000
}, {
}, {
id: 0,
usage: 'alarm'
}).then(()=>{
console.log("Promise returned to indicate a successful vibration");
}).catch((error)=>{
console.log("error.code" + error.code + "error.message" + error.message);
})
```
}).then(()=>{
console.log('Promise returned to indicate a successful vibration');
}).catch((error)=>{
console.log('error.code' + error.code + 'error.message' + error.message);
})
} catch(err) {
console.info('errCode: ' + err.code + ' ,msg: ' + err.message);
}
```
## vibrator.vibrate
## vibrator.stopVibration<sup>9+</sup>
vibrate(duration: number, callback?: AsyncCallback&lt;void&gt;): void
stopVibration(stopMode: VibratorStopMode, callback: AsyncCallback&lt;void&gt;): void
按照指定持续时间触发马达振动。
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| duration | number | 是 | 马达振动时长, 单位ms。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当马达停止振动成功，err为undefined，否则为错误对象。 |
**示例：**
```js
vibrator.vibrate(1000,function(error){
try {
vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function(error){
if(error){
console.log("error.code" + error.code + "error.message" + error.message);
console.log('error.code' + error.code + 'error.message' + error.message);
}else{
console.log("Callback returned to indicate a successful vibration.");
console.log('Callback returned to indicate successful.');
}
})
} catch(err) {
console.info('errCode: ' + err.code + ' ,msg: ' + err.message);
}
```
## vibrator.stopVibration<sup>9+</sup>
## vibrator.vibrate
vibrate(effectId: EffectId): Promise&lt;void&gt;
stopVibration(stopMode: VibratorStopMode): Promise&lt;void&gt;
按照预置振动效果触发马达振动。
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------ |
| effectId | [EffectId](#effectid) | 是 | 预置的振动效果ID。 |
| -------- | ------------------------------------- | ---- | ------------------------ |
| stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**示例：**
```js
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(()=>{
console.log("Promise returned to indicate a successful vibration.");
try {
vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{
console.log('Promise returned to indicate a successful vibration.');
}, (error)=>{
console.log("error.code" + error.code + "error.message" + error.message);
console.log('error.code' + error.code + 'error.message' + error.message);
});
} catch(err) {
console.info('errCode: ' + err.code + ' ,msg: ' + err.message);
}
```
## EffectId
## vibrator.vibrate
马达振动效果的字符串。
vibrate(effectId: EffectId, callback?: AsyncCallback&lt;void&gt;): void
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
按照指定振动效果触发马达振动。
| 名称 | 默认值 | 说明 |
| ------------------ | -------------------- | ------------------ |
| EFFECT_CLOCK_TIMER | "haptic.clock.timer" | 预置的振动效果ID。 |
## VibratorStopMode
马达要停止指定的振动模式。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 默认值 | 说明 |
| ------------------------- | -------- | ------------------------------------------------------------ |
| VIBRATOR_STOP_MODE_TIME | "time" | 停止模式为duration模式的振动。即触发振动时参数类型为number，参数本身为振动持续时间的触发方式。 |
| VIBRATOR_STOP_MODE_PRESET | "preset" | 停止模式为预置EffectId的振动。即触发振动时参数类型为EffectId，参数本身为马达振动效果的字符串的触发方式。 |
## VibrateEffect<sup>9+</sup>
马达振动效果。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 类型 | 说明 |
| -------------------------------- | ------------------------------ |
| [VibrateTime](#vibratetime9) | 按照指定持续时间触发马达振动。 |
| [VibratePreset](#vibratepreset9) | 按照预置振动类型触发马达振动。 |
## VibrateTime<sup>9+</sup>
马达振动时长。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 默认值 | 说明 |
| -------- | ------ | ------------------------------ |
| type | "time" | 按照指定持续时间触发马达振动。 |
| duration | - | 马达振动时长, 单位ms。 |
## VibratePreset<sup>9+</sup>
马达预置振动类型。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 默认值 | 说明 |
| -------- | -------- | ------------------------------ |
| type | "preset" | 按照预置振动效果触发马达振动。 |
| effectId | - | 预置的振动效果ID。 |
| count | - | 重复振动的次数。 |
## VibrateAttribute<sup>9+</sup>
马达振动属性。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 默认值 | 说明 |
| ----- | ------ | -------------- |
| id | 0 | 振动器id。 |
| usage | - | 马达振动场景。 |
## Usage<sup>9+</sup>
振动使用场景。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 类型 | 说明 |
| ---------------- | ------ | ------------------------------ |
| unknown | string | 没有明确使用场景，最低优先级。 |
| alarm | string | 用于警报振动的场景。 |
| ring | string | 用于铃声振动的场景。 |
| notification | string | 用于通知振动的场景。 |
| communication | string | 用于通信振动的场景。 |
| touch | string | 用于触摸振动的场景。 |
| media | string | 用于多媒体振动的场景。 |
| physicalFeedback | string | 用于物理反馈振动的场景。 |
| simulateReality | string | 用于模拟现实振动的场景。 |
## vibrator.vibrate<sup>(deprecated)</sup>
vibrate(duration: number): Promise&lt;void&gt;
按照指定持续时间触发马达振动。
从API version 9 开始不再维护，建议使用 [vibrator.startVibration](#vibratorstartvibration9-1) 代替。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| effectId | [EffectId](#effectid) | 是 | 预置的振动效果ID。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
| -------- | ------ | ---- | ---------------------- |
| duration | number | 是 | 马达振动时长, 单位ms。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**示例：**
```js
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){
if(error){
console.log("error.code" + error.code + "error.message" + error.message);
}else{
console.log("Callback returned to indicate a successful vibration.");
}
})
vibrator.vibrate(1000).then(()=>{
console.log('Promise returned to indicate a successful vibration.');
}, (error)=>{
console.log('error.code' + error.code + 'error.message' + error.message);
});
```
## vibrator.vibrate<sup>9+</sup>
## vibrator.vibrate<sup>(deprecated)</sup>
vibrate(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallback&lt;void&gt;): void
vibrate(duration: number, callback?: AsyncCallback&lt;void&gt;): void
按照指定振动效果和振动属性触发马达振动。
按照指定持续时间触发马达振动。
从API version 9 开始不再维护，建议使用 [vibrator.startVibration](#vibratorstartvibration9) 代替。
**需要权限**：ohos.permission.VIBRATE
......@@ -184,43 +299,40 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallb
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- | :--------------------------------------------------------- |
| effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 |
| attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| duration | number | 是 | 马达振动时长, 单位ms。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
示例：
**示例：**
```js
vibrator.vibrate({
type:'time',
duration:1000,
},{
id:0,
usage: 'alarm'
}, (error)=>{
```js
vibrator.vibrate(1000,function(error){
if(error){
console.log("vibrate fail, error.code:" + error.code + ",error.message:" + error.message);
console.log('error.code' + error.code + 'error.message' + error.message);
}else{
console.log("Callback returned to indicate a successful vibration.");
console.log('Callback returned to indicate a successful vibration.');
}
});
```
})
```
## vibrator.stop
stop(stopMode: VibratorStopMode): Promise&lt;void&gt;
## vibrator.vibrate<sup>(deprecated)</sup>
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
vibrate(effectId: EffectId): Promise&lt;void&gt;
按照预置振动效果触发马达振动。
从API version 9 开始不再维护，建议使用 [vibrator.startVibration](#vibratorstartvibration9-1) 代替。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------ |
| stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
| -------- | --------------------- | ---- | ------------------ |
| effectId | [EffectId](#effectid) | 是 | 预置的振动效果ID。 |
**返回值：**
......@@ -231,125 +343,107 @@ stop(stopMode: VibratorStopMode): Promise&lt;void&gt;
**示例：**
```js
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{
console.log("Promise returned to indicate a successful vibration.");
}, (error)=>{
console.log("error.code" + error.code + "error.message" + error.message);
});
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(()=>{
console.log('Promise returned to indicate a successful vibration.');
}, (error)=>{
console.log('error.code' + error.code + 'error.message' + error.message);
});
```
## vibrator.stop
## vibrator.vibrate<sup>(deprecated)</sup>
stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void;
vibrate(effectId: EffectId, callback?: AsyncCallback&lt;void&gt;): void
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
按照指定振动效果触发马达振动。
从API version 9 开始不再维护，建议使用 [vibrator.startVibration](#vibratorstartvibration9) 代替。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达停止振动成功，err为undefined，否则为错误对象。 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| effectId | [EffectId](#effectid) | 是 | 预置的振动效果ID。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
**示例：**
```js
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function(error){
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){
if(error){
console.log("error.code" + error.code + "error.message" + error.message);
console.log('error.code' + error.code + 'error.message' + error.message);
}else{
console.log("Callback returned to indicate successful.");
console.log('Callback returned to indicate a successful vibration.');
}
})
})
```
## vibrator.stop<sup>(deprecated)</sup>
## EffectId
马达振动效果的字符串。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 默认值 | 说明 |
| ------------------ | -------------------- | ------------------ |
| EFFECT_CLOCK_TIMER | "haptic.clock.timer" | 预置的振动效果ID。 |
stop(stopMode: VibratorStopMode): Promise&lt;void&gt;
## VibratorStopMode
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
马达要停止指定的振动模式。
从API version 9 开始不再维护，建议使用 [vibrator.stopVibration](#vibratorstopvibration9-1) 代替。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
**需要权限**：ohos.permission.VIBRATE
| 名称 | 默认值 | 说明 |
| ------------------------- | -------- | ------------------------------------------------------------ |
| VIBRATOR_STOP_MODE_TIME | "time" | 停止模式为duration模式的振动。即触发振动时参数类型为number，参数本身为振动持续时间的触发方式。 |
| VIBRATOR_STOP_MODE_PRESET | "preset" | 停止模式为预置EffectId的振动。即触发振动时参数类型为EffectId，参数本身为马达振动效果的字符串的触发方式。 |
**系统能力**：SystemCapability.Sensors.MiscDevice
## VibrateEffect<sup>9+</sup>
**参数：**
马达振动效果。
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------ |
| stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
**返回值：**
| 类型 | 说明 |
| -------------------------------- | ------------------------------ |
| [VibrateTime](#vibratetime9) | 按照指定持续时间触发马达振动。 |
| [VibratePreset](#vibratepreset9) | 按照预置振动类型触发马达振动。 |
## VibrateTime<sup>9+</sup>
马达振动时长。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 默认值 | 说明 |
| -------- | ------ | ------------------------------ |
| type | "time" | 按照指定持续时间触发马达振动。 |
| duration | - | 马达振动时长, 单位ms。 |
| ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
## VibratePreset<sup>9+</sup>
**示例：**
马达预置振动类型。
```js
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{
console.log('Promise returned to indicate a successful vibration.');
}, (error)=>{
console.log('error.code' + error.code + 'error.message' + error.message);
});
```
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 名称 | 默认值 | 说明 |
| -------- | -------- | ------------------------------ |
| type | "preset" | 按照预置振动效果触发马达振动。 |
| effectId | - | 预置的振动效果ID。 |
| count | - | 重复振动的次数。 |
## vibrator.stop<sup>(deprecated)</sup>
## VibrateAttribute<sup>9+</sup>
stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void
马达振动属性。
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
从API version 9 开始不再维护，建议使用 [vibrator.stopVibration](#vibratorstopvibration9) 代替。
| 名称 | 默认值 | 说明 |
| ----- | ------ | -------------- |
| id | 0 | 振动器id。 |
| usage | - | 马达振动场景。 |
**需要权限**：ohos.permission.VIBRATE
## Usage<sup>9+</sup>
**系统能力**：SystemCapability.Sensors.MiscDevice
振动使用场景。
**参数：**
**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.MiscDevice
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达停止振动成功，err为undefined，否则为错误对象。 |
| 名称 | 类型 | 说明 |
| ---------------- | ------ | ------------------------------ |
| unknown | string | 没有明确使用场景，最低优先级。 |
| alarm | string | 用于警报振动的场景。 |
| ring | string | 用于铃声振动的场景。 |
| notification | string | 用于通知振动的场景。 |
| communication | string | 用于通信振动的场景。 |
| touch | string | 用于触摸振动的场景。 |
| media | string | 用于多媒体振动的场景。 |
| physicalFeedback | string | 用于物理反馈振动的场景。 |
| simulateReality | string | 用于模拟现实振动的场景。 |
**示例：**
```js
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function(error){
if(error){
console.log('error.code' + error.code + 'error.message' + error.message);
}else{
console.log('Callback returned to indicate successful.');
}
})
```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或