Firelight Technologies FMOD Studio API

System::getChannel

Retrieves a handle to a channel by ID.

C++ Syntax

FMOD_RESULT System::getChannel(
  int channelid,
  FMOD::Channel **channel
);

C Syntax

FMOD_RESULT FMOD_System_GetChannel(
  FMOD_SYSTEM *system,
  int channelid,
  FMOD_CHANNEL **channel
);

C# Syntax

RESULT System.getChannel(
  int channelid,
  out Channel channel
);

JavaScript Syntax

System.getChannel(
  channelid,                       
  channel                          // writes value to channel.val
);

Parameters

channelid

Index in the FMOD channel pool. Specify a channel number from 0 to the 'maxchannels' value specified in System::init minus 1.

channel

Address of a variable that receives a pointer to the requested 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.

Remarks

This function is mainly for getting handles to existing (playing) channels and setting their attributes.

See Also

• System::playSound
• System::init

Version 1.10.03 Built on Feb 1, 2018