A sound group allows you to categorize a series of SoundSource Object and consolidate them together into a single group. Once in a sound group, all SoundSource additional functionalities are available such as controlling their playback state them all at once using a single function call.

To visually identify all members of a SoundGroup a unique color can be specified and will be used as highlight inside the 3d viewport. In addition the visibility of all the group members can be toggled on or off quickly all at once in a similar fashion as the playback controls.

See Also

Static Variables

Name	Description
`scene`	Parent Scene where the SoundGroup is defined.
Declaration Scene *scene
`soundsource_count`	Total amount of SoundSource contained in the SoundGroup.
Declaration Declaration unsigned short soundsource_count
`uid`	Unique id to identify the SoundGroup globally.
Declaration unsigned int uid

Variables

Name	Description
`option`	PresetOption to apply to the SoundGroup.
Declaration PresetOption option
`name`	Unique name to identify the SoundGroup within its parent Scene.
Declaration char *name
`gain`	Amount of gain applied to the SoundGroup.
Declaration float gain Range 0.0 to 1.0
`color`	Color to visually identify the SoundSource that belongs to the active SoundGroup within the editor 3d viewport.
Declaration vec4 color

Functions

Name	Description
`Play`	Start the playback of all SoundSource contained in the current SoundGroup.
Declaration void Play( void )
`Pause`	Pause all SoundSource contained in the SoundGroup.
Declaration void Pause( void )
`Stop`	Stop the playback of all SoundSource contained in the active SoundGroup.
Declaration void Stop( void )
`AddSoundSource`	Append a new SoundSource to the active SoundGroup.
Declaration bool AddSoundSource( SoundSource soundsource ) Parameters* `soundsource`: Reference to an existing SoundSource. If the SoundSource belongs to another SoundGroup it will be transfered to the active one automatically. Return Value `true` if the SoundSource have succesffuly been added to the current SoundGroup; `false` if either the reference is invalid or if the SoundSource is already associated to the current SoundGroup.
`GetSoundSource`	Retrieve the reference of a SoundSource connected to the active SoundGroup by name.
Declaration SoundSource GetSoundSource( const char name ) Parameters `name`: The name of the SoundSource to retrieve. Return Value `nil` if no SoundSource connected to the active SoundGroup match the name provided in parameter. On success; return the reference to the SoundSource.
`GetSoundSourceAt`	Retrieve a specific SoundSource maintained by the active SoundGroup by index.
Declaration SoundSource GetSoundSourceAt( unsigned short index ) Parameters* `index`: Index of the SoundSource reference to retrieve. Return Value `nil` the index provided is invalid; else return the reference of the SoundSource for the matching index.
`GetSoundSourceIndex`	Return the internal index of a specific SoundSource connected to the current SoundGroup.
Declaration int GetSoundSourceIndex( const SoundSource soundsource ) Parameters* `soundsource`: Reference to a SoundSource connected to the active SoundGroup. Return Value `-1` if the reference provided is invalid or is not associated to the current SoundGroup; else return the internal index of reference provided to the function.
`RemoveSoundSource`	Remove a SoundSource from the active SoundGroup.
Declaration bool RemoveSoundSource( SoundSource soundsource ) Parameters* `soundsource`: The SoundSource reference to remove. Return Value `true` if the reference have been disconnected from the active SoundGroup; else return `false` if the reference is invalid or if it is not part of the active SoundGroup.
`RemoveSoundSourceAt`	Remove a specific SoundSource from the group using its index.
Declaration bool RemoveSoundSourceAt( int index ) Parameters `index`: Index of the SoundSource to remove. Return Value `false` if the index provided is out of scope; else return `true` if the element have been removed from the active SoundGroup.
`SelectAll`	Select all SoundSource Object contained in the active SoundGroup.
Declaration void SelectAll( void )
`DeselectAll`	Deselect all SoundSource contained in the active SoundGroup.
Declaration void DeselectAll( void )
`IsSelected`	Helper that returns wheter or not all SoundSource associated with the active SoundGroup are selected.
Declaration bool IsSelected( void ) Return Value `true` if all SoundSource Object connected to the active SoundGroup are selected; else return `false`.
`ShowAll`	Toggle the visibility of all SoundSource connected to the active SoundGroup.
Declaration void ShowAll( void )
`HideAll`	Hide all SoundSource contained in the current SoundGroup.
Declaration void HideAll( void )
`IsVisible`	Helper function that returns wheter or not all SoundSource connected to the active SoundGroup are visible or not.
Declaration bool IsVisible( void ) Return Value `true` if all SoundSource are visible; else return `false`.

PresetOption

List of all available preset options.

kNothing: No special present option is applied.
kMute: Override any gain settings applied and set the volume to 0%.
kSolo: Override any gain settings applied and crank up the volume to 100%.
kBypass: Override all gain settings and use the current value assigned to the SoundSource or SoundGroup.