Firelight Technologies FMOD Studio API

ChannelGroup::getChannel

Retrieves the specified channel from the channel group.

C++ Syntax

FMOD_RESULT ChannelGroup::getChannel(
  int index,
  FMOD::Channel **channel
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetChannel(
  FMOD_CHANNELGROUP *channelgroup,
  int index,
  FMOD_CHANNEL **channel
);

C# Syntax

RESULT ChannelGroup.getChannel(
  int index,
  out Channel channel
);

JavaScript Syntax

ChannelGroup.getChannel(
  index,                           
  channel                          // writes value to channel.val
);

Parameters

index

Index of the channel inside the channel group, from 0 to the number of channels returned by ChannelGroup::getNumChannels.

channel

Address of a variable to receieve a pointer to a channel.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

See Also

• ChannelGroup::getNumChannels
• System::getMasterChannelGroup
• System::createChannelGroup

Version 1.10.03 Built on Feb 1, 2018