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模块提供控制马达振动的能力，如通过接口控制马达启 ...@@ -13,11 +13,11 @@ vibrator模块提供控制马达振动的能力，如通过接口控制马达启
import vibrator from '@ohos.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 **需要权限**：ohos.permission.VIBRATE
...@@ -25,29 +25,37 @@ vibrate(duration: number): Promise&lt;void&gt; ...@@ -25,29 +25,37 @@ vibrate(duration: number): Promise&lt;void&gt;
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------- | | --------- | -------------------------------------- | ---- | :--------------------------------------------------------- |
| duration | number | 是 | 马达振动时长, 单位ms。 | | effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 |
| attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 |
**返回值：** | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**示例：** 示例：
```js ```js
vibrator.vibrate(1000).then(()=>{ try {
console.log("Promise returned to indicate a successful vibration."); vibrator.startVibration({
}, (error)=>{ type:'time',
console.log("error.code"+error.code+"error.message"+error.message); duration:1000,
}); },{
``` id:0,
usage: 'alarm'
}, (error)=>{
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;
按照指定振动效果和振动属性触发马达振动。 按照指定振动效果和振动属性触发马达振动。
...@@ -55,10 +63,10 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt; ...@@ -55,10 +63,10 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt;
**系统能力**：SystemCapability.Sensors.MiscDevice **系统能力**：SystemCapability.Sensors.MiscDevice
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- | :------------- | | --------- | -------------------------------------- | ---- | -------------- |
| effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 | | effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 |
| attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 | | attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 |
...@@ -70,146 +78,60 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt; ...@@ -70,146 +78,60 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt;
**示例：** **示例：**
```js ```js
vibrator.vibrate({ try {
vibrator.startVibration({
type: 'time', type: 'time',
duration: 1000 duration: 1000
}, { }, {
id: 0, id: 0,
usage: 'alarm' usage: 'alarm'
}).then(()=>{ }).then(()=>{
console.log("Promise returned to indicate a successful vibration"); console.log('Promise returned to indicate a successful vibration');
}).catch((error)=>{ }).catch((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);
## vibrator.vibrate }
vibrate(duration: number, callback?: AsyncCallback&lt;void&gt;): void
按照指定持续时间触发马达振动。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| duration | number | 是 | 马达振动时长, 单位ms。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
**示例：**
```js
vibrator.vibrate(1000,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.stopVibration<sup>9+</sup>
## vibrator.vibrate stopVibration(stopMode: VibratorStopMode, callback: AsyncCallback&lt;void&gt;): void
vibrate(effectId: EffectId): Promise&lt;void&gt;
按照预置振动效果触发马达振动。 按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
**需要权限**：ohos.permission.VIBRATE **需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice **系统能力**：SystemCapability.Sensors.MiscDevice
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------ |
| effectId | [EffectId](#effectid) | 是 | 预置的振动效果ID。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**示例：**
```js
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.vibrate
vibrate(effectId: EffectId, callback?: AsyncCallback&lt;void&gt;): void
按照指定振动效果触发马达振动。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：** | 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- | | stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
| effectId | [EffectId](#effectid) | 是 | 预置的振动效果ID。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当马达停止振动成功，err为undefined，否则为错误对象。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
**示例：** **示例：**
```js ```js
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){ try {
if(error){ vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function(error){
console.log("error.code" + error.code + "error.message" + error.message); if(error){
}else{ console.log('error.code' + error.code + 'error.message' + error.message);
console.log("Callback returned to indicate a successful vibration."); }else{
} console.log('Callback returned to indicate successful.');
}) }
})
} catch(err) {
console.info('errCode: ' + err.code + ' ,msg: ' + err.message);
}
``` ```
## vibrator.vibrate<sup>9+</sup> ## vibrator.stopVibration<sup>9+</sup>
vibrate(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallback&lt;void&gt;): void
按照指定振动效果和振动属性触发马达振动。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- | :--------------------------------------------------------- |
| effect | [VibrateEffect](#vibrateeffect9) | 是 | 马达振动效果。 |
| attribute | [VibrateAttribute](#vibrateattribute9) | 是 | 马达振动属性。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
示例：
```js stopVibration(stopMode: VibratorStopMode): Promise&lt;void&gt;
vibrator.vibrate({
type:'time',
duration:1000,
},{
id:0,
usage: 'alarm'
}, (error)=>{
if(error){
console.log("vibrate fail, error.code:" + error.code + ",error.message:" + error.message);
}else{
console.log("Callback returned to indicate a successful vibration.");
}
});
```
## vibrator.stop
stop(stopMode: VibratorStopMode): Promise&lt;void&gt;
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。 按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
...@@ -218,6 +140,7 @@ stop(stopMode: VibratorStopMode): Promise&lt;void&gt; ...@@ -218,6 +140,7 @@ stop(stopMode: VibratorStopMode): Promise&lt;void&gt;
**系统能力**：SystemCapability.Sensors.MiscDevice **系统能力**：SystemCapability.Sensors.MiscDevice
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------ | | -------- | ------------------------------------- | ---- | ------------------------ |
| stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 | | stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
...@@ -231,43 +154,17 @@ stop(stopMode: VibratorStopMode): Promise&lt;void&gt; ...@@ -231,43 +154,17 @@ stop(stopMode: VibratorStopMode): Promise&lt;void&gt;
**示例：** **示例：**
```js ```js
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{ try {
console.log("Promise returned to indicate a successful vibration."); vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{
}, (error)=>{ console.log('Promise returned to indicate a successful vibration.');
console.log("error.code" + error.code + "error.message" + error.message); }, (error)=>{
}); console.log('error.code' + error.code + 'error.message' + error.message);
});
} catch(err) {
console.info('errCode: ' + err.code + ' ,msg: ' + err.message);
}
``` ```
## vibrator.stop
stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void;
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达停止振动成功，err为undefined，否则为错误对象。 |
**示例：**
```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.");
}
})
```
## EffectId ## EffectId
马达振动效果的字符串。 马达振动效果的字符串。
...@@ -353,3 +250,200 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void; ...@@ -353,3 +250,200 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void;
| physicalFeedback | string | 用于物理反馈振动的场景。 | | physicalFeedback | string | 用于物理反馈振动的场景。 |
| simulateReality | 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
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------- |
| duration | number | 是 | 马达振动时长, 单位ms。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**示例：**
```js
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>(deprecated)</sup>
vibrate(duration: number, callback?: AsyncCallback&lt;void&gt;): void
按照指定持续时间触发马达振动。
从API version 9 开始不再维护，建议使用 [vibrator.startVibration](#vibratorstartvibration9) 代替。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| duration | number | 是 | 马达振动时长, 单位ms。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
**示例：**
```js
vibrator.vibrate(1000,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<sup>(deprecated)</sup>
vibrate(effectId: EffectId): Promise&lt;void&gt;
按照预置振动效果触发马达振动。
从API version 9 开始不再维护，建议使用 [vibrator.startVibration](#vibratorstartvibration9-1) 代替。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------ |
| effectId | [EffectId](#effectid) | 是 | 预置的振动效果ID。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**示例：**
```js
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.vibrate<sup>(deprecated)</sup>
vibrate(effectId: EffectId, callback?: AsyncCallback&lt;void&gt;): void
按照指定振动效果触发马达振动。
从API version 9 开始不再维护，建议使用 [vibrator.startVibration](#vibratorstartvibration9) 代替。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| effectId | [EffectId](#effectid) | 是 | 预置的振动效果ID。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达振动成功，err为undefined，否则为错误对象。 |
**示例：**
```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.stop<sup>(deprecated)</sup>
stop(stopMode: VibratorStopMode): Promise&lt;void&gt;
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
从API version 9 开始不再维护，建议使用 [vibrator.stopVibration](#vibratorstopvibration9-1) 代替。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------ |
| stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**示例：**
```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.stop<sup>(deprecated)</sup>
stop(stopMode: VibratorStopMode, callback?: AsyncCallback&lt;void&gt;): void
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同，则调用本接口会失败。
从API version 9 开始不再维护，建议使用 [vibrator.stopVibration](#vibratorstopvibration9) 代替。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| stopMode | [VibratorStopMode](#vibratorstopmode) | 是 | 马达停止指定的振动模式。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当马达停止振动成功，err为undefined，否则为错误对象。 |
**示例：**
```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.
先完成此消息的编辑！
想要评论请 注册 或