Firelight Technologies FMOD Studio API

Studio::MixerStrip::setPaused

Sets the pause state of the MixerStrip.

C++ Syntax

FMOD_RESULT Studio::MixerStrip::setPaused(
  bool paused
);

C Syntax

FMOD_RESULT FMOD_Studio_MixerStrip_SetPaused(
  FMOD_STUDIO_MIXERSTRIP *mixerstrip,
  FMOD_BOOL paused
);

Parameters

paused

The desired pause state. true = pause, false = unpause.

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

This function allows pausing/unpausing of all audio routed into the mixer strip. If paused is true, it overrides the pause state of all objects controlled by this mixer strip. If paused is false, controlled objects obey their own pause state.

See Also

• Studio::MixerStrip::getPaused

Version 1.03.06 Built on Apr 17, 2014