FmodStudioSystem class

An FMOD Studio system, the top-level object of these bindings.

Create one with FmodStudioSystem.create, call update once per frame, and load banks exported from FMOD Studio to fire their events. The Core API is reachable through core for raw sound and channel playback. Drive a system from a single isolate.

Available extensions

Constructors

FmodStudioSystem.create({int maxChannels = 256, bool liveUpdate = false, int headerVersion = kFmodDefaultHeaderVersion, FmodOutputType output = FmodOutputType.autodetect})
Loads the FMOD libraries and creates and initializes a Studio system.
factory

Properties

core ↔ FmodCoreSystem
The Core API system underneath this Studio system.
latefinal
ffiBindings → FmodBindings

Available on FmodStudioSystem, provided by the FmodStudioSystemFfi extension

The looked-up C entry points.
no setter
hashCode → int
The hash code for this object.
no setterinherited
nativeSystem → Pointer<Void>

Available on FmodStudioSystem, provided by the FmodStudioSystemFfi extension

The native FMOD_STUDIO_SYSTEM handle.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

getBus(String path) → FmodStudioBus
Resolves a mixer bus by its bus:/ path ('bus:/' is the master bus).
getEvent(String path) → FmodEventDescription
Resolves an authored event by its event:/ path. Its bank (and the strings bank) must be loaded. Throws FmodException with FMOD_ERR_EVENT_NOTFOUND when the path is unknown.
loadBankFile(String path) → FmodBank
Loads a bank from a file path.
loadBankMemory(Uint8List bytes) → FmodBank
Loads a bank from in-memory bank bytes.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
release() → void
Shuts down the system and frees its native resources. The system and every object created from it are unusable afterwards.
setListenerAttributes({int index = 0, required Vector3 position, required Vector3 velocity, required Vector3 forward, required Vector3 up}) → void
Sets the 3D listener pose. FMOD's coordinate system is left-handed by default; forward and up must be normalized and orthogonal.
toString() → String
A string representation of this object.
inherited
update() → void
Processes queued commands and updates the 3D engine. Call once per frame.

Operators

operator ==(Object other) → bool
The equality operator.
inherited