Enum Api

#[repr(i32)]
pub enum Api {
    Unspecified = 0,
    MacOSXCore = 1,
    LinuxALSA = 2,
    UnixJack = 3,
    LinuxPulse = 4,
    LinuxOSS = 5,
    WindowsASIO = 6,
    WindowsWASAPI = 7,
    WindowsDS = 8,
    Dummy = 9,
}

Variants

Unspecified = 0

Search for a default working compiled API.

MacOSXCore = 1

Macintosh OS-X Core Audio API.

LinuxALSA = 2

The Advanced Linux Sound Architecture API.

UnixJack = 3

The Jack Low-Latency Audio Server API.

LinuxPulse = 4

The Linux PulseAudio API.

LinuxOSS = 5

The Linux Open Sound System API.

WindowsASIO = 6

The Steinberg Audio Stream I/O API.

WindowsWASAPI = 7

The Microsoft WASAPI API.

WindowsDS = 8

The Microsoft DirectSound API.

Dummy = 9

A compilable but non-functional API.

Implementations

impl Api

pub fn get_name(&self) -> String

Get the short lower-case name used for identification purposes.

This value is guaranteed to remain identical across library versions.

If the API is unknown, this will return None.

pub fn get_display_name(&self) -> String

Get the display name for the given API.

If the API is unknown, this will return None.

Examples found in repository

examples/enumerate.rs (line 5)

fn main() {
    dbg!(rtaudio::version());

    for api in rtaudio::compiled_apis() {
        dbg!(api.get_display_name());

        match rtaudio::Host::new(api) {
            Ok(rt) => {
                for device_info in rt.iter_devices() {
                    dbg!(device_info);
                }
            }
            Err(e) => {
                eprintln!("{}", e);
            }
        }

        println!("---------------------------------------------");
    }
}

pub fn from_name(name: &str) -> Option<Api>

Retrieve the API by its name (as given in Api::get_name()).

pub fn from_raw(a: rtaudio_api_t) -> Option<Api>

pub fn to_raw(&self) -> rtaudio_api_t

Trait Implementations

impl Clone for Api

fn clone(&self) -> Api

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Api

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for Api

fn cmp(&self, other: &Api) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Api

fn eq(&self, other: &Api) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Api

fn partial_cmp(&self, other: &Api) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Api

impl Eq for Api

impl StructuralPartialEq for Api