Firelight Technologies FMOD Studio API

Channel::getPaused

Retrieves the paused state.

C++ Syntax

FMOD_RESULT Channel::getPaused(
  bool *paused
);

C Syntax

FMOD_RESULT FMOD_Channel_GetPaused(
  FMOD_CHANNEL *channel,
  FMOD_BOOL *paused
);

C# Syntax

RESULT Channel.getPaused(
  out bool paused
);

JavaScript Syntax

Channel.getPaused(
  paused                           // writes value to paused.val
);

Parameters

paused

Address of a variable that receives the current paused state, true = paused, false = not paused.

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

• ChannelControl::setPaused

Version 1.10.03 Built on Feb 1, 2018