Firelight Technologies FMOD Studio API
FMOD_STUDIO_COMMANDREPLAY_CREATE_INSTANCE_CALLBACK
Callback for command replay event instance creation.
C/C++ Syntax
FMOD_RESULT F_CALLBACK FMOD_STUDIO_COMMANDREPLAY_CREATE_INSTANCE_CALLBACK(
FMOD_STUDIO_COMMANDREPLAY *replay,
int commandIndex,
FMOD_STUDIO_EVENTDESCRIPTION *eventDescription,
FMOD_STUDIO_EVENTINSTANCE **instance,
void *userdata
);
Parameters
replay
Pointer to the command replay object.
commandIndex
The command that invoked this callback.
eventDescription
The event description to use.
instance
The resulting event instance.
userdata
The userdata assigned into the given replay, or NULL if not set.
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
C++ Users. Cast FMOD_STUDIO_COMMANDREPLAY * to FMOD::Studio::CommandReplay * inside the callback and use as normal.
'userdata' is the userdata assigned to the system from Studio::CommandReplay::setUserData function.
This callback can be used to control event instance creation in a command replay.
NOTE! The original handle does not represent a valid object. It should only used to match against the replay file as a unique identifier.
See Also
Version 1.10.03 Built on Feb 1, 2018