1# @system.vibrator (振动) 2<!--Kit: Sensor Service Kit--> 3<!--Subsystem: Sensors--> 4<!--Owner: @dilligencer--> 5<!--Designer: @butterls--> 6<!--Tester: @murphy84--> 7<!--Adviser: @hu-zhiqiong--> 8 9vibrator模块提供控制马达振动的能力，主要包含灯的列表查询、打开灯、关闭灯等接口，振动器的列表查询、振动器的振动器效果查询、触发/关闭振动器等接口。 10 11控制类小器件指的是设备上的LED灯和振动器。其中，LED灯主要用作指示（如充电状态）、闪烁功能（如三色灯）等；振动器主要用于闹钟、开关机振动、来电振动等场景。 12 13 14> **说明：** 15> - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 16> - 从API Version 8开始，该接口不再维护，推荐使用新接口[`@ohos.vibrator`](js-apis-vibrator.md)。 17> - 该功能使用需要对应硬件支持，仅支持真机调试。 18 19 20## 导入模块 21 22 23```ts 24import { Vibrator } from '@kit.SensorServiceKit'; 25``` 26 27## Vibrator.vibrate 28 29 vibrate(options?: VibrateOptions): void 30 31触发设备振动。 32 33**需要权限**：ohos.permission.VIBRATE 34 35**系统能力**：SystemCapability.Sensors.MiscDevice.Lite 36 37**参数**： 38 39| 参数名 | 类型 | 必填 | 说明 | 40| ------- | --------------------------------- | ---- | ---------- | 41| options | [VibrateOptions](#vibrateoptions) | 否 | 振动模式。 | 42 43**示例**： 44 45```ts 46import { Vibrator, VibrateOptions } from '@kit.SensorServiceKit'; 47 48let vibrateOptions: VibrateOptions = { 49 mode: 'short', 50 success: () => { 51 console.info('Succeed in vibrating'); 52 }, 53 fail: (data: string, code: number) => { 54 console.error(`Failed to vibrate. Data: ${data}, code: ${code}`); 55 }, 56 complete: () => { 57 console.info('completed in vibrating'); 58 } 59}; 60Vibrator.vibrate(vibrateOptions); 61``` 62 63## VibrateOptions 64 65振动模式。 66 67**需要权限**：ohos.permission.VIBRATE 68 69**系统能力**：SystemCapability.Sensors.MiscDevice.Lite 70 71| 名称 | 类型 | 必填 | 说明 | 72| -------- | -------- | ---- | ------------------------------------------------------------ | 73| mode | string | 否 | 振动的模式，其中long表示长振动，short表示短振动，默认值为long。 | 74| success | Function | 否 | 感应到振动数据变化后的回调函数。 | 75| fail | Function | 否 | 接口调用失败的回调函数。 | 76| complete | Function | 否 | 接口调用结束的回调函数。 |