1# IVibratorInterface 2 3 4## 概述 5 6Vibrator模块向上层服务提供统一的接口。 7 8上层服务开发人员可根据Vibrator模块提供的统一接口，用于控制马达执行单次或周期性振动。 9 10**起始版本：** 4.1 11 12**相关模块：**[Vibrator](_vibrator_v12.md) 13 14 15## 汇总 16 17 18### Public 成员函数 19 20| 名称 | 描述 | 21| -------- | -------- | 22| [PlayHapticPattern](#playhapticpattern) ([in] struct [HapticPaket](_haptic_paket_v12.md) pkg) | 高清振动数据下发。 | 23| [GetHapticCapacity](#gethapticcapacity) ([out] struct [HapticCapacity](_haptic_capacity_v12.md)[HapticCapacity](_haptic_capacity_v12.md)) | 获取马达振动能力。 | 24| [GetHapticStartUpTime](#gethapticstartuptime) ([in] int mode, [out] int startUpTime) | 获取起振时间。 | 25| [StopV1_2](#stopv1_2) ([in] int mode) | 停止马达振动。 | 26 27 28## 成员函数说明 29 30 31### GetHapticCapacity() 32 33``` 34IVibratorInterface::GetHapticCapacity ([out] struct HapticCapacity HapticCapacity) 35``` 36**描述** 37获取马达振动能力。 38 39**起始版本：** 4.1 40 41**参数:** 42 43| 名称 | 描述 | 44| -------- | -------- | 45| [HapticCapacity](_haptic_capacity_v12.md) | 表示振动能力数据包，属性包含是否高清振动，是否支持延时振动，是否支持预定义振动。 | 46 47**返回：** 48 49如果操作成功，则返回0。 50 51如果操作失败，则返回负值。 52 53 54### GetHapticStartUpTime() 55 56``` 57IVibratorInterface::GetHapticStartUpTime ([in] int mode, [out] int startUpTime ) 58``` 59**描述** 60获取起振时间。 61 62**起始版本：** 4.1 63 64**参数:** 65 66| 名称 | 描述 | 67| -------- | -------- | 68| startUpTime | 表示从下达振动振动命令到马达振动起来的时间，mode为振动模式，按照模式去获取。 | 69 70**返回：** 71 72如果操作成功，则返回0。 73 74如果操作失败，则返回负值。 75 76 77### PlayHapticPattern() 78 79``` 80IVibratorInterface::PlayHapticPattern ([in] struct HapticPaket pkg) 81``` 82**描述** 83高清振动数据下发。 84 85**起始版本：** 4.1 86 87**参数:** 88 89| 名称 | 描述 | 90| -------- | -------- | 91| pkg | 表示高清振动数据的数据包，是一个结构体，内部赋值具体振动参数。 | 92 93**返回：** 94 95如果操作成功，则返回0。 96 97如果操作失败，则返回负值。 98 99 100### StopV1_2() 101 102``` 103IVibratorInterface::StopV1_2 ([in] int mode) 104``` 105**描述** 106停止马达振动。 107 108马达启动前，必须在任何模式下停止振动。此功能用在振动过程之后。 109 110**起始版本：** 4.1 111 112**参数:** 113 114| 名称 | 描述 | 115| -------- | -------- | 116| mode | 表示振动模式，可以是单次或周期性或者HD的，详见[HdfVibratorModeV1_2](_vibrator_v12.md#hdfvibratormodev1_2)。 | 117 118**返回：** 119 120如果操作成功，则返回0。 121 122如果操作失败，则返回负值。 123