Firelight Technologies FMOD Studio API
Studio::EventInstance::getPlaybackState
Retrieves the playback state of the event instance.
C++ Syntax
FMOD_RESULT Studio::EventInstance::getPlaybackState(
FMOD_STUDIO_PLAYBACK_STATE *state
);
C Syntax
FMOD_RESULT FMOD_Studio_EventInstance_GetPlaybackState(
FMOD_STUDIO_EVENTINSTANCE *eventinstance,
FMOD_STUDIO_PLAYBACK_STATE *state
);
C# Syntax
RESULT Studio.EventInstance.getPlaybackState(
out PLAYBACK_STATE state
);
JavaScript Syntax
EventInstance.getPlaybackState(
state // writes value to state.val
);
Parameters
- state
- Address of a variable to receive the current playback state of the event instance. See FMOD_STUDIO_PLAYBACK_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
You can poll this function to track the playback state of an event instance.
If the instance is invalid, then the state will be set to FMOD_STUDIO_PLAYBACK_STOPPED.
See Also
Version 1.10.03 Built on Feb 1, 2018