Firelight Technologies FMOD Studio API

Studio::System::create

Creates a Studio System object. This must be called before you do anything else.

C++ Syntax

static FMOD_RESULT Studio::System::create(
  Studio::System **system,
  unsigned int headerVersion
);

C Syntax

FMOD_RESULT FMOD_Studio_System_Create(
  FMOD_STUDIO_SYSTEM **system,
  unsigned int headerVersion
);

Parameters

system
Address of a variable to receive the new Studio System object.
headerVersion
The expected FMOD Studio API version, to ensure the library matches the headers. For the C API, pass in FMOD_VERSION. For the C++ API, it defaults to FMOD_VERSION, so you don't need to pass it in explicitly.

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 also creates the internal Low Level System object. Call Studio::System::release to free the Studio System.

See Also




Version 1.03.06 Built on Apr 17, 2014