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,
  bool passThru
);

C Syntax

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

C# Syntax

RESULT System.attachChannelGroupToPort(
  uint portType,
  ulong portIndex,
  ChannelGroup channelgroup,
  bool passThru = false
);

JavaScript Syntax

System.attachChannelGroupToPort(
  portType,                        
  portIndex,                       
  channelgroup,                    
  passThru                         
);

Parameters

portType

Output driver specific audio port type. See extra platform specific header (if it exists) for port numbers, i.e. fmod_psvita.h, fmod_wiiu.h, fmodorbis.h

portIndex

Output driver specific index of the audio port

channelgroup

Channel group to route away to the new port

passThru

If true the signal will continue to be passed through to the main mix, if false the signal will be entirely to the designated 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

Note that an FMOD port is a hardware specific reference, to hardware devices that exist on only certain platforms (like a console headset, or dedicated hardware music channel for example). It is not supported on all platforms.

See Also

• System::detachChannelGroupFromPort

Version 1.10.03 Built on Feb 1, 2018