xplane 0.1.0-alpha.1

High-level interfaces to the X-Plane plugin SDK
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

// SPDX-FileCopyrightText: 2024 Julia DeMille <me@jdemille.com>
//
// SPDX-License-Identifier: MPL-2.0

use libfmod::{ChannelGroup, Studio};
use xplane_sys::{XPLMAudioBus, XPLMGetFMODChannelGroup, XPLMGetFMODStudio};

use crate::NoSendSync;

/// Access struct for X-Plane's sound APIs.
pub struct SoundApi {
    pub(crate) _phantom: NoSendSync,
}

impl SoundApi {
    #[must_use]
    /// Get the Fmod Studio system used by X-Plane.
    pub fn fmod_studio(&mut self) -> Studio {
        let sys = unsafe { XPLMGetFMODStudio() };
        Studio::from(sys.cast())
    }

    #[must_use]
    /// Get the Fmod channel group corresponding to `bus`.
    /// If `bus` is not valid, [`None`] will be returned.
    pub fn fmod_channel_group(&mut self, bus: XPLMAudioBus) -> Option<ChannelGroup> {
        if audio_bus_valid(bus) {
            let cg = unsafe { XPLMGetFMODChannelGroup(bus) };
            Some(ChannelGroup::from(cg.cast()))
        } else {
            None
        }
    }
}

#[inline]
fn audio_bus_valid(bus: XPLMAudioBus) -> bool {
    matches!(
        bus,
        XPLMAudioBus::RadioCom1
            | XPLMAudioBus::RadioCom2
            | XPLMAudioBus::RadioPilot
            | XPLMAudioBus::RadioCopilot
            | XPLMAudioBus::ExteriorAircraft
            | XPLMAudioBus::ExteriorEnvironment
            | XPLMAudioBus::ExteriorUnprocessed
            | XPLMAudioBus::Interior
            | XPLMAudioBus::UI
            | XPLMAudioBus::Ground
            | XPLMAudioBus::Master
    )
}