libpulse-binding 2.2.0

A Rust language binding for the PulseAudio libpulse 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

//! Define version.

// This file is part of the PulseAudio Rust language binding.
//
// Copyright (c) 2017 Lyndon Brown
//
// This library is free software; you can redistribute it and/or modify it under the terms of the
// GNU Lesser General Public License as published by the Free Software Foundation; either version
// 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
// even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License along with this library;
// if not, see <http://www.gnu.org/licenses/>.

use capi;
use std::ffi::CStr;

/// The version of the PulseAudio client library this binding is targetted at.
pub const BINDING_TARGET_VERSION: &str = "12.0.0";

#[inline(always)]
pub fn get_headers_version() -> &'static str {
    BINDING_TARGET_VERSION
}

/// The current API version. Please note that this is only ever increased on incompatible API
/// changes!
pub const API_VERSION: u8 = 12;

/// The current protocol version.
pub const PROTOCOL_VERSION: u16 = 32;

/// The major version of PA.
pub const MAJOR: u8 = 12;

/// The minor version of PA.
pub const MINOR: u8 = 0;

/// The micro version of PA (will always be 0 from v1.0 onwards).
pub const MICRO: u8 = 0;

/// Returns the version of the library the current application is linked to.
pub fn get_library_version() -> &'static CStr {
    unsafe { CStr::from_ptr(capi::pa_get_library_version()) }
}

/// Evaluates to true if the PulseAudio library version targeted by this version of the PA binding
/// library is equal or newer than the version specified.
pub fn check_version(major: u8, minor: u8, micro: u8) -> bool {
    ((MAJOR  > major) ||
     (MAJOR == major && MINOR  > minor) ||
     (MAJOR == major && MINOR == minor && MICRO >= micro))
}