fmod-oxide 0.2.1

Zero cost bindings to FMOD and FMOD Studio
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

// Copyright (c) 2024 Melody Madeline Lyons
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

use fmod_sys::*;
use std::ffi::c_int;

use crate::{FmodResultExt, Result};
use crate::{Sound, SoundGroup};

#[cfg(doc)]
use crate::Channel;

impl SoundGroup {
    /// Retrieves the current number of sounds in this sound group.
    pub fn get_sound_count(&self) -> Result<c_int> {
        let mut count = 0;
        unsafe { FMOD_SoundGroup_GetNumSounds(self.inner.as_ptr(), &raw mut count).to_result()? };
        Ok(count)
    }

    /// Retrieves a sound.
    ///
    /// Use [`SoundGroup::get_sound_count`] in conjunction with this function to enumerate all sounds in a [`SoundGroup`].
    pub fn get_sound(&self, index: c_int) -> Result<Sound> {
        let mut sound = std::ptr::null_mut();
        unsafe {
            FMOD_SoundGroup_GetSound(self.inner.as_ptr(), index, &raw mut sound).to_result()?;
            Ok(Sound::from_ffi(sound))
        }
    }

    /// Retrieves the number of currently playing [`Channel`]s for the [`SoundGroup`].
    ///
    /// This routine returns the number of [`Channel`]s playing.
    /// If the [`SoundGroup`] only has one [`Sound`], and that [`Sound`] is playing twice, the figure returned will be two.
    pub fn get_playing_count(&self) -> Result<c_int> {
        let mut count = 0;
        unsafe { FMOD_SoundGroup_GetNumPlaying(self.inner.as_ptr(), &raw mut count).to_result()? };
        Ok(count)
    }

    /// Stops all sounds within this soundgroup.
    pub fn stop(&self) -> Result<()> {
        unsafe { FMOD_SoundGroup_Stop(self.inner.as_ptr()).to_result() }
    }
}