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
);

C# Syntax

static RESULT Studio.System.create(
  out System studiosystem
);

JavaScript Syntax

static System.create(
  system,                          // writes value to system.val
  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.

System::setSoftwareFormat must be called on the Low Level System object with speakermode corresponding to the project's output format if there is a possibility of the output audio device not matching the project's format. Any differences between the project format and the Low Level System's speakermode will cause the mix to sound wrong.

NOTE: Calls to Studio::System::create and Studio::System::release are not thread-safe. Do not call these functions simultaneously from multiple threads at once.

See Also

• Studio::System::initialize
• Studio::System::release
• Studio::System::getLowLevelSystem
• System::setSoftwareFormat

Version 1.10.03 Built on Feb 1, 2018