Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
dd3a073e
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看板
提交
dd3a073e
编写于
2年前
作者:
B
bailu1992
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
vibrate错误码整改-3
Signed-off-by:
N
bailu1992
<
bailu27@huawei.com
>
上级
4513eeae
master
OpenHarmony-3.2-Beta4
OpenHarmony-3.2-Beta5
OpenHarmony-3.2-Release
OpenHarmony-4.0-Beta1
OpenHarmony-4.0-Beta2
bak_OpenHarmony-4.0-Beta1_20230529
docs-modify
monthly_20221018
monthly_20230815
revert-merge-17651-master
revert-merge-19334-OpenHarmony-4.0-Beta1
revert-merge-19586-master
revert-merge-20613-master
revert-merge-21757-OpenHarmony-4.0-Beta2
revert-merge-21765-OpenHarmony-4.0-Beta2
revert-merge-23766-master
weekly_20221011
weekly_20221018
weekly_20221025
weekly_20221101
weekly_20221108
weekly_20221115
weekly_20221122
weekly_20221129
weekly_20221206
weekly_20221213
weekly_20221220
weekly_20221227
weekly_20230103
weekly_20230110
weekly_20230117
weekly_20230124
weekly_20230131
weekly_20230207
weekly_20230214
weekly_20230221
weekly_20230228
weekly_20230307
weekly_20230314
weekly_20230321
weekly_20230328
weekly_20230404
weekly_20230411
weekly_20230418
weekly_20230425
weekly_20230502
weekly_20230509
weekly_20230516
weekly_20230523
weekly_20230530
weekly_20230606
weekly_20230613
weekly_20230619
weekly_20230626
weekly_20230627
weekly_20230704
weekly_20230712
weekly_20230725
weekly_20230801
weekly_20230808
weekly_20230815
weekly_20230822
weekly_20230829
weekly_20230905
OpenHarmony-v4.0-Beta2
OpenHarmony-v4.0-Beta1
OpenHarmony-v3.2.3-Release
OpenHarmony-v3.2.2-Release
OpenHarmony-v3.2.1-Release
OpenHarmony-v3.2-Release
OpenHarmony-v3.2-Beta5
OpenHarmony-v3.2-Beta4
无相关合并请求
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
147 addition
and
130 deletion
+147
-130
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
+147
-130
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-vibrator.md
浏览文件 @
dd3a073e
...
...
@@ -43,9 +43,9 @@ try {
usage
:
'
alarm
'
},
(
error
)
=>
{
if
(
error
){
console
.
log
(
"
vibrate fail, error.code:
"
+
error
.
code
+
"
,error.message:
"
+
error
.
message
);
console
.
log
(
'
vibrate fail, 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.
'
);
}
});
}
catch
(
err
)
{
...
...
@@ -87,9 +87,9 @@ try {
id
:
0
,
usage
:
'
alarm
'
}).
then
(()
=>
{
console
.
log
(
"
Promise returned to indicate a successful vibration
"
);
console
.
log
(
'
Promise returned to indicate a successful vibration
'
);
}).
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
);
...
...
@@ -119,9 +119,9 @@ stopVibration(stopMode: VibratorStopMode, callback: AsyncCallback<⁢void⁢>)
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 successful.
"
);
console
.
log
(
'
Callback returned to indicate successful.
'
);
}
})
}
catch
(
err
)
{
...
...
@@ -156,21 +156,108 @@ stopVibration(stopMode: VibratorStopMode): Promise<⁢void⁢>
```
js
try
{
vibrator
.
stopVibration
(
vibrator
.
VibratorStopMode
.
VIBRATOR_STOP_MODE_PRESET
).
then
(()
=>
{
console
.
log
(
"
Promise returned to indicate a successful vibration.
"
);
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
马达振动效果的字符串。
**系统能力**
:以下各项对应的系统能力均为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
<
void
>
按照指定持续时间触发马达振动。
从API version 9 开始不再维护,建议使用
[
vibrator.startVibration
](
#vibratorstartvibration9-1
)
代替。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
...
...
@@ -190,11 +277,11 @@ vibrate(duration: number): Promise<void>
**示例:**
```
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
(
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>
...
...
@@ -203,11 +290,14 @@ vibrate(duration: number, callback?: AsyncCallback<void>): void
按照指定持续时间触发马达振动。
从API version 9 开始不再维护,建议使用
[
vibrator.startVibration
](
#vibratorstartvibration9
)
代替。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| duration | number | 是 | 马达振动时长, 单位ms。 |
...
...
@@ -216,13 +306,13 @@ vibrate(duration: number, callback?: AsyncCallback<void>): void
**示例:**
```
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
(
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.
'
);
}
})
```
...
...
@@ -232,27 +322,32 @@ 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
(
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
);
});
```
...
...
@@ -262,11 +357,14 @@ vibrate(effectId: EffectId, callback?: AsyncCallback<void>): void
按照指定振动效果触发马达振动。
从API version 9 开始不再维护,建议使用
[
vibrator.startVibration
](
#vibratorstartvibration9
)
代替。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------------------------- |
| effectId |
[
EffectId
](
#effectid
)
| 是 | 预置的振动效果ID。 |
...
...
@@ -275,13 +373,13 @@ vibrate(effectId: EffectId, callback?: AsyncCallback<void>): void
**示例:**
```
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
(
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>
...
...
@@ -290,6 +388,8 @@ stop(stopMode: VibratorStopMode): Promise<void>
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同,则调用本接口会失败。
从API version 9 开始不再维护,建议使用
[
vibrator.stopVibration
](
#vibratorstopvibration9-1
)
代替。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
...
...
@@ -309,11 +409,11 @@ 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
);
});
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
);
});
```
...
...
@@ -323,11 +423,14 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void
按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同,则调用本接口会失败。
从API version 9 开始不再维护,建议使用
[
vibrator.stopVibration
](
#vibratorstopvibration9
)
代替。
**需要权限**
:ohos.permission.VIBRATE
**系统能力**
:SystemCapability.Sensors.MiscDevice
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| stopMode |
[
VibratorStopMode
](
#vibratorstopmode
)
| 是 | 马达停止指定的振动模式。 |
...
...
@@ -336,97 +439,11 @@ stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void
**示例:**
```
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.
"
);
}
})
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
马达振动效果的字符串。
**系统能力**
:以下各项对应的系统能力均为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 | 用于模拟现实振动的场景。 |
This diff is collapsed.
Click to expand it.
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录
反馈
建议
客服
返回
顶部