Firelight Technologies FMOD Studio API
Studio::System::getVCAByID
Retrieves a VCA by ID.
C++ Syntax
FMOD_RESULT Studio::System::getVCAByID(
const FMOD_GUID *id,
Studio::VCA **vca
);
C Syntax
FMOD_RESULT FMOD_Studio_System_GetVCAByID(
FMOD_STUDIO_SYSTEM *system,
const FMOD_GUID *id,
FMOD_STUDIO_VCA **vca
);
C# Syntax
RESULT Studio.System.getVCAByID(
Guid guid,
out VCA vca
);
JavaScript Syntax
System.getVCAByID(
id,
vca // writes value to vca.val
);
Parameters
- id
- The 128-bit GUID which identifies the VCA.
- vca
- Address of a variable to receive the VCA object.
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 function allows you to retrieve a handle for any VCA in the global mixer. The ID can be looked up using Studio::System::lookupID or parsed from a string using Studio::parseID.
See Also
Version 1.10.03 Built on Feb 1, 2018