Studio::EventInstance::isVirtual

Retrieves the virtualization state of the event instance.

C++ Syntax

FMOD_RESULT Studio::EventInstance::isVirtual(
  bool *virtualState
);

C Syntax

FMOD_RESULT FMOD_Studio_EventInstance_IsVirtual(
  FMOD_STUDIO_EVENTINSTANCE *eventinstance,
  FMOD_BOOL *virtualState
);

Parameters

virtualState: Address of a variable to receive the virtualization state.

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 can be used to check if an event instance has been virtualized due to the max polyphony being exceeded.

Version 1.03.06 Built on Apr 17, 2014