Firelight Technologies FMOD Studio API

System::attachChannelGroupToPort

Route the signal from a channel group into a seperate audio port on the output driver.

C++ Syntax

FMOD_RESULT System::attachChannelGroupToPort(
  FMOD_PORT_TYPE portType,
  FMOD_PORT_INDEX portIndex,
  FMOD::ChannelGroup *channelgroup
);

C Syntax

FMOD_RESULT FMOD_System_AttachChannelGroupToPort(
  FMOD_SYSTEM *system,
  FMOD_PORT_TYPE portType,
  FMOD_PORT_INDEX portIndex,
  FMOD_CHANNELGROUP *channelgroup
);

Parameters

portType
Output driver specific audio port type
portIndex
Output driver specific index of the audio port
channelgroup
Channel group to route away to the new port

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.

Remarks

No signal from the channelgroup will be played through the default output port.

See Also




Version 1.03.06 Built on Apr 17, 2014