1# vibrator.h
2
3
4## Overview
5
6The **vibrator.h** file declares the APIs for starting or stopping vibration.
7
8**Library**: libohvibrator.z.so
9
10**System capability**: SystemCapability.Sensors.MiscDevice
11
12**Since**: 11
13
14**Related module**: [Vibrator](_vibrator.md)
15
16
17## Summary
18
19
20### Functions
21
22| Name| Description|
23| -------- | -------- |
24| [OHOS::Sensors::OH_Vibrator_PlayVibration](#oh_vibrator_playvibration)(int32_t duration, Vibrator_Attribute attribute) | Controls the vibrator to vibrate continuously for a given duration.|
25| [OHOS::Sensors::OH_Vibrator_PlayVibrationCustom](#oh_vibrator_playvibrationcustom)(Vibrator_FileDescription fileDescription, Vibrator_Attribute vibrateAttribute) | Controls the vibrator to vibrate with the custom sequence.          |
26| [OHOS::Sensors::OH_Vibrator_Cancel](#oh_vibrator_cancel)() | Stops the vibration. |
27
28
29## Function Description
30
31
32### OH_Vibrator_Cancel()
33
34```
35int32_t OHOS::Sensors::OH_Vibrator_Cancel()
36```
37**Description**
38
39Stops the vibration.
40
41**Since**: 11
42
43**Returns**
44
45Returns **0** if the operation is successful; returns a non-zero value otherwise. For details, see [Vibrator_ErrorCode](_vibrator.md#vibrator_errorcode).
46
47**Required Permissions**
48
49ohos.permission.VIBRATE
50
51
52### OH_Vibrator_PlayVibration()
53
54```
55int32_t OHOS::Sensors::OH_Vibrator_PlayVibration(int32_t duration, Vibrator_Attribute attribute)
56```
57**Description**
58
59Controls the vibrator to vibrate continuously for a given duration.
60
61**Since**: 11
62
63**Parameters**
64
65| Name| Description|
66| -------- | -------- |
67| duration | Vibration duration, in milliseconds. |
68| attribute | Vibration attribute. For details, see [Vibrator_Attribute](_vibrator.md#vibrator_attribute).|
69
70**Returns**
71
72Returns **0** if the operation is successful; returns a non-zero value otherwise. For details, see [Vibrator_ErrorCode](_vibrator.md#vibrator_errorcode).
73
74**Required Permissions**
75
76ohos.permission.VIBRATE
77
78
79### OH_Vibrator_PlayVibrationCustom()
80
81```
82int32_t OHOS::Sensors::OH_Vibrator_PlayVibrationCustom(Vibrator_FileDescription fileDescription, Vibrator_Attribute vibrateAttribute)
83```
84**Description**
85
86Controls the vibrator to vibrate with the custom sequence.
87
88**Since**: 11
89
90**Parameters**
91
92| Name| Description|
93| -------- | -------- |
94| fileDescription | File descriptor of the custom vibration effect. For details, see [Vibrator_FileDescription](_vibrator.md#vibrator_filedescription).|
95| vibrateAttribute | Vibration attribute. For details, see [Vibrator_Attribute](_vibrator.md#vibrator_attribute).|
96
97**Returns**
98
99Returns **0** if the operation is successful; returns a non-zero value otherwise. For details, see [Vibrator_ErrorCode](_vibrator.md#vibrator_errorcode).
100
101**Required Permissions**
102
103ohos.permission.VIBRATE
104