FMOD_STUDIO_SYSTEM_CALLBACK

FMOD Studio API

Firelight Technologies FMOD Studio API

FMOD_STUDIO_SYSTEM_CALLBACK

Callback for Studio system events.

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_STUDIO_SYSTEM_CALLBACK(
  FMOD_STUDIO_SYSTEM *system,
  FMOD_STUDIO_SYSTEM_CALLBACK_TYPE type,
  void *commanddata,
  void *userdata
);

Parameters

system

Pointer to a Studio system.

type

The type of callback. Refer to FMOD_STUDIO_SYSTEM_CALLBACK_TYPE.

commanddata

The callback type specific data generated by the callback. See remarks for meaning.

userdata

The userdata assigned into the given system, 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_SYSTEM * to FMOD::Studio::System * inside the callback and use as normal.

'userdata' is the userdata assigned to the system from Studio::System::setUserData function.

'commanddata' is not currently used for any callback type. It is included for future compatibility.

See Also




Version 1.10.03 Built on Feb 1, 2018