alsatimer 0.8.0

API binding for alsatimer library
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

// SPDX-License-Identifier: MIT
use super::*;

/// Get the list of existent timer device.
///
/// The call of function executes `open(2)`, `close(2)`, and `ioctl(2)` system call with
/// `SNDRV_TIMER_IOCTL_NEXT_DEVICE` command for ALSA timer character device.
///
/// # Returns
///
/// [`true`] when the overall operation finishes successfully, else [`false`].
///
/// ## `entries`
/// The array with entries of [`DeviceId`][crate::DeviceId].
#[doc(alias = "alsatimer_get_device_id_list")]
pub fn device_id_list() -> Result<Vec<DeviceId>, glib::Error> {
    unsafe {
        let mut entries = std::ptr::null_mut();
        let mut error = std::ptr::null_mut();

        ffi::alsatimer_get_device_id_list(&mut entries, &mut error);

        if error.is_null() {
            Ok(FromGlibPtrContainer::from_glib_full(entries))
        } else {
            Err(from_glib_full(error))
        }
    }
}

/// Set the given parameters to the timer indicated by the identifier.
///
/// The call of function executes `open(2)`, `close(2)`, and `ioctl(2)` system call with
/// `SNDRV_TIMER_IOCTL_GPARAMS` command for ALSA timer character device.
/// ## `device_id`
/// A [`DeviceId`][crate::DeviceId] to identify the timer device.
/// ## `device_params`
/// The parameters of timer device.
///
/// # Returns
///
/// [`true`] when the overall operation finishes successfully, else [`false`].
#[doc(alias = "alsatimer_set_device_params")]
pub fn set_device_params(
    device_id: &mut DeviceId,
    device_params: &DeviceParams,
) -> Result<(), glib::Error> {
    unsafe {
        let mut error = std::ptr::null_mut();

        ffi::alsatimer_set_device_params(
            device_id.to_glib_none_mut().0,
            device_params.to_glib_none().0,
            &mut error,
        );

        if error.is_null() {
            Ok(())
        } else {
            Err(from_glib_full(error))
        }
    }
}

/// Get the status of timer device.
///
/// The call of function executes `open(2)`, `close(2)`, and `ioctl(2)` system call with
/// `SNDRV_TIMER_IOCTL_GSTATUS` command for ALSA timer character device.
/// ## `device_id`
/// A [`DeviceId`][crate::DeviceId] to identify the timer device.
/// ## `device_status`
/// The status of timer device.
///
/// # Returns
///
/// [`true`] when the overall operation finishes successfully, else [`false`].
#[doc(alias = "alsatimer_get_device_status")]
pub fn device_status<P: IsA<DeviceStatus>>(
    device_id: &mut DeviceId,
    status: &mut P,
) -> Result<(), glib::Error> {
    unsafe {
        let mut error = std::ptr::null_mut();

        ffi::alsatimer_get_device_status(
            device_id.to_glib_none_mut().0,
            &mut status.as_ref().to_glib_none().0,
            &mut error,
        );

        if error.is_null() {
            Ok(())
        } else {
            Err(from_glib_full(error))
        }
    }
}