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