Available on crate feature
studio only.Expand description
The FMOD Studio API.
The Studio API is a more high-level library which is tightly integrated with FMOD Studio, FMOD’s production tool.
Structs§
- Advanced
Settings - Settings for advanced features like configuring memory and cpu usage.
- Bank
- Banks made in FMOD Studio contain the metadata and audio sample data required for runtime mixing and playback.
- Buffer
Info - Information for a single buffer in FMOD Studio.
- Buffer
Usage - Information for FMOD Studio buffer usage.
- Bus
- Represents a global mixer bus.
- Command
Capture Flags - Flags controling command capture.
- Command
Info - Describes a command replay command.
- Command
Replay - The FMOD Studio command replay system allows API calls in a session to be recorded and later played back for debugging and performance purposes.
- Command
Replay Flags - Flags controlling command replay.
- CpuUsage
- Performance information for Studio API functionality.
- Event
Callback Mask - A mask used to determine what callbacks can or cannot be called.
- Event
Description - The description for an FMOD Studio event.
- Event
Instance - An instance of an FMOD Studio event.
- Init
Flags - Studio System initialization flags.
- Load
Bank Flags - Flags for controlling bank loading.
- Load
Bank Userdata - User data to be passed to the file callbacks.
- Memory
Usage - Memory usage statistics.
- Parameter
Description - Describes an event parameter.
- Parameter
Flags - Flags describing the behavior of a parameter.
- ParameterID
- Describes an event parameter identifier.
- Plugin
Instance Properties - Describes a DSP plug-in instance.
- Programmer
Sound Properties - Describes a programmer sound.
- Sound
Info - Describes a sound in the audio table.
- System
- The main system object for FMOD Studio.
- System
Builder - A builder for creating and initializing a
System. - System
Callback Mask - A mask used to determine what callbacks can or cannot be called.
- Timeline
Beat Properties - Describes a beat on the timeline.
- Timeline
Marker Properties - Describes a marker on the timeline.
- Timeline
Nested Beat Properties - Describes a beat on the timeline from a nested event.
- User
Property - Describes a user property.
- Vca
- Represents a global mixer VCA.
Enums§
- Event
Property - These definitions describe built-in event properties.
- Instance
Type - Command replay command instance handle types.
- Loading
State - Loading state of various objects.
- Parameter
Kind - Event parameter types.
- Playback
State - Playback state of various objects.
- Stop
Mode - Loaded and ready to play.
- User
Property Kind - User property types.
Constants§
- LOAD_
POINT_ ALIGNMENT - The required memory alignment of banks in user memory.
Traits§
- Create
Instance Callback - Trait for this particular FMOD callback.
- Event
Instance Callback - Trait for this particular FMOD callback.
- Frame
Callback - Trait for this particular FMOD callback.
- Load
Bank Callback - Trait for this particular FMOD callback.
- System
Callback - Trait for this particular FMOD callback.