1/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef _HARDWARE_VIBRATOR_H
18#define _HARDWARE_VIBRATOR_H
19
20#if __cplusplus
21extern "C" {
22#endif
23
24/**
25 * Return whether the device has a vibrator.
26 *
27 * @return 1 if a vibrator exists, 0 if it doesn't.
28 */
29int vibrator_exists();
30
31/**
32 * Turn on vibrator
33 *
34 * @param timeout_ms number of milliseconds to vibrate
35 *
36 * @return 0 if successful, -1 if error
37 */
38int vibrator_on(int timeout_ms);
39
40/**
41 * Turn off vibrator
42 *
43 * @return 0 if successful, -1 if error
44 */
45int vibrator_off();
46
47#if __cplusplus
48}  // extern "C"
49#endif
50
51#endif  // _HARDWARE_VIBRATOR_H
52