Firelight Technologies FMOD Studio API

Channel::getIndex

Retrieves the internal channel index for a channel.

C++ Syntax

FMOD_RESULT Channel::getIndex(
  int *index
);

C Syntax

FMOD_RESULT FMOD_Channel_GetIndex(
  FMOD_CHANNEL *channel,
  int *index
);

Parameters

index
Address of a variable to receive the channel index. This will be from 0 to the value specified in System::init minus 1.

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




Version 1.03.06 Built on Apr 17, 2014