Firelight Technologies FMOD Studio API

Channel::getFrequency

Retrieves the channel frequency or playback rate, in Hz.

C++ Syntax

FMOD_RESULT Channel::getFrequency(
  float *frequency
);

C Syntax

FMOD_RESULT FMOD_Channel_GetFrequency(
  FMOD_CHANNEL *channel,
  float *frequency
);

C# Syntax

RESULT Channel.getFrequency(
  out float frequency
);

JavaScript Syntax

Channel.getFrequency(
  frequency                        // writes value to frequency.val
);

Parameters

frequency

Address of a variable that receives the current frequency of the channel in Hz.

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

• Channel::setFrequency

Version 1.10.03 Built on Feb 1, 2018