Channel::getPriority

FMOD Studio API

Firelight Technologies FMOD Studio API

Channel::getPriority

Retrieves the priority for the channel.

C++ Syntax

FMOD_RESULT Channel::getPriority(
  int *priority
);

C Syntax

FMOD_RESULT FMOD_Channel_GetPriority(
  FMOD_CHANNEL *channel,
  int *priority
);

C# Syntax

RESULT Channel.getPriority(
  out int priority
);

JavaScript Syntax

Channel.getPriority(
  priority                         // writes value to priority.val
);

Parameters

priority
Address of a variable that receives the priority for the channel, from 0 (most important) to 256 (least important).

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.10.03 Built on Feb 1, 2018