1# IVibratorInterface
2
3
4## 概述
5
6Vibrator模块向上层服务提供统一的接口。
7
8上层服务开发人员可根据Vibrator模块提供的统一接口，用于控制马达执行单次或周期性振动。
9
10**起始版本：** 2.2
11
12**相关模块：**[Vibrator](_vibrator_v10.md)
13
14
15## 汇总
16
17
18### Public 成员函数
19
20| 名称 | 描述 |
21| -------- | -------- |
22| [StartOnce](#startonce) ([in] unsigned int duration) | 控制马达以执行给定持续时间的单次振动。  |
23| [Start](#start) ([in] String effectType) | 控制马达以预置效果执行周期性振动。  |
24| [Stop](#stop) ([in] enum [HdfVibratorMode](_vibrator_v10.md#hdfvibratormode) mode) | 停止马达振动。  |
25
26
27## 成员函数说明
28
29
30### Start()
31
32```
33IVibratorInterface::Start ([in] String effectType)
34```
35**描述**
36
37控制马达以预置效果执行周期性振动。
38
39单次振动与周期振动相互排斥。在执行周期性振动之前，需退出单次振动。
40
41**起始版本：** 2.2
42
43**参数:**
44
45| 名称 | 描述 |
46| -------- | -------- |
47| effectType | 表示单次振动的预设效果。建议最大长度为64字节。 |
48
49**返回：**
50
51如果操作成功，则返回0。
52
53如果操作失败，则返回负值。
54
55
56### StartOnce()
57
58```
59IVibratorInterface::StartOnce ([in] unsigned int duration)
60```
61**描述**
62
63控制马达以执行给定持续时间的单次振动。
64
65单次振动与周期振动相互排斥。在执行单次振动之前，需退出周期性振动。
66
67**起始版本：** 2.2
68
69**参数:**
70
71| 名称 | 描述 |
72| -------- | -------- |
73| duration | 表示单次振动的持续时间，以毫秒为单位。 |
74
75**返回：**
76
77如果操作成功，则返回0。
78
79如果操作失败，则返回负值。
80
81
82### Stop()
83
84```
85IVibratorInterface::Stop ([in] enum HdfVibratorMode mode)
86```
87**描述**
88
89停止马达振动。
90
91马达启动前，必须在任何模式下停止振动。此功能用在振动过程之后。
92
93**起始版本：** 2.2
94
95**参数:**
96
97| 名称 | 描述 |
98| -------- | -------- |
99| mode | 表示振动模式，可以是单次或周期性的，详见[HdfVibratorMode](_vibrator_v10.md#hdfvibratormode)。 |
100
101**返回：**
102
103如果操作成功，则返回0。
104
105如果操作失败，则返回负值。
106