• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# vibrator.h
2<!--Kit: Sensor Service Kit-->
3<!--Subsystem: Sensors-->
4<!--Owner: @dilligencer-->
5<!--Designer: @butterls-->
6<!--Tester: @murphy84-->
7<!--Adviser: @hu-zhiqiong-->
8
9## 概述
10
11为您提供标准的开放api，用于控制马达振动的启停。
12
13**库**：libohvibrator.z.so
14
15**系统能力**：SystemCapability.Sensors.MiscDevice
16
17**起始版本**：11
18
19**相关模块**：[Vibrator](_vibrator.md)
20
21
22## 汇总
23
24
25### 函数
26
27| 名称 | 描述 |
28| -------- | -------- |
29| [OHOS::Sensors::OH_Vibrator_PlayVibration](#oh_vibrator_playvibration)(int32_t duration, Vibrator_Attribute attribute) | 控制马达在指定时间内持续振动。 |
30| [OHOS::Sensors::OH_Vibrator_PlayVibrationCustom](#oh_vibrator_playvibrationcustom)(Vibrator_FileDescription fileDescription, Vibrator_Attribute vibrateAttribute) | 播放自定义振动序列。           |
31| [OHOS::Sensors::OH_Vibrator_Cancel](#oh_vibrator_cancel)() | 停止马达振动。  |
32
33
34## 函数说明
35
36
37### OH_Vibrator_Cancel()
38
39```
40int32_t OHOS::Sensors::OH_Vibrator_Cancel()
41```
42**描述**：
43
44停止马达振动。
45
46**起始版本**：11
47
48**返回**：
49
50如果操作成功，则返回0；否则返回非零值。请参阅 [Vibrator_ErrorCode](_vibrator.md#vibrator_errorcode)。
51
52**Permission**:
53
54ohos.permission.VIBRATE
55
56
57### OH_Vibrator_PlayVibration()
58
59```
60int32_t OHOS::Sensors::OH_Vibrator_PlayVibration(int32_t duration, Vibrator_Attribute attribute)
61```
62**描述**：
63
64控制马达在指定时间内持续振动。
65
66**起始版本**：11
67
68**参数**：
69
70| 名称 | 描述 |
71| -------- | -------- |
72| duration | 振动时长，单位：毫秒。  |
73| attribute | 振动属性，请参考 [Vibrator_Attribute](_vibrator.md#vibrator_attribute)。 |
74
75**返回**：
76
77如果操作成功，则返回0；否则返回非零值。请参阅 [Vibrator_ErrorCode](_vibrator.md#vibrator_errorcode)。
78
79**Permission**:
80
81ohos.permission.VIBRATE
82
83
84### OH_Vibrator_PlayVibrationCustom()
85
86```
87int32_t OHOS::Sensors::OH_Vibrator_PlayVibrationCustom(Vibrator_FileDescription fileDescription, Vibrator_Attribute vibrateAttribute)
88```
89**描述**：
90
91播放自定义振动序列。
92
93**起始版本**：11
94
95**参数**：
96
97| 名称 | 描述 |
98| -------- | -------- |
99| fileDescription | 自定义振动效果文件描述符，请参阅 [Vibrator_FileDescription](_vibrator.md#vibrator_filedescription)。 |
100| vibrateAttribute | 振动属性，请参阅 [Vibrator_Attribute](_vibrator.md#vibrator_attribute)。 |
101
102**返回**：
103
104如果操作成功，则返回0；否则返回非零值。请参阅 [Vibrator_ErrorCode](_vibrator.md#vibrator_errorcode)。
105
106**Permission**:
107
108ohos.permission.VIBRATE
109