-
Notifications
You must be signed in to change notification settings - Fork 3
channel_group
FMOD Object: ChannelGroup
This module contains functionality related to Channel Groups, which are submixes in the mixing hierarchy akin to buses that can contain both Channel and ChannelGroup objects.
This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.
- fmod_channel_group_get_num_channels
- fmod_channel_group_get_channel
- fmod_channel_group_add_group
- fmod_channel_group_get_num_groups
- fmod_channel_group_get_group
- fmod_channel_group_get_parent_group
- fmod_channel_set_channel_group
- fmod_channel_get_channel_group
- fmod_channel_group_get_name
- fmod_channel_group_release
- fmod_channel_group_get_system_object
FMOD Function: Channel::setChannelGroup
This function sets the channelgroup this object outputs to.
Note
A channelgroup may contain many channels.
Note
Channels may only output to a single channelgroup. This operation will remove it from the previous group first.
Syntax:
fmod_channel_set_channel_group(channel_ref, channel_group_ref)
| Argument | Type | Description |
|---|---|---|
| channel_ref | Real | A reference to a channel. |
| channel_group_ref | Real | A reference to the channelgroup to use as the output group. |
Returns:
N/A
FMOD Function: Channel::getChannelGroup
This function retrieves the ChannelGroup this object outputs to.
Syntax:
fmod_channel_get_channel_group(channel_ref)
| Argument | Type | Description |
|---|---|---|
| channel_ref | Real | A reference to a channel. |
Returns:
FMOD Function: ChannelGroup::getNumChannels
This function retrieves the number of Channels that feed into this group.
Syntax:
fmod_channel_group_get_num_channels(channel_group_ref)
| Argument | Type | Description |
|---|---|---|
| channel_group_ref | Real | A reference to a ChannelGroup. |
Returns:
FMOD Function: ChannelGroup::getChannel
This function retrieves the Channel at the specified index in the list of Channel inputs.
The function returns a reference to the Channel.
Syntax:
fmod_channel_group_get_channel(channel_group_ref, index)
| Argument | Type | Description |
|---|---|---|
| channel_group_ref | Real | A reference to a ChannelGroup. |
| index | Real | The offset into the list of Channel inputs. |
Returns:
FMOD Function: ChannelGroup::addGroup
This function adds a ChannelGroup as an input to this group.
The function returns a reference to the DSPConnection created between the head DSP of child_channel_group_ref and the tail DSP of channel_group_ref.
Syntax:
fmod_channel_group_add_group(channel_group_ref, child_channel_group_ref, propagate_dsp_clock)
| Argument | Type | Description |
|---|---|---|
| channel_group_ref | Real | A reference to a ChannelGroup. |
| child_channel_group_ref | Real | The ChannelGroup to add. |
| propagate_dsp_clock | Boolean | Whether to recursively propagate this object's clock values to child_channel_group_ref. |
Returns:
FMOD Function: ChannelGroup::getNumGroups
This function retrieves the number of ChannelGroups that feed into to this group.
Syntax:
fmod_channel_group_get_num_groups(channel_group_ref)
| Argument | Type | Description |
|---|---|---|
| channel_group_ref | Real | A reference to a ChannelGroup. |
Returns:
FMOD Function: ChannelGroup::getGroup
This function retrieves the ChannelGroup at the specified index in the list of group inputs.
Syntax:
fmod_channel_group_get_group(channel_group_ref, group_index)
| Argument | Type | Description |
|---|---|---|
| channel_group_ref | Real | A reference to a ChannelGroup. |
| group_index | Real | The offset into the list of group inputs. A value in the range [0, fmod_channel_group_get_num_groups]. |
Returns:
FMOD Function: ChannelGroup::getParentGroup
This function retrieves the ChannelGroup this object outputs to.
Syntax:
fmod_channel_group_get_parent_group(channel_group_ref)
| Argument | Type | Description |
|---|---|---|
| channel_group_ref | Real | A reference to a ChannelGroup. |
Returns:
FMOD Function: ChannelGroup::getName
This function retrieves the name set when the group was created.
Syntax:
fmod_channel_group_get_name(channel_group_ref)
| Argument | Type | Description |
|---|---|---|
| channel_group_ref | Real | A reference to a ChannelGroup. |
Returns:
FMOD Function: ChannelGroup::release
This function frees the memory for the group.
Note
Any Channels or ChannelGroups feeding into this group are moved to the master ChannelGroup.
Syntax:
fmod_channel_group_release(channel_group_ref)
| Argument | Type | Description |
|---|---|---|
| channel_group_ref | Real | A reference to a ChannelGroup. |
Returns:
FMOD Function: ChannelControl::getSystemObject
This function retrieves the System that created this object.
Syntax:
fmod_channel_group_get_system_object(channel_group_ref)
| Argument | Type | Description |
|---|---|---|
| channel_group_ref | Real | A reference to a ChannelGroup. |
Returns:
YoYoGames 2024