Firelight Technologies FMOD Studio API
Studio::System::getVCA
Retrieves a VCA by path or ID string.
C++ Syntax
FMOD_RESULT Studio::System::getVCA(
const char *path,
Studio::VCA **vca
);
C Syntax
FMOD_RESULT FMOD_Studio_System_GetVCA(
FMOD_STUDIO_SYSTEM *system,
const char *path,
FMOD_STUDIO_VCA **vca
);
C# Syntax
RESULT Studio.System.getVCA(
string path,
out VCA vca
);
JavaScript Syntax
System.getVCA(
path,
vca // writes value to vca.val
);
Parameters
- path
- The VCA path or the ID string that 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 path field can be the full VCA path, such as 'vca:/MyVCA', or the ID, such as '{d9982c58-a056-4e6c-b8e3-883854b4bffb}'.
Note that path lookups will only succeed if the strings bank has been loaded.
See Also
Version 1.10.03 Built on Feb 1, 2018