Expand description
The low-level FMOD core API.
Modules§
- debug
- Low level control over FMOD’s debug logging.
- effects
- file
- Low level control over FMOD’s filesystem access.
- memory
- Low level control over how FMOD allocates memory.
- thread
- Low level control over FMOD’s threads.
Structs§
- Advanced
Settings - Advanced configuration settings.
- Async
Cancel Info - Information about cancelling a asynchronous file operation.
- Async
Read Info - Information about a single asynchronous file operation.
- Attenuation
Range - Attenuation range parameter data structure.
- Attributes3D
- Structure describing a position, velocity and orientation.
- Attributes3D
Multi - 3D attributes data structure for multiple listeners.
- Channel
- A source of audio signal that connects to the
ChannelGroupmixing hierarchy. - Channel
Control - An interface that represents the shared APIs between
ChannelandChannelGroup. - Channel
Group - A submix in the mixing hierarchy akin to a bus that can contain both
ChannelandChannelGroupobjects. - Channel
Mask - Flags that describe the speakers present in a given signal.
- CpuUsage
- Performance information for Core API functionality.
- Driver
State - Flags that provide additional information about a particular driver.
- Dsp
- A digital signal processor is one node within a graph that transforms input audio signals into an output stream.
- DspAttributes3D
- 3D attributes data structure.
- DspConnection
- An interface that manages Digital Signal Processor (DSP) connections
- DspMetering
Info - DSP metering info.
- DspParameter
Description - Base structure for DSP parameter descriptions.
- Dynamic
Response fmod_2_3 - Dynamic response data structure.
- Error
Callback Info - Information describing an error that has occurred.
- Fft
- FFT parameter data structure.
- File
Buffer - A mutable file buffer.
- Float
Mapping - Structure to define a mapping for a DSP unit’s float parameter.
- Geometry
- An interface that allows the setup and modification of geometry for occlusion.
- Guid
- Structure describing a globally unique identifier.
- Init
Flags - Configuration flags used when initializing the System object.
- Mode
- [
Sound] description bitfields. - Overall
Gain - Overall gain parameter data structure.
- Piecewise
Linear Mapping - Structure to define a piecewise linear mapping.
- Reverb3D
- An interface that manages virtual 3D reverb spheres.
- Reverb
Properties - Structure defining a reverb environment.
- Sidechain
- Side chain parameter data structure.
- Sound
- Container for sample data that can be played on a Channel.
- Sound
Builder - A builder for creating a
Sound. - Sound
Group - An interface that manages Sound Groups.
- Sound
Lock - A locked region of sound data.
- Sync
Point - Named marker for a given point in time.
- System
- Management object from which all resources are created and played.
- System
Builder - A builder for creating and initializing a
System. - System
Callback Mask - Tag
- Tag data / metadata description.
- Thread
Affinity - Bitfield for specifying the CPU core a given thread runs on.
- Vector
- Structure describing a point in 3D space.
Enums§
- Channel
Control Type - Enum used to distinguish between
ChannelandChannelGroupin theChannelControlcallback. - Channel
Order - Speaker ordering for multi-channel signals.
- DspConnection
Type - List of connection types between two DSP units.
- DspParameter
Data Type - Data parameter types.
- DspParameter
Type - DSP parameter types.
- DspType
- DSP types.
- Float
Mapping Type - DSP float parameter mappings.
- Instance
- Identifier used to represent the different types of instance in the error callback.
- Open
State - These values describe what state a sound is in after
FMOD_NONBLOCKINGhas been used to open it. - Output
Type - Built-in output types that can be used to run the mixer.
- Plugin
Type - Types of plug-in used to extend functionality.
- Port
Type - Port types available for routing audio.
- Resampler
- List of interpolation types used for resampling.
- Sound
Format - These definitions describe the native format of the hardware or software buffer that will be used.
- Sound
Group Behavior - Values specifying behavior when a sound group’s max audible value is exceeded.
- Sound
Type - Recognized audio formats that can be loaded into a Sound.
- Speaker
- Assigns an enumeration for a speaker index.
- Speaker
Mode - Speaker mode types.
- TagData
- List of tag data / metadata types.
- TagType
- List of tag data / metadata types that could be stored within a sound. These include id3 tags, metadata from netstreams and vorbis/asf data.
- Thread
Type - Named constants for threads created at runtime.
- Time
Unit - Time types used for position or length.
Traits§
- Channel
Control Callback - Trait for this particular FMOD callback.
- DspCallback
- Trait for this particular FMOD callback.
- File
System - The base trait for all filesystems.
- File
System Async - An async filesystem.
- File
System Sync - A synchronous filesystem.
- NonBlock
Callback - Callback to be called when a sound has finished loading, or a non blocking seek is occuring.
- PcmCallback
- Capture or provide sound data as it is decoded.
- Readable
Parameter - Trait for types that can be read from DSP parameters.
- Readable
Parameter Index - Trait for types that can be turned into a readable parameter index.
- Rolloff
Callback - Trait for this particular FMOD callback.
- System
Callback - Trait for this particular FMOD callback.
- Writable
Parameter - Trait for types that can be written to DSP parameters.
- Writable
Parameter Index - Trait for types that can be turned into a writable parameter index.