Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
664ff94d
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
664ff94d
编写于
10月 10, 2022
作者:
O
openharmony_ci
提交者:
Gitee
10月 10, 2022
浏览文件
操作
浏览文件
下载
差异文件
!10218 马达新增两个接口的资料修改
Merge pull request !10218 from 白露/master
上级
f443fff4
a11cdc51
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
273 addition
and
179 deletion
+273
-179
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
+273
-179
未找到文件。
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
<
void
>
startVibration(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallback
<
void
>
): void
按照指定
持续时间
触发马达振动。
按照指定
振动效果和振动属性
触发马达振动。
**需要权限**
:ohos.permission.VIBRATE
...
...
@@ -25,29 +25,37 @@ vibrate(duration: number): Promise<void>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------- |
| duration | number | 是 | 马达振动时长, 单位ms。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise
<
void
>
| Promise对象。无返回结果的Promise对象。 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- | :--------------------------------------------------------- |
| effect |
[
VibrateEffect
](
#vibrateeffect9
)
| 是 | 马达振动效果。 |
| attribute |
[
VibrateAttribute
](
#vibrateattribute9
)
| 是 | 马达振动属性。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当马达振动成功,err为undefined,否则为错误对象。 |
**示例:**
示例:
```
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
);
});
```
```
js
try
{
vibrator
.
startVibration
({
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.
'
);
}
});
}
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
<
void
>
startVibration
(effect: VibrateEffect, attribute: VibrateAttribute): Promise
<
void
>
按照指定振动效果和振动属性触发马达振动。
...
...
@@ -55,10 +63,10 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise<void>
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- |
:
------------- |
| --------- | -------------------------------------- | ---- |
-
------------- |
| effect |
[
VibrateEffect
](
#vibrateeffect9
)
| 是 | 马达振动效果。 |
| attribute |
[
VibrateAttribute
](
#vibrateattribute9
)
| 是 | 马达振动属性。 |
...
...
@@ -70,146 +78,60 @@ vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise<void>
**示例:**
```
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
);
})
```
## vibrator.vibrate
vibrate(duration: number, callback?: AsyncCallback
<
void
>
): void
按照指定持续时间触发马达振动。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| duration | number | 是 | 马达振动时长, 单位ms。 |
| callback | AsyncCallback
<
void
>
| 否 | 回调函数。当马达振动成功,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.
"
);
}
})
},
{
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
);
})
}
catch
(
err
)
{
console
.
info
(
'
errCode:
'
+
err
.
code
+
'
,msg:
'
+
err
.
message
);
}
```
## vibrator.stopVibration<sup>9+</sup>
## vibrator.vibrate
vibrate(effectId: EffectId): Promise
<
void
>
stopVibration(stopMode: VibratorStopMode, callback: AsyncCallback
<
void
>
): void
按照
预置振动效果触发马达振动
。
按照
要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同,则调用本接口会失败
。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------ |
| effectId |
[
EffectId
](
#effectid
)
| 是 | 预置的振动效果ID。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise
<
void
>
| 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
<
void
>
): void
按照指定振动效果触发马达振动。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| effectId |
[
EffectId
](
#effectid
)
| 是 | 预置的振动效果ID。 |
| callback | AsyncCallback
<
void
>
| 否 | 回调函数。当马达振动成功,err为undefined,否则为错误对象。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| stopMode |
[
VibratorStopMode
](
#vibratorstopmode
)
| 是 | 马达停止指定的振动模式。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当马达停止振动成功,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.
"
);
}
})
try
{
vibrator
.
stopVibration
(
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.
'
);
}
})
}
catch
(
err
)
{
console
.
info
(
'
errCode:
'
+
err
.
code
+
'
,msg:
'
+
err
.
message
);
}
```
## vibrator.vibrate<sup>9+</sup>
vibrate(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallback
<
void
>
): void
按照指定振动效果和振动属性触发马达振动。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | -------------------------------------- | ---- | :--------------------------------------------------------- |
| effect |
[
VibrateEffect
](
#vibrateeffect9
)
| 是 | 马达振动效果。 |
| attribute |
[
VibrateAttribute
](
#vibrateattribute9
)
| 是 | 马达振动属性。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。当马达振动成功,err为undefined,否则为错误对象。 |
示例:
## vibrator.stopVibration<sup>9+</sup>
```
js
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
<
void
>
stopVibration(stopMode: VibratorStopMode): Promise
<
void
>
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同,则调用本接口会失败。
...
...
@@ -218,6 +140,7 @@ stop(stopMode: VibratorStopMode): Promise<void>
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------ |
| stopMode |
[
VibratorStopMode
](
#vibratorstopmode
)
| 是 | 马达停止指定的振动模式。 |
...
...
@@ -231,43 +154,17 @@ stop(stopMode: VibratorStopMode): Promise<void>
**示例:**
```
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
);
});
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
);
});
}
catch
(
err
)
{
console
.
info
(
'
errCode:
'
+
err
.
code
+
'
,msg:
'
+
err
.
message
);
}
```
## vibrator.stop
stop(stopMode: VibratorStopMode, callback?: AsyncCallback
<
void
>
): void;
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同,则调用本接口会失败。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| stopMode |
[
VibratorStopMode
](
#vibratorstopmode
)
| 是 | 马达停止指定的振动模式。 |
| callback | AsyncCallback
<
void
>
| 否 | 回调函数。当马达停止振动成功,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
马达振动效果的字符串。
...
...
@@ -353,3 +250,200 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void;
| physicalFeedback | string | 用于物理反馈振动的场景。 |
| simulateReality | string | 用于模拟现实振动的场景。 |
## vibrator.vibrate<sup>(deprecated)</sup>
vibrate(duration: number): Promise
<
void
>
按照指定持续时间触发马达振动。
从API version 9 开始不再维护,建议使用
[
vibrator.startVibration
](
#vibratorstartvibration9-1
)
代替。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------- |
| duration | number | 是 | 马达振动时长, 单位ms。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise
<
void
>
| 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
<
void
>
): void
按照指定持续时间触发马达振动。
从API version 9 开始不再维护,建议使用
[
vibrator.startVibration
](
#vibratorstartvibration9
)
代替。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| duration | number | 是 | 马达振动时长, 单位ms。 |
| callback | AsyncCallback
<
void
>
| 否 | 回调函数。当马达振动成功,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
<
void
>
按照预置振动效果触发马达振动。
从API version 9 开始不再维护,建议使用
[
vibrator.startVibration
](
#vibratorstartvibration9-1
)
代替。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------ |
| effectId |
[
EffectId
](
#effectid
)
| 是 | 预置的振动效果ID。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise
<
void
>
| 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
<
void
>
): void
按照指定振动效果触发马达振动。
从API version 9 开始不再维护,建议使用
[
vibrator.startVibration
](
#vibratorstartvibration9
)
代替。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| effectId |
[
EffectId
](
#effectid
)
| 是 | 预置的振动效果ID。 |
| callback | AsyncCallback
<
void
>
| 否 | 回调函数。当马达振动成功,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
<
void
>
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同,则调用本接口会失败。
从API version 9 开始不再维护,建议使用
[
vibrator.stopVibration
](
#vibratorstopvibration9-1
)
代替。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------ |
| stopMode |
[
VibratorStopMode
](
#vibratorstopmode
)
| 是 | 马达停止指定的振动模式。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | -------------------------------------- |
| Promise
<
void
>
| 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
<
void
>
): void
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同,则调用本接口会失败。
从API version 9 开始不再维护,建议使用
[
vibrator.stopVibration
](
#vibratorstopvibration9
)
代替。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| stopMode |
[
VibratorStopMode
](
#vibratorstopmode
)
| 是 | 马达停止指定的振动模式。 |
| callback | AsyncCallback
<
void
>
| 否 | 回调函数。当马达停止振动成功,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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录