1# Vibrator 2<!--Kit: Sensor Service Kit--> 3<!--Subsystem: Sensors--> 4<!--Owner: @dilligencer--> 5<!--Designer: @butterls--> 6<!--Tester: @murphy84--> 7<!--Adviser: @hu-zhiqiong--> 8 9## 概述 10 11为马达服务提供统一的API以访问马达驱动程序属性。 12 13**起始版本**：11 14 15 16## 汇总 17 18 19### 文件 20 21| 名称 | 描述 | 22| -------- | -------- | 23| [vibrator_type.h](vibrator_type_8h.md) | 为您提供标准的开放api，用于控制马达振动的启停。 | 24 25 26### 结构体 27 28| 名称 | 描述 | 29| -------- | -------- | 30| [Vibrator_Attribute](_vibrator_attribute.md) | 马达属性。 | 31| [Vibrator_FileDescription](_vibrator_file_description.md) | 振动文件描述。 | 32 33 34### 类型定义 35 36| 名称 | 描述 | 37| -------- | -------- | 38| [Vibrator_ErrorCode](#vibrator_errorcode) | 为用户定义错误码。 | 39| [Vibrator_Usage](#vibrator_usage) | 振动优先级。 | 40| [Vibrator_Attribute](#vibrator_attribute) | 马达属性。 | 41| [Vibrator_FileDescription](#vibrator_filedescription) | 振动文件描述。 | 42 43 44### 枚举 45 46| 名称 | 描述 | 47| -------- | -------- | 48| [Vibrator_ErrorCode](#vibrator_errorcode) : int32_t { <br/>PERMISSION_DENIED = 201, <br/>PARAMETER_ERROR = 401, <br/>UNSUPPORTED = 801, <br/>DEVICE_OPERATION_FAILED = 14600101<br/>} | 为用户定义错误码。 | 49| [Vibrator_Usage](#vibrator_usage) {<br/>USAGE_UNKNOWN = 0, <br/>USAGE_ALARM = 1, <br/>USAGE_RING = 2,<br/> USAGE_NOTIFICATION = 3,<br/>USAGE_COMMUNICATION = 4, <br/>USAGE_TOUCH = 5, <br/>USAGE_MEDIA = 6, <br/>USAGE_PHYSICAL_FEEDBACK = 7,<br/>USAGE_SIMULATE_REALITY = 8, <br/>USAGE_MAX = 9<br/>} | 振动优先级。 | 50 51 52## 类型定义说明 53 54 55### Vibrator_Attribute 56 57``` 58typedef struct Vibrator_Attribute Vibrator_Attribute 59``` 60**描述**： 61 62马达属性。 63 64**起始版本**：11 65 66 67### Vibrator_ErrorCode 68 69``` 70typedef enum Vibrator_ErrorCode Vibrator_ErrorCode 71``` 72**描述**： 73 74为用户定义错误码。 75 76**起始版本**：11 77 78 79### Vibrator_FileDescription 80 81``` 82typedef struct Vibrator_FileDescription Vibrator_FileDescription 83``` 84**描述**： 85 86振动文件描述。 87 88**起始版本**：11 89 90 91### Vibrator_Usage 92 93``` 94typedef enum Vibrator_Usage Vibrator_Usage 95``` 96**描述**： 97 98振动优先级。 99 100**起始版本**：11 101 102 103## 枚举类型说明 104 105 106### Vibrator_ErrorCode 107 108``` 109enum Vibrator_ErrorCode:int32_t 110``` 111**描述**： 112 113为用户定义错误码。 114 115**起始版本**：11 116 117| 枚举值 | 描述 | 118| -------- | -------- | 119| PERMISSION_DENIED | 权限校验失败。 | 120| PARAMETER_ERROR | 参数检查失败，包括必选参数没有传入，参数类型错误等。 | 121| UNSUPPORTED | 该设备不支持此 API，通常用于在设备已支持该 SysCap 时，针对其少量的 API 的支持处理。 | 122| DEVICE_OPERATION_FAILED | 设备操作失败。 | 123 124 125### Vibrator_Usage 126 127``` 128enum Vibrator_Usage 129``` 130**描述**： 131 132振动优先级。 133 134**起始版本**：11 135 136| 枚举值 | 描述 | 137| -------- | -------- | 138| USAGE_UNKNOWN | 未知场景。 | 139| USAGE_ALARM | 报警。 | 140| USAGE_RING | 铃声。 | 141| USAGE_NOTIFICATION | 通知。 | 142| USAGE_COMMUNICATION | 通信。 | 143| USAGE_TOUCH | 触摸。 | 144| USAGE_MEDIA | 媒体。 | 145| USAGE_PHYSICAL_FEEDBACK | 物理反馈。 | 146| USAGE_SIMULATE_REALITY | 模拟现实。 | 147