• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 振动<a name="ZH-CN_TOPIC_0000001209667969"></a>
2
3>![](../../public_sys-resources/icon-note.gif) **说明:**
4>从API Version 7 开始支持。
5
6## 导入模块<a name="zh-cn_topic_0000001144895807_s56d19203690d4782bfc74069abb6bd71"></a>
7
8```
9import vibrate from '@ohos.vibrator';
10```
11
12## 权限列表<a name="zh-cn_topic_0000001144895807_section11257113618419"></a>
13
14ohos.permission.VIBRATE
15
16## vibrate.vibrate<a name="zh-cn_topic_0000001144895807_section94955414221"></a>
17
18vibrate\(duration: number\): Promise<void\>
19
20按照指定持续时间触发马达振动。
21
22**参数:**
23
24<a name="zh-cn_topic_0000001144895807_table366016210217"></a>
25<table><thead align="left"><tr id="zh-cn_topic_0000001144895807_row966192920"><th class="cellrowborder" valign="top" width="15.52%" id="mcps1.1.5.1.1"><p id="zh-cn_topic_0000001144895807_p3661421219"><a name="zh-cn_topic_0000001144895807_p3661421219"></a><a name="zh-cn_topic_0000001144895807_p3661421219"></a>参数名</p>
26</th>
27<th class="cellrowborder" valign="top" width="13.420000000000002%" id="mcps1.1.5.1.2"><p id="zh-cn_topic_0000001144895807_p26611722215"><a name="zh-cn_topic_0000001144895807_p26611722215"></a><a name="zh-cn_topic_0000001144895807_p26611722215"></a>类型</p>
28</th>
29<th class="cellrowborder" valign="top" width="18.41%" id="mcps1.1.5.1.3"><p id="zh-cn_topic_0000001144895807_p2661425211"><a name="zh-cn_topic_0000001144895807_p2661425211"></a><a name="zh-cn_topic_0000001144895807_p2661425211"></a>必填</p>
30</th>
31<th class="cellrowborder" valign="top" width="52.65%" id="mcps1.1.5.1.4"><p id="zh-cn_topic_0000001144895807_p13661729217"><a name="zh-cn_topic_0000001144895807_p13661729217"></a><a name="zh-cn_topic_0000001144895807_p13661729217"></a>说明</p>
32</th>
33</tr>
34</thead>
35<tbody><tr id="zh-cn_topic_0000001144895807_row1866217210219"><td class="cellrowborder" valign="top" width="15.52%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001144895807_p186571105532"><a name="zh-cn_topic_0000001144895807_p186571105532"></a><a name="zh-cn_topic_0000001144895807_p186571105532"></a>duration</p>
36</td>
37<td class="cellrowborder" valign="top" width="13.420000000000002%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001144895807_p06570015314"><a name="zh-cn_topic_0000001144895807_p06570015314"></a><a name="zh-cn_topic_0000001144895807_p06570015314"></a>number</p>
38</td>
39<td class="cellrowborder" valign="top" width="18.41%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001144895807_p865715085315"><a name="zh-cn_topic_0000001144895807_p865715085315"></a><a name="zh-cn_topic_0000001144895807_p865715085315"></a>是</p>
40</td>
41<td class="cellrowborder" valign="top" width="52.65%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001144895807_p17657110105317"><a name="zh-cn_topic_0000001144895807_p17657110105317"></a><a name="zh-cn_topic_0000001144895807_p17657110105317"></a>指示马达振动的持续时间。</p>
42</td>
43</tr>
44</tbody>
45</table>
46
47**返回值:**
48
49<a name="zh-cn_topic_0000001144895807_table5574181751117"></a>
50<table><thead align="left"><tr id="zh-cn_topic_0000001144895807_row6574017191115"><th class="cellrowborder" valign="top" width="32.14%" id="mcps1.1.3.1.1"><p id="zh-cn_topic_0000001144895807_p11574101711111"><a name="zh-cn_topic_0000001144895807_p11574101711111"></a><a name="zh-cn_topic_0000001144895807_p11574101711111"></a>类型</p>
51</th>
52<th class="cellrowborder" valign="top" width="67.86%" id="mcps1.1.3.1.2"><p id="zh-cn_topic_0000001144895807_p13574917151120"><a name="zh-cn_topic_0000001144895807_p13574917151120"></a><a name="zh-cn_topic_0000001144895807_p13574917151120"></a>说明</p>
53</th>
54</tr>
55</thead>
56<tbody><tr id="zh-cn_topic_0000001144895807_row1757410172116"><td class="cellrowborder" valign="top" width="32.14%" headers="mcps1.1.3.1.1 "><p id="zh-cn_topic_0000001144895807_p5991122122518"><a name="zh-cn_topic_0000001144895807_p5991122122518"></a><a name="zh-cn_topic_0000001144895807_p5991122122518"></a>Promise&lt;void&gt;</p>
57</td>
58<td class="cellrowborder" valign="top" width="67.86%" headers="mcps1.1.3.1.2 "><p id="zh-cn_topic_0000001144895807_p229214354254"><a name="zh-cn_topic_0000001144895807_p229214354254"></a><a name="zh-cn_topic_0000001144895807_p229214354254"></a>指示触发振动是否成功。</p>
59</td>
60</tr>
61</tbody>
62</table>
63
64**示例:**
65
66```
67vibrate.vibrate(100).then(()=>
68    console.log('Promise returned to indicate a successful vibration.')
69).catch((error) => {
70    console.error('Failed to trigger vibration.');
71});
72```
73
74## vibrate.vibrate<a name="zh-cn_topic_0000001144895807_section476323710376"></a>
75
76vibrate\(duration: number, callback?: AsyncCallback<void\>\): void
77
78按照指定持续时间触发马达振动。
79
80**参数:**
81
82<a name="zh-cn_topic_0000001144895807_table16341143583713"></a>
83<table><thead align="left"><tr id="zh-cn_topic_0000001144895807_row43411735153715"><th class="cellrowborder" valign="top" width="11.03%" id="mcps1.1.5.1.1"><p id="zh-cn_topic_0000001144895807_p1134243517370"><a name="zh-cn_topic_0000001144895807_p1134243517370"></a><a name="zh-cn_topic_0000001144895807_p1134243517370"></a>参数名</p>
84</th>
85<th class="cellrowborder" valign="top" width="24.89%" id="mcps1.1.5.1.2"><p id="zh-cn_topic_0000001144895807_p634210351371"><a name="zh-cn_topic_0000001144895807_p634210351371"></a><a name="zh-cn_topic_0000001144895807_p634210351371"></a>类型</p>
86</th>
87<th class="cellrowborder" valign="top" width="8.21%" id="mcps1.1.5.1.3"><p id="zh-cn_topic_0000001144895807_p1234213514373"><a name="zh-cn_topic_0000001144895807_p1234213514373"></a><a name="zh-cn_topic_0000001144895807_p1234213514373"></a>必填</p>
88</th>
89<th class="cellrowborder" valign="top" width="55.87%" id="mcps1.1.5.1.4"><p id="zh-cn_topic_0000001144895807_p19342153573711"><a name="zh-cn_topic_0000001144895807_p19342153573711"></a><a name="zh-cn_topic_0000001144895807_p19342153573711"></a>说明</p>
90</th>
91</tr>
92</thead>
93<tbody><tr id="zh-cn_topic_0000001144895807_row1534210358373"><td class="cellrowborder" valign="top" width="11.03%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001144895807_p33429354373"><a name="zh-cn_topic_0000001144895807_p33429354373"></a><a name="zh-cn_topic_0000001144895807_p33429354373"></a>duration</p>
94</td>
95<td class="cellrowborder" valign="top" width="24.89%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001144895807_p153421354376"><a name="zh-cn_topic_0000001144895807_p153421354376"></a><a name="zh-cn_topic_0000001144895807_p153421354376"></a>number</p>
96</td>
97<td class="cellrowborder" valign="top" width="8.21%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001144895807_p1534219353376"><a name="zh-cn_topic_0000001144895807_p1534219353376"></a><a name="zh-cn_topic_0000001144895807_p1534219353376"></a>是</p>
98</td>
99<td class="cellrowborder" valign="top" width="55.87%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001144895807_p113425351379"><a name="zh-cn_topic_0000001144895807_p113425351379"></a><a name="zh-cn_topic_0000001144895807_p113425351379"></a>指示马达振动的持续时间。</p>
100</td>
101</tr>
102<tr id="zh-cn_topic_0000001144895807_row137131143820"><td class="cellrowborder" valign="top" width="11.03%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001144895807_p1681411133817"><a name="zh-cn_topic_0000001144895807_p1681411133817"></a><a name="zh-cn_topic_0000001144895807_p1681411133817"></a>callback</p>
103</td>
104<td class="cellrowborder" valign="top" width="24.89%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001144895807_p1882115383"><a name="zh-cn_topic_0000001144895807_p1882115383"></a><a name="zh-cn_topic_0000001144895807_p1882115383"></a>AsyncCallback&lt;void&gt;</p>
105</td>
106<td class="cellrowborder" valign="top" width="8.21%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001144895807_p6831113380"><a name="zh-cn_topic_0000001144895807_p6831113380"></a><a name="zh-cn_topic_0000001144895807_p6831113380"></a>否</p>
107</td>
108<td class="cellrowborder" valign="top" width="55.87%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001144895807_p12861113812"><a name="zh-cn_topic_0000001144895807_p12861113812"></a><a name="zh-cn_topic_0000001144895807_p12861113812"></a>马达执行振动的回调函数,指示触发振动是否成功。</p>
109</td>
110</tr>
111</tbody>
112</table>
113
114**示例:**
115
116```
117vibrate.vibrate(100, function(error) {
118    if (error) {
119        console.error("Failed to trigger vibration. Error code: " + error.code + ", message: " + error.message);
120        return;
121    }
122    console.info("Succeeded in triggering vibration.");
123});
124```
125
126## vibrate.vibrate<a name="zh-cn_topic_0000001144895807_section181541055163712"></a>
127
128vibrate\(effectId: EffectId\): Promise<void\>
129
130按照指定振动效果触发马达振动。
131
132**参数:**
133
134<a name="zh-cn_topic_0000001144895807_table1384941535713"></a>
135<table><thead align="left"><tr id="zh-cn_topic_0000001144895807_row78491115165711"><th class="cellrowborder" valign="top" width="14.219999999999999%" id="mcps1.1.5.1.1"><p id="zh-cn_topic_0000001144895807_p1284915159571"><a name="zh-cn_topic_0000001144895807_p1284915159571"></a><a name="zh-cn_topic_0000001144895807_p1284915159571"></a>参数名</p>
136</th>
137<th class="cellrowborder" valign="top" width="21.7%" id="mcps1.1.5.1.2"><p id="zh-cn_topic_0000001144895807_p198491515145711"><a name="zh-cn_topic_0000001144895807_p198491515145711"></a><a name="zh-cn_topic_0000001144895807_p198491515145711"></a>类型</p>
138</th>
139<th class="cellrowborder" valign="top" width="9.51%" id="mcps1.1.5.1.3"><p id="zh-cn_topic_0000001144895807_p178491315195713"><a name="zh-cn_topic_0000001144895807_p178491315195713"></a><a name="zh-cn_topic_0000001144895807_p178491315195713"></a>必填</p>
140</th>
141<th class="cellrowborder" valign="top" width="54.56999999999999%" id="mcps1.1.5.1.4"><p id="zh-cn_topic_0000001144895807_p14849915175715"><a name="zh-cn_topic_0000001144895807_p14849915175715"></a><a name="zh-cn_topic_0000001144895807_p14849915175715"></a>说明</p>
142</th>
143</tr>
144</thead>
145<tbody><tr id="zh-cn_topic_0000001144895807_row1384921516575"><td class="cellrowborder" valign="top" width="14.219999999999999%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001144895807_p13850161575713"><a name="zh-cn_topic_0000001144895807_p13850161575713"></a><a name="zh-cn_topic_0000001144895807_p13850161575713"></a>effectId</p>
146</td>
147<td class="cellrowborder" valign="top" width="21.7%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001144895807_p1985091595719"><a name="zh-cn_topic_0000001144895807_p1985091595719"></a><a name="zh-cn_topic_0000001144895807_p1985091595719"></a><a href="#zh-cn_topic_0000001144895807_section153834312418">EffectId</a></p>
148</td>
149<td class="cellrowborder" valign="top" width="9.51%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001144895807_p1985013154573"><a name="zh-cn_topic_0000001144895807_p1985013154573"></a><a name="zh-cn_topic_0000001144895807_p1985013154573"></a>是</p>
150</td>
151<td class="cellrowborder" valign="top" width="54.56999999999999%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001144895807_p7850151585712"><a name="zh-cn_topic_0000001144895807_p7850151585712"></a><a name="zh-cn_topic_0000001144895807_p7850151585712"></a>指示马达振动效果的字符串。</p>
152</td>
153</tr>
154</tbody>
155</table>
156
157**返回值:**
158
159<a name="zh-cn_topic_0000001144895807_table1785124316195"></a>
160<table><thead align="left"><tr id="zh-cn_topic_0000001144895807_row38514433192"><th class="cellrowborder" valign="top" width="32.14%" id="mcps1.1.3.1.1"><p id="zh-cn_topic_0000001144895807_p385154317196"><a name="zh-cn_topic_0000001144895807_p385154317196"></a><a name="zh-cn_topic_0000001144895807_p385154317196"></a>类型</p>
161</th>
162<th class="cellrowborder" valign="top" width="67.86%" id="mcps1.1.3.1.2"><p id="zh-cn_topic_0000001144895807_p6852104316193"><a name="zh-cn_topic_0000001144895807_p6852104316193"></a><a name="zh-cn_topic_0000001144895807_p6852104316193"></a>说明</p>
163</th>
164</tr>
165</thead>
166<tbody><tr id="zh-cn_topic_0000001144895807_row15853134311917"><td class="cellrowborder" valign="top" width="32.14%" headers="mcps1.1.3.1.1 "><p id="zh-cn_topic_0000001144895807_p9853114371911"><a name="zh-cn_topic_0000001144895807_p9853114371911"></a><a name="zh-cn_topic_0000001144895807_p9853114371911"></a>Promise&lt;void&gt;</p>
167</td>
168<td class="cellrowborder" valign="top" width="67.86%" headers="mcps1.1.3.1.2 "><p id="zh-cn_topic_0000001144895807_p11853114311918"><a name="zh-cn_topic_0000001144895807_p11853114311918"></a><a name="zh-cn_topic_0000001144895807_p11853114311918"></a>指示触发振动是否成功。</p>
169</td>
170</tr>
171</tbody>
172</table>
173
174**示例:**
175
176```
177vibrate.vibrate(vibrate.EffectId.EFFECT_CLOCK_TIMER).then(()=>
178    console.log('Promise returned to indicate a successful vibration.')
179).catch((error) => {
180    console.error('Failed to trigger vibration.');
181});
182```
183
184## vibrate.vibrate<a name="zh-cn_topic_0000001144895807_section5358162183810"></a>
185
186vibrate\(effectId: EffectId, callback?: AsyncCallback<void\>\): void
187
188按照指定振动效果触发马达振动。
189
190**参数:**
191
192<a name="zh-cn_topic_0000001144895807_table818312045715"></a>
193<table><thead align="left"><tr id="zh-cn_topic_0000001144895807_row121831015576"><th class="cellrowborder" valign="top" width="13.489999999999998%" id="mcps1.1.5.1.1"><p id="zh-cn_topic_0000001144895807_p111841506574"><a name="zh-cn_topic_0000001144895807_p111841506574"></a><a name="zh-cn_topic_0000001144895807_p111841506574"></a>参数名</p>
194</th>
195<th class="cellrowborder" valign="top" width="27.500000000000004%" id="mcps1.1.5.1.2"><p id="zh-cn_topic_0000001144895807_p11843011576"><a name="zh-cn_topic_0000001144895807_p11843011576"></a><a name="zh-cn_topic_0000001144895807_p11843011576"></a>类型</p>
196</th>
197<th class="cellrowborder" valign="top" width="10.84%" id="mcps1.1.5.1.3"><p id="zh-cn_topic_0000001144895807_p3184170195711"><a name="zh-cn_topic_0000001144895807_p3184170195711"></a><a name="zh-cn_topic_0000001144895807_p3184170195711"></a>必填</p>
198</th>
199<th class="cellrowborder" valign="top" width="48.17%" id="mcps1.1.5.1.4"><p id="zh-cn_topic_0000001144895807_p1118414018570"><a name="zh-cn_topic_0000001144895807_p1118414018570"></a><a name="zh-cn_topic_0000001144895807_p1118414018570"></a>说明</p>
200</th>
201</tr>
202</thead>
203<tbody><tr id="zh-cn_topic_0000001144895807_row14184110165716"><td class="cellrowborder" valign="top" width="13.489999999999998%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001144895807_p11841207577"><a name="zh-cn_topic_0000001144895807_p11841207577"></a><a name="zh-cn_topic_0000001144895807_p11841207577"></a>effectId</p>
204</td>
205<td class="cellrowborder" valign="top" width="27.500000000000004%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001144895807_p3466172518113"><a name="zh-cn_topic_0000001144895807_p3466172518113"></a><a name="zh-cn_topic_0000001144895807_p3466172518113"></a><a href="#zh-cn_topic_0000001144895807_section153834312418">EffectId</a></p>
206</td>
207<td class="cellrowborder" valign="top" width="10.84%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001144895807_p1018419011571"><a name="zh-cn_topic_0000001144895807_p1018419011571"></a><a name="zh-cn_topic_0000001144895807_p1018419011571"></a>是</p>
208</td>
209<td class="cellrowborder" valign="top" width="48.17%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001144895807_p545018271000"><a name="zh-cn_topic_0000001144895807_p545018271000"></a><a name="zh-cn_topic_0000001144895807_p545018271000"></a>指示马达振动效果的字符串。</p>
210</td>
211</tr>
212<tr id="zh-cn_topic_0000001144895807_row201843013573"><td class="cellrowborder" valign="top" width="13.489999999999998%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001144895807_p218411095720"><a name="zh-cn_topic_0000001144895807_p218411095720"></a><a name="zh-cn_topic_0000001144895807_p218411095720"></a>callback</p>
213</td>
214<td class="cellrowborder" valign="top" width="27.500000000000004%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001144895807_p818413018578"><a name="zh-cn_topic_0000001144895807_p818413018578"></a><a name="zh-cn_topic_0000001144895807_p818413018578"></a>AsyncCallback&lt;void&gt;</p>
215</td>
216<td class="cellrowborder" valign="top" width="10.84%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001144895807_p191841085713"><a name="zh-cn_topic_0000001144895807_p191841085713"></a><a name="zh-cn_topic_0000001144895807_p191841085713"></a>否</p>
217</td>
218<td class="cellrowborder" valign="top" width="48.17%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001144895807_p19184170125717"><a name="zh-cn_topic_0000001144895807_p19184170125717"></a><a name="zh-cn_topic_0000001144895807_p19184170125717"></a>马达执行振动的回调函数,指示触发振动是否成功。</p>
219</td>
220</tr>
221</tbody>
222</table>
223
224**示例:**
225
226```
227vibrate.vibrate(vibrate.EffectId.EFFECT_CLOCK_TIMER, function(error) {
228    if (error) {
229        console.error("Failed to trigger vibration. Error code: " + error.code + ", message: " + error.message);
230        return;
231    }
232    console.info("Succeeded in triggering vibration.");
233});
234```
235
236## vibrate.stop<a name="zh-cn_topic_0000001144895807_section1717861810386"></a>
237
238stop\(stopMode: VibratorStopMode\): Promise<void\>
239
240按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同,则调用本接口会失败。
241
242**参数:**
243
244<a name="zh-cn_topic_0000001144895807_table18943631185618"></a>
245<table><thead align="left"><tr id="zh-cn_topic_0000001144895807_row794383114561"><th class="cellrowborder" valign="top" width="17.2%" id="mcps1.1.5.1.1"><p id="zh-cn_topic_0000001144895807_p169431131155618"><a name="zh-cn_topic_0000001144895807_p169431131155618"></a><a name="zh-cn_topic_0000001144895807_p169431131155618"></a>参数名</p>
246</th>
247<th class="cellrowborder" valign="top" width="27.800000000000004%" id="mcps1.1.5.1.2"><p id="zh-cn_topic_0000001144895807_p17943103115561"><a name="zh-cn_topic_0000001144895807_p17943103115561"></a><a name="zh-cn_topic_0000001144895807_p17943103115561"></a>类型</p>
248</th>
249<th class="cellrowborder" valign="top" width="14.89%" id="mcps1.1.5.1.3"><p id="zh-cn_topic_0000001144895807_p894373145610"><a name="zh-cn_topic_0000001144895807_p894373145610"></a><a name="zh-cn_topic_0000001144895807_p894373145610"></a>必填</p>
250</th>
251<th class="cellrowborder" valign="top" width="40.11%" id="mcps1.1.5.1.4"><p id="zh-cn_topic_0000001144895807_p6943331165611"><a name="zh-cn_topic_0000001144895807_p6943331165611"></a><a name="zh-cn_topic_0000001144895807_p6943331165611"></a>说明</p>
252</th>
253</tr>
254</thead>
255<tbody><tr id="zh-cn_topic_0000001144895807_row094433111561"><td class="cellrowborder" valign="top" width="17.2%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001144895807_p1594411314562"><a name="zh-cn_topic_0000001144895807_p1594411314562"></a><a name="zh-cn_topic_0000001144895807_p1594411314562"></a>stopMode</p>
256</td>
257<td class="cellrowborder" valign="top" width="27.800000000000004%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001144895807_p6944631155616"><a name="zh-cn_topic_0000001144895807_p6944631155616"></a><a name="zh-cn_topic_0000001144895807_p6944631155616"></a><a href="#zh-cn_topic_0000001144895807_section156137011615">VibratorStopMode</a></p>
258</td>
259<td class="cellrowborder" valign="top" width="14.89%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001144895807_p1294418316567"><a name="zh-cn_topic_0000001144895807_p1294418316567"></a><a name="zh-cn_topic_0000001144895807_p1294418316567"></a>是</p>
260</td>
261<td class="cellrowborder" valign="top" width="40.11%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001144895807_p14944131175617"><a name="zh-cn_topic_0000001144895807_p14944131175617"></a><a name="zh-cn_topic_0000001144895807_p14944131175617"></a>指示马达要停止指定的振动模式。</p>
262</td>
263</tr>
264</tbody>
265</table>
266
267**返回值:**
268
269<a name="zh-cn_topic_0000001144895807_table5101547132414"></a>
270<table><thead align="left"><tr id="zh-cn_topic_0000001144895807_row1011124752414"><th class="cellrowborder" valign="top" width="32.14%" id="mcps1.1.3.1.1"><p id="zh-cn_topic_0000001144895807_p1811144732419"><a name="zh-cn_topic_0000001144895807_p1811144732419"></a><a name="zh-cn_topic_0000001144895807_p1811144732419"></a>类型</p>
271</th>
272<th class="cellrowborder" valign="top" width="67.86%" id="mcps1.1.3.1.2"><p id="zh-cn_topic_0000001144895807_p911194712245"><a name="zh-cn_topic_0000001144895807_p911194712245"></a><a name="zh-cn_topic_0000001144895807_p911194712245"></a>说明</p>
273</th>
274</tr>
275</thead>
276<tbody><tr id="zh-cn_topic_0000001144895807_row161117475243"><td class="cellrowborder" valign="top" width="32.14%" headers="mcps1.1.3.1.1 "><p id="zh-cn_topic_0000001144895807_p6111474249"><a name="zh-cn_topic_0000001144895807_p6111474249"></a><a name="zh-cn_topic_0000001144895807_p6111474249"></a>Promise&lt;void&gt;</p>
277</td>
278<td class="cellrowborder" valign="top" width="67.86%" headers="mcps1.1.3.1.2 "><p id="zh-cn_topic_0000001144895807_p19111047112419"><a name="zh-cn_topic_0000001144895807_p19111047112419"></a><a name="zh-cn_topic_0000001144895807_p19111047112419"></a>指示停止振动是否成功。</p>
279</td>
280</tr>
281</tbody>
282</table>
283
284**示例:**
285
286```
287vibrate.stop(vibrate.VibratorStopMode.VIBRATOR_STOP_MODE_TIME).then(()=>
288    console.log('Promise returned to indicate a successful vibration stop.')
289).catch((error) => {
290    console.error('Failed to stop vibration.');
291});
292```
293
294## vibrate.stop<a name="zh-cn_topic_0000001144895807_section237813213385"></a>
295
296stop\(stopMode: VibratorStopMode, callback?: AsyncCallback<void\>\): void;
297
298按照要停止指定的振动模式来停止马达的振动。如果要停止的振动模式与触发马达振动时的模式不相同,则调用本接口会失败。
299
300**参数:**
301
302<a name="zh-cn_topic_0000001144895807_table2123191316565"></a>
303<table><thead align="left"><tr id="zh-cn_topic_0000001144895807_row61232138569"><th class="cellrowborder" valign="top" width="19.2%" id="mcps1.1.5.1.1"><p id="zh-cn_topic_0000001144895807_p1512361335615"><a name="zh-cn_topic_0000001144895807_p1512361335615"></a><a name="zh-cn_topic_0000001144895807_p1512361335615"></a>参数名</p>
304</th>
305<th class="cellrowborder" valign="top" width="26.840000000000003%" id="mcps1.1.5.1.2"><p id="zh-cn_topic_0000001144895807_p61231113135614"><a name="zh-cn_topic_0000001144895807_p61231113135614"></a><a name="zh-cn_topic_0000001144895807_p61231113135614"></a>类型</p>
306</th>
307<th class="cellrowborder" valign="top" width="8.110000000000001%" id="mcps1.1.5.1.3"><p id="zh-cn_topic_0000001144895807_p12123313115615"><a name="zh-cn_topic_0000001144895807_p12123313115615"></a><a name="zh-cn_topic_0000001144895807_p12123313115615"></a>必填</p>
308</th>
309<th class="cellrowborder" valign="top" width="45.85%" id="mcps1.1.5.1.4"><p id="zh-cn_topic_0000001144895807_p6123101310560"><a name="zh-cn_topic_0000001144895807_p6123101310560"></a><a name="zh-cn_topic_0000001144895807_p6123101310560"></a>说明</p>
310</th>
311</tr>
312</thead>
313<tbody><tr id="zh-cn_topic_0000001144895807_row1312381316560"><td class="cellrowborder" valign="top" width="19.2%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001144895807_p1212461355617"><a name="zh-cn_topic_0000001144895807_p1212461355617"></a><a name="zh-cn_topic_0000001144895807_p1212461355617"></a>stopMode</p>
314</td>
315<td class="cellrowborder" valign="top" width="26.840000000000003%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001144895807_p4124513105614"><a name="zh-cn_topic_0000001144895807_p4124513105614"></a><a name="zh-cn_topic_0000001144895807_p4124513105614"></a><a href="#zh-cn_topic_0000001144895807_section156137011615">VibratorStopMode</a></p>
316</td>
317<td class="cellrowborder" valign="top" width="8.110000000000001%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001144895807_p1912451318562"><a name="zh-cn_topic_0000001144895807_p1912451318562"></a><a name="zh-cn_topic_0000001144895807_p1912451318562"></a>是</p>
318</td>
319<td class="cellrowborder" valign="top" width="45.85%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001144895807_p2124151325616"><a name="zh-cn_topic_0000001144895807_p2124151325616"></a><a name="zh-cn_topic_0000001144895807_p2124151325616"></a>指示马达要停止指定的振动模式。</p>
320</td>
321</tr>
322<tr id="zh-cn_topic_0000001144895807_row6115174720252"><td class="cellrowborder" valign="top" width="19.2%" headers="mcps1.1.5.1.1 "><p id="zh-cn_topic_0000001144895807_p13116847102516"><a name="zh-cn_topic_0000001144895807_p13116847102516"></a><a name="zh-cn_topic_0000001144895807_p13116847102516"></a>callback</p>
323</td>
324<td class="cellrowborder" valign="top" width="26.840000000000003%" headers="mcps1.1.5.1.2 "><p id="zh-cn_topic_0000001144895807_p5911537251"><a name="zh-cn_topic_0000001144895807_p5911537251"></a><a name="zh-cn_topic_0000001144895807_p5911537251"></a>AsyncCallback&lt;void&gt;</p>
325</td>
326<td class="cellrowborder" valign="top" width="8.110000000000001%" headers="mcps1.1.5.1.3 "><p id="zh-cn_topic_0000001144895807_p711713471251"><a name="zh-cn_topic_0000001144895807_p711713471251"></a><a name="zh-cn_topic_0000001144895807_p711713471251"></a>否</p>
327</td>
328<td class="cellrowborder" valign="top" width="45.85%" headers="mcps1.1.5.1.4 "><p id="zh-cn_topic_0000001144895807_p8117114711255"><a name="zh-cn_topic_0000001144895807_p8117114711255"></a><a name="zh-cn_topic_0000001144895807_p8117114711255"></a>马达停止振动的回调函数,指示停止振动是否成功。</p>
329</td>
330</tr>
331</tbody>
332</table>
333
334**示例:**
335
336```
337vibrate.stop(vibrate.VibratorStopMode.VIBRATOR_STOP_MODE_TIME, function(error) {
338    if (error) {
339        console.error("Failed to stop vibration. Error code: " + error.code + ", message: " + error.message);
340        return;
341    }
342    console.info("Vibration stopped.");
343});
344```
345
346## EffectId<a name="zh-cn_topic_0000001144895807_section153834312418"></a>
347
348表示马达振动效果的字符串。
349
350<a name="zh-cn_topic_0000001144895807_table148123357518"></a>
351<table><thead align="left"><tr id="zh-cn_topic_0000001144895807_row881203535118"><th class="cellrowborder" valign="top" width="26.48264826482648%" id="mcps1.1.4.1.1"><p id="zh-cn_topic_0000001144895807_p843564511513"><a name="zh-cn_topic_0000001144895807_p843564511513"></a><a name="zh-cn_topic_0000001144895807_p843564511513"></a>名称</p>
352</th>
353<th class="cellrowborder" valign="top" width="25.68256825682568%" id="mcps1.1.4.1.2"><p id="zh-cn_topic_0000001144895807_p1143574513515"><a name="zh-cn_topic_0000001144895807_p1143574513515"></a><a name="zh-cn_topic_0000001144895807_p1143574513515"></a>默认值</p>
354</th>
355<th class="cellrowborder" valign="top" width="47.83478347834784%" id="mcps1.1.4.1.3"><p id="zh-cn_topic_0000001144895807_p5435154585112"><a name="zh-cn_topic_0000001144895807_p5435154585112"></a><a name="zh-cn_topic_0000001144895807_p5435154585112"></a>说明</p>
356</th>
357</tr>
358</thead>
359<tbody><tr id="zh-cn_topic_0000001144895807_row1181315353513"><td class="cellrowborder" valign="top" width="26.48264826482648%" headers="mcps1.1.4.1.1 "><p id="zh-cn_topic_0000001144895807_p1481317355519"><a name="zh-cn_topic_0000001144895807_p1481317355519"></a><a name="zh-cn_topic_0000001144895807_p1481317355519"></a>EFFECT_CLOCK_TIMER</p>
360</td>
361<td class="cellrowborder" valign="top" width="25.68256825682568%" headers="mcps1.1.4.1.2 "><p id="zh-cn_topic_0000001144895807_p4813035155112"><a name="zh-cn_topic_0000001144895807_p4813035155112"></a><a name="zh-cn_topic_0000001144895807_p4813035155112"></a>"haptic.clock.timer"</p>
362</td>
363<td class="cellrowborder" valign="top" width="47.83478347834784%" headers="mcps1.1.4.1.3 "><p id="zh-cn_topic_0000001144895807_p198131235115114"><a name="zh-cn_topic_0000001144895807_p198131235115114"></a><a name="zh-cn_topic_0000001144895807_p198131235115114"></a>调整定时器时振动器的振动效果。</p>
364</td>
365</tr>
366</tbody>
367</table>
368
369## VibratorStopMode<a name="zh-cn_topic_0000001144895807_section156137011615"></a>
370
371表示马达要停止指定的振动模式。
372
373<a name="zh-cn_topic_0000001144895807_table183851068715"></a>
374<table><thead align="left"><tr id="zh-cn_topic_0000001144895807_row23862069716"><th class="cellrowborder" valign="top" width="33.523352335233525%" id="mcps1.1.4.1.1"><p id="zh-cn_topic_0000001144895807_p1072910402072"><a name="zh-cn_topic_0000001144895807_p1072910402072"></a><a name="zh-cn_topic_0000001144895807_p1072910402072"></a>名称</p>
375</th>
376<th class="cellrowborder" valign="top" width="15.4015401540154%" id="mcps1.1.4.1.2"><p id="zh-cn_topic_0000001144895807_p1772910401718"><a name="zh-cn_topic_0000001144895807_p1772910401718"></a><a name="zh-cn_topic_0000001144895807_p1772910401718"></a>默认值</p>
377</th>
378<th class="cellrowborder" valign="top" width="51.07510751075108%" id="mcps1.1.4.1.3"><p id="zh-cn_topic_0000001144895807_p10729114015717"><a name="zh-cn_topic_0000001144895807_p10729114015717"></a><a name="zh-cn_topic_0000001144895807_p10729114015717"></a>说明</p>
379</th>
380</tr>
381</thead>
382<tbody><tr id="zh-cn_topic_0000001144895807_row5386186675"><td class="cellrowborder" valign="top" width="33.523352335233525%" headers="mcps1.1.4.1.1 "><p id="zh-cn_topic_0000001144895807_p1838614618717"><a name="zh-cn_topic_0000001144895807_p1838614618717"></a><a name="zh-cn_topic_0000001144895807_p1838614618717"></a>VIBRATOR_STOP_MODE_TIME</p>
383</td>
384<td class="cellrowborder" valign="top" width="15.4015401540154%" headers="mcps1.1.4.1.2 "><p id="zh-cn_topic_0000001144895807_p6821371787"><a name="zh-cn_topic_0000001144895807_p6821371787"></a><a name="zh-cn_topic_0000001144895807_p6821371787"></a>"time"</p>
385</td>
386<td class="cellrowborder" valign="top" width="51.07510751075108%" headers="mcps1.1.4.1.3 "><p id="zh-cn_topic_0000001144895807_p10386261671"><a name="zh-cn_topic_0000001144895807_p10386261671"></a><a name="zh-cn_topic_0000001144895807_p10386261671"></a>停止模式为duration模式的振动。即触发振动时参数类型为number,参数本身为指示振动持续时间的触发方式。</p>
387</td>
388</tr>
389<tr id="zh-cn_topic_0000001144895807_row8438152415720"><td class="cellrowborder" valign="top" width="33.523352335233525%" headers="mcps1.1.4.1.1 "><p id="zh-cn_topic_0000001144895807_p6446231085"><a name="zh-cn_topic_0000001144895807_p6446231085"></a><a name="zh-cn_topic_0000001144895807_p6446231085"></a>VIBRATOR_STOP_MODE_PRESET</p>
390</td>
391<td class="cellrowborder" valign="top" width="15.4015401540154%" headers="mcps1.1.4.1.2 "><p id="zh-cn_topic_0000001144895807_p178815321819"><a name="zh-cn_topic_0000001144895807_p178815321819"></a><a name="zh-cn_topic_0000001144895807_p178815321819"></a>"preset"</p>
392</td>
393<td class="cellrowborder" valign="top" width="51.07510751075108%" headers="mcps1.1.4.1.3 "><p id="zh-cn_topic_0000001144895807_p1219354892816"><a name="zh-cn_topic_0000001144895807_p1219354892816"></a><a name="zh-cn_topic_0000001144895807_p1219354892816"></a>停止模式为预置EffectId的振动。即触发振动时参数类型为EffectId,参数本身为指示马达振动效果的字符串的触发方式。</p>
394</td>
395</tr>
396</tbody>
397</table>
398
399