Firelight Technologies FMOD Studio API

Studio::System::getBusByID

Retrieves a bus by ID.

C++ Syntax

FMOD_RESULT Studio::System::getBusByID(
  const FMOD_GUID *id,
  Studio::Bus **bus
);

C Syntax

FMOD_RESULT FMOD_Studio_System_GetBusByID(
  FMOD_STUDIO_SYSTEM *system,
  const FMOD_GUID *id,
  FMOD_STUDIO_BUS **bus
);

C# Syntax

RESULT Studio.System.getBusByID(
  Guid guid,
  out Bus bus
);

JavaScript Syntax

System.getBusByID(
  id,                              
  bus                              // writes value to bus.val
);

Parameters

id

The 128-bit GUID which 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 ID can be looked up using Studio::System::lookupID or parsed from a string using Studio::parseID.

See Also

• Studio::parseID
• Studio::System::lookupID
• Studio::System::getBus

Version 1.10.03 Built on Feb 1, 2018