Firelight Technologies FMOD Studio API
Studio::System::getBus
Retrieves a bus by path or ID string.
C++ Syntax
FMOD_RESULT Studio::System::getBus(
const char *path,
Studio::Bus **bus
);
C Syntax
FMOD_RESULT FMOD_Studio_System_GetBus(
FMOD_STUDIO_SYSTEM *system,
const char *path,
FMOD_STUDIO_BUS **bus
);
C# Syntax
RESULT Studio.System.getBus(
string path,
out Bus bus
);
JavaScript Syntax
System.getBus(
path,
bus // writes value to bus.val
);
Parameters
- path
- The bus path or the ID string that identifies the bus.
- bus
- Address of a variable to receive the bus 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 bus in the global mixer.
The path field can be the full bus path, such as 'bus:/SFX/Ambience', 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