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