Struct ChannelGroup 

pub struct ChannelGroup { /* private fields */ }

Implementations

impl ChannelGroup

pub fn is_master(&self) -> Result<bool, Error>

pub fn raw(&self) -> *mut FMOD_CHANNELGROUP

pub fn channel_group_ref(&self) -> ChannelGroupRef

pub fn get_channel(&self, index: i32) -> Result<Channel, Error>

Retrieves the specified channel from the channel group for the index from 0 to the number of channels returned by channel_group.get_num_channels()

pub fn get_group(&self, index: i32) -> Result<ChannelGroupRef, Error>

Retrieves a handle to a specified sub channel group

pub fn get_name(&self) -> Result<String, Error>

pub fn get_num_channels(&self) -> Result<i32, Error>

pub fn get_num_groups(&self) -> Result<i32, Error>

pub fn get_parent_group(&self) -> Result<Option<ChannelGroupRef>, Error>

Retrieves a handle to the channel group parent.

Returns None if this is the master channel group.

Trait Implementations

impl ChannelControl for ChannelGroup

fn add_dsp(&mut self, index: i32, dsp: &mut Dsp) -> Result<(), Error>

Add a DSP to the DSP chain at the given index. Index must be a position in the range $[0, numDSPs]$, or else one of the special indices:

• DspIndex::Head == -1 – head of the chain; always equal to 0
• DspIndex::Fader == -2 – built-in fader DSP; initially 0
• DspIndex::Tail == -3 – tail of the chain; equal to $numDSPs-1$

Errors

An InvalidParam error will be returned if index > self.get_num_dsps().

fn get_3d_cone_settings(&self) -> Result<(f32, f32, f32), Error>

Retrieves the angles that define the sound projection cone including the volume when outside the cone.

Returns (insideconeangle, outsideconeangle, outsidevolume).

fn get_3d_distance_filter(&self) -> Result<(bool, f32, f32), Error>

Retrieve the settings for the 3D distance filter properties for a Channel or Channel Group.

Returns (custom, customlevel, centerfreq).

fn get_3d_min_max_distance(&self) -> Result<(f32, f32), Error>

Retrieves the minimum and maximum audible distance

fn get_3d_occlusion(&self) -> Result<(f32, f32), Error>

Retrieves the occlusion factors.

Returns (directocclusion, reverbocclusion).

fn get_3d_spread(&self) -> Result<f32, Error>

Retrieves the spread of a 3D sound in speaker space.

Returns the speaker spread angle.

fn get_dsp(&self, index: i32) -> Result<DspRef, Error>

Retrieve the DSP unit at the specified index

fn get_dsp_clock(&self) -> Result<u64, Error>

DSP clock value for the head DSP node

fn get_dsp_clock_parent(&self) -> Result<u64, Error>

DSP clock value for the tail DSP node

fn get_dsp_index(&self, dsp: &Dsp) -> Result<i32, Error>

Retrieve the index in the DSP chain of the provided DSP

fn get_num_dsps(&self) -> Result<u32, Error>

Retrieves the number of DSP units in the DSP chain

fn get_reverb_properties(&self, instance: i32) -> Result<f32, Error>

Retrieves the wet level (or send level) for a particular reverb instance.

Returns the send level for the signal to the reverb, from 0 (none) to 1.0 (full).

instance – Index of the particular reverb instance to target, from 0 to dsp::REVERB_MAXINSTANCES.

fn add_fade_point(&mut self, dspclock: u64, volume: f32) -> Result<(), Error>

fn get_3d_attributes(&self) -> Result<([f32; 3], [f32; 3]), Error>

fn get_3d_cone_orientation(&self) -> Result<[f32; 3], Error>

fn get_3d_custom_rolloff(&self) -> Result<Vec<[f32; 3]>, Error>

fn get_3d_doppler_level(&self) -> Result<f32, Error>

fn get_audibility(&self) -> Result<f32, Error>

fn get_delay(&self) -> Result<Delay, Error>

fn get_low_pass_gain(&self) -> Result<f32, Error>

fn get_mode(&self) -> Result<Mode, Error>

fn get_mute(&self) -> Result<bool, Error>

fn get_paused(&self) -> Result<bool, Error>

fn get_volume(&self) -> Result<f32, Error>

fn is_playing(&self) -> Result<bool, Error>

fn remove_dsp(&mut self, dsp: &mut Dsp) -> Result<(), Error>

fn set_3d_attributes( &mut self, pos: [f32; 3], vel: [f32; 3], ) -> Result<(), Error>

fn set_delay( &mut self, dspclock_start: u64, dspclock_end: u64, stopchannels: bool, ) -> Result<(), Error>

fn set_fade_point_ramp( &mut self, dspclock: u64, volume: f32, ) -> Result<(), Error>

fn set_mute(&mut self, mute: bool) -> Result<(), Error>

fn set_paused(&mut self, paused: bool) -> Result<(), Error>

fn set_reverb_properties( &mut self, instance: i32, wet: f32, ) -> Result<(), Error>

Set the wet level of a reverb instance.

fn set_volume(&mut self, volume: f32) -> Result<(), Error>

fn stop(&mut self) -> Result<(), Error>

impl Clone for ChannelGroup

fn clone(&self) -> ChannelGroup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelGroup

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

Formats the value using the given formatter.

impl PartialEq for ChannelGroup

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