ohaudio-sys 0.1.0

Raw Bindings to the audio module 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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

// automatically generated by rust-bindgen 0.71.1

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
use crate::audio_common::{OH_AudioCommon_Result, OH_AudioScene};

/// Declare the audio manager.
/// The handle of audio manager is used for audio management related functions.
///
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
#[repr(C)]
pub struct OH_AudioManager {
    _unused: [u8; 0],
}
/// Prototype for the audio scene change function that is passed to
/// [`OH_AudioManager_RegisterAudioSceneChangeCallback`].
///
/// # Arguments
///
/// * `userData` - userdata which is passed by register.
///
/// * `scene` - the latest audio scene.
///
/// Available since API-level: 20
#[cfg(feature = "api-20")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
pub type OH_AudioManager_OnAudioSceneChangeCallback = ::core::option::Option<
    unsafe extern "C" fn(userData: *mut ::core::ffi::c_void, scene: OH_AudioScene),
>;
extern "C" {
    /// Get audio manager handle.
    ///
    /// # Arguments
    ///
    /// * `audioManager` - the [`OH_AudioManager`] handle received from this function.
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOCOMMON_RESULT_SUCCESS`] If the execution is successful.
    /// [`AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM`]:
    /// 1.The param of audioManager is nullptr;
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_GetAudioManager(audioManager: *mut *mut OH_AudioManager) -> OH_AudioCommon_Result;
    /// Get audio scene.
    ///
    /// # Arguments
    ///
    /// * `manager` - the [`OH_AudioManager`] handle received from [`OH_GetAudioManager`].
    ///
    /// * `scene` - the [`OH_AudioScene`] pointer to receive the result.
    ///
    /// # Returns
    ///
    /// * Function result code:
    /// [`AUDIOCOMMON_RESULT_SUCCESS`] If the execution is successful.
    /// [`AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM`]:
    /// 1.The param of audioManager is nullptr;
    /// 2.The param of scene is nullptr.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_GetAudioScene(
        manager: *mut OH_AudioManager,
        scene: *mut OH_AudioScene,
    ) -> OH_AudioCommon_Result;
    /// Register callback to receive audio scene changed events.
    ///
    /// # Arguments
    ///
    /// * `manager` - [`OH_AudioManager`] handle received from [`OH_GetAudioManager`].
    ///
    /// * `callback` - callback function which will be called when audio scene changed.
    ///
    /// * `userData` - pointer to a data structure that will be passed to the callback functions.
    ///
    /// # Returns
    ///
    /// * [`AUDIOCOMMON_RESULT_SUCCESS`] if the execution is successful
    /// [`AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM`]
    /// 1.param of manager is nullptr
    /// 2.param of callback is nullptr
    /// [`#AUDIOCOMMON_RESULT_ERROR_SYSTEM`] system process error occurs
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_AudioManager_RegisterAudioSceneChangeCallback(
        manager: *mut OH_AudioManager,
        callback: OH_AudioManager_OnAudioSceneChangeCallback,
        userData: *mut ::core::ffi::c_void,
    ) -> OH_AudioCommon_Result;
    /// Unregister audio scene change callback.
    ///
    /// # Arguments
    ///
    /// * `manager` - [`OH_AudioManager`] handle received from [`OH_GetAudioManager`].
    ///
    /// * `callback` - callback function which registered in [`OH_AudioManager_RegisterAudioSceneChangeCallback`].
    ///
    /// # Returns
    ///
    /// * [`AUDIOCOMMON_RESULT_SUCCESS`] if the execution is successful
    /// [`AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM`]
    /// 1.param of manager is nullptr
    /// 2.param of callback is nullptr
    /// [`#AUDIOCOMMON_RESULT_ERROR_SYSTEM`] system process error occurs
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_AudioManager_UnregisterAudioSceneChangeCallback(
        manager: *mut OH_AudioManager,
        callback: OH_AudioManager_OnAudioSceneChangeCallback,
    ) -> OH_AudioCommon_Result;
}