ohos-sensors-sys 0.1.0

Rust bindings to the sensors and vibrator modules of OpenHarmony
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

// automatically generated by rust-bindgen 0.71.1

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
use crate::vibrator_type::*;

extern "C" {
    /// Controls the vibrator to vibrate continuously for a given duration.
    ///
    /// # Arguments
    ///
    /// * `duration` - - Vibration duration, in milliseconds.
    ///
    /// * `attribute` - - Vibration attribute. For details, see [`Vibrator_Attribute`].
    ///
    /// # Returns
    ///
    /// * Returns <b>0</b> if the operation is successful; returns the following error code otherwise.
    /// [`PERMISSION_DENIED`] Permission verification failed.
    ///
    /// [`PARAMETER_ERROR`] Parameter check failed. For example, the parameter is invalid,
    /// or the parameter type passed in is incorrect.
    ///
    /// [`UNSUPPORTED`] The API is not supported on the device. The device supports the corresponding SysCap,
    /// but does not support certain APIs in this SysCap.
    ///
    /// [`DEVICE_OPERATION_FAILED`] The operation on the device failed.
    ///
    /// ohos.permission.VIBRATE
    ///
    ///
    /// Available since API-level: 11
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_Vibrator_PlayVibration(duration: i32, attribute: Vibrator_Attribute) -> i32;
    /// Controls the vibrator to vibrate with the custom sequence.
    ///
    /// # Arguments
    ///
    /// * `fileDescription` - - File descriptor of the custom vibration effect.
    /// For details, see [`Vibrator_FileDescription`].
    ///
    /// * `vibrateAttribute` - - Vibration attribute. For details, see [`Vibrator_Attribute`].
    ///
    /// # Returns
    ///
    /// * Returns <b>0</b> if the operation is successful; returns the following error code otherwise.
    /// [`PERMISSION_DENIED`] Permission verification failed.
    ///
    /// [`PARAMETER_ERROR`] Parameter check failed. For example, the parameter is invalid,
    /// or the parameter type passed in is incorrect.
    ///
    /// [`UNSUPPORTED`] The API is not supported on the device. The device supports the corresponding SysCap,
    /// but does not support certain APIs in this SysCap.
    ///
    /// [`DEVICE_OPERATION_FAILED`] The operation on the device failed.
    ///
    /// ohos.permission.VIBRATE
    ///
    ///
    /// Available since API-level: 11
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_Vibrator_PlayVibrationCustom(
        fileDescription: Vibrator_FileDescription,
        vibrateAttribute: Vibrator_Attribute,
    ) -> i32;
    /// Stop the motor vibration according to the input mode.
    ///
    /// ohos.permission.VIBRATE
    ///
    /// # Returns
    ///
    /// * Returns <b>0</b> if the operation is successful; returns the following error code otherwise.
    /// [`PERMISSION_DENIED`] Permission verification failed.
    ///
    /// [`UNSUPPORTED`] The API is not supported on the device. The device supports the corresponding SysCap,
    /// but does not support certain APIs in this SysCap.
    ///
    /// [`DEVICE_OPERATION_FAILED`] The operation on the device failed.
    ///
    /// ohos.permission.VIBRATE
    ///
    ///
    /// Available since API-level: 11
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_Vibrator_Cancel() -> i32;
}