Firelight Technologies FMOD Studio API

ChannelGroup::setPaused

Sets the paused state.

C++ Syntax

FMOD_RESULT ChannelGroup::setPaused(
  bool paused
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_SetPaused(
  FMOD_CHANNELGROUP *channelgroup,
  FMOD_BOOL paused
);

C# Syntax

RESULT ChannelGroup.setPaused(
  bool paused
);

JavaScript Syntax

ChannelGroup.setPaused(
  paused                           
);

Parameters

paused

Paused state, true = paused, false = unpaused.

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

Each channel and channel group has its own paused state, pausing a channel group will pause all contained channels but will not affect their individual setting. Calling ChannelControl::getPaused will always return the value you set.

See Also

• ChannelControl::getPaused

Version 1.10.03 Built on Feb 1, 2018