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**起始版本：** 2.2 41 42**参数:** 43 44| 名称 | 描述 | 45| -------- | -------- | 46| effectType | 表示单次振动的预设效果。建议最大长度为64字节。 | 47 48**返回：** 49 50如果操作成功，则返回0。 51 52如果操作失败，则返回负值。 53 54 55### StartOnce() 56 57``` 58IVibratorInterface::StartOnce ([in] unsigned int duration) 59``` 60**描述** 61控制马达以执行给定持续时间的单次振动。 62 63单次振动与周期振动相互排斥。在执行单次振动之前，需退出周期性振动。 64 65**起始版本：** 2.2 66 67**参数:** 68 69| 名称 | 描述 | 70| -------- | -------- | 71| duration | 表示单次振动的持续时间，以毫秒为单位。 | 72 73**返回：** 74 75如果操作成功，则返回0。 76 77如果操作失败，则返回负值。 78 79 80### Stop() 81 82``` 83IVibratorInterface::Stop ([in] enum HdfVibratorMode mode) 84``` 85**描述** 86停止马达振动。 87 88马达启动前，必须在任何模式下停止振动。此功能用在振动过程之后。 89 90**起始版本：** 2.2 91 92**参数:** 93 94| 名称 | 描述 | 95| -------- | -------- | 96| mode | 表示振动模式，可以是单次或周期性的，详见[HdfVibratorMode](_vibrator_v10.md#hdfvibratormode)。 | 97 98**返回：** 99 100如果操作成功，则返回0。 101 102如果操作失败，则返回负值。 103