Struct SoundGroup

pub struct SoundGroup { /* private fields */ }

An interface that manages Sound Groups.

Implementations

impl SoundGroup

pub fn get_name(&self) -> Result<Utf8CString>

Retrieves the name of the sound group.

pub fn release(&self) -> Result<()>

Releases a soundgroup object and returns all sounds back to the master sound group.

You cannot release the master SoundGroup.

pub fn set_userdata(&self, userdata: *mut c_void) -> Result<()>

Sets the user data.

pub fn get_userdata(&self) -> Result<*mut c_void>

Retrieves user data.

pub fn get_system(&self) -> Result<System>

Retrieves the parent System object.

impl SoundGroup

pub fn set_max_audible(&self, max_audible: c_int) -> Result<()>

Sets the maximum number of playbacks to be audible at once in a sound group.

If playing instances of sounds in this group equal or exceed number specified here, attepts to play more of the sounds with be met with FMOD_RESULT::FMOD_ERR_MAXAUDIBLE by default. Use SoundGroup::set_max_audible_behavior to change the way the sound playback behaves when too many sounds are playing. Muting, failing and stealing behaviors can be specified. See SoundGroupBehavior.

SoundGroup::get_playing_count can be used to determine how many instances of the sounds in the SoundGroup are currently playing.

pub fn get_max_audible(&self) -> Result<c_int>

Retrieves the maximum number of playbacks to be audible at once in a sound group.

pub fn set_max_audible_behavior( &self, behavior: SoundGroupBehavior, ) -> Result<()>

This function changes the way the sound playback behaves when too many sounds are playing in a soundgroup.

pub fn get_max_audible_behavior(&self) -> Result<SoundGroupBehavior>

Retrieves the current max audible behavior.

pub fn set_mute_fade_speed(&self, speed: c_float) -> Result<()>

Sets a mute fade time.

If a mode besides SoundGroupBehavior::Mute is used, the fade speed is ignored.

When more sounds are playing in a SoundGroup than are specified with SoundGroup::set_max_audible, the least important Sound (ie lowest priority / lowest audible volume due to 3D position, volume etc) will fade to silence if SoundGroupBehavior::Mute is used, and any previous sounds that were silent because of this rule will fade in if they are more important.

pub fn get_mute_fade_speed(&self) -> Result<c_float>

Retrieves the current mute fade time.

pub fn set_volume(&self, volume: c_float) -> Result<()>

Sets the volume of the sound group.

pub fn get_volume(&self) -> Result<c_float>

Retrieves the volume of the sound group.

impl SoundGroup

pub fn get_sound_count(&self) -> Result<c_int>

Retrieves the current number of sounds in this sound group.

pub fn get_sound(&self, index: c_int) -> Result<Sound>

Retrieves a sound.

Use SoundGroup::get_sound_count in conjunction with this function to enumerate all sounds in a SoundGroup.

pub fn get_playing_count(&self) -> Result<c_int>

Retrieves the number of currently playing Channels for the SoundGroup.

This routine returns the number of Channels playing. If the SoundGroup only has one Sound, and that Sound is playing twice, the figure returned will be two.

pub fn stop(&self) -> Result<()>

Stops all sounds within this soundgroup.

impl SoundGroup

pub unsafe fn from_ffi(value: *mut FMOD_SOUNDGROUP) -> Self

Safety

value must be a valid pointer either aquired from Self::as_ptr or FMOD.

Panics

Panics if value is null.

pub fn as_ptr(self) -> *mut FMOD_SOUNDGROUP

Converts self into its raw representation.

Trait Implementations

impl Clone for SoundGroup

fn clone(&self) -> SoundGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SoundGroup

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

Formats the value using the given formatter.

impl From<SoundGroup> for *mut FMOD_SOUNDGROUP

fn from(value: SoundGroup) -> Self

Converts to this type from the input type.

impl Hash for SoundGroup

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SoundGroup

fn eq(&self, other: &SoundGroup) -> 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 Copy for SoundGroup

impl Eq for SoundGroup

impl Send for SoundGroup

Available on non-crate feature thread-unsafe only.

impl StructuralPartialEq for SoundGroup

impl Sync for SoundGroup

Available on non-crate feature thread-unsafe only.