constants

Constants

These are the constants that you can use in the FMOD extension.

Note

All items on this page are Constants. However, some are defined as macros in the extension, others as enums. See a constant's description to know its type.

Constants

This module includes a set of predefined constants that can be utilized for various purposes. Browse through the available constants to find values relevant to your needs and enhance the efficiency of your code.

Member	Description
`LEVEL_NONE`	Disable all messages.
`LEVEL_ERROR`	Enable only error messages.
`LEVEL_WARNING`	Enable warning and error messages.
`LEVEL_LOG`	Enable informational, warning and error messages.
`TYPE_MEMORY`	This enables verbose logging for memory operations, only use this if you are debugging a memory related issue.
`TYPE_FILE`	This enables verbose logging for file access, only use this if you are debugging a file related issue.
`TYPE_CODEC`	This enables verbose logging for codec initialisation, only use this if you are debugging a codec related issue.
`TYPE_TRACE`	This enables verbose logging for internal errors, use this for tracking the origin of error codes.
`DISPLAY_TIMESTAMPS`	This displays the time stamp of the log message in milliseconds.
`DISPLAY_LINENUMBERS`	This displays the source code file and line number for where the message originated.
`DISPLAY_THREAD`	This displays the thread ID of the calling function that generated the message.

Member	Description
`NORMAL`	This value specifies standard memory allocation.
`STREAM_FILE`	This value specifies a stream file buffer, size controllable with fmod_system_set_stream_buffer_size.
`STREAM_DECODE`	This value specifies a stream decode buffer, size controllable with `FmodSystemCreateSoundExInfo.decodebuffersize`.
`SAMPLEDATA`	This value specifies a sample data buffer. Raw audio data, usually PCM/MPEG/ADPCM/XMA data.
`DSP_BUFFER`	Deprecated.
`PLUGIN`	This value indicates that the memory is allocated by a third party plugin.
`PERSISTENT`	Persistent memory. Memory will be freed when fmod_system_release is called.
`ALL`	This is a mask specifying all memory types.

Member	Description
`NORMAL`	Initialize normally.
`STREAM_FROM_UPDATE`	No stream thread is created internally. Streams are driven from fmod_system_update. Mainly used with non-realtime outputs.
`MIX_FROM_UPDATE`	No mixer thread is created internally. Mixing is driven from fmod_system_update. Only applies to polling based output modes such as `FMOD_OUTPUTTYPE.NOSOUND`, `FMOD_OUTPUTTYPE.WAVWRITER`.
`RIGHTHANDED_3D`	3D calculations will be performed in right-handed coordinates.
`CLIP_OUTPUT`	Enables hard clipping of output values greater than `1.0` or less than `-1.0`.
`CHANNEL_LOWPASS`	Enables usage of fmod_channel_control_set_low_pass_gain, fmod_channel_control_set_3d_occlusion, or automatic usage by the Geometry API. All voices will add a software lowpass filter effect into the DSP chain which is idle unless one of the previous functions/features are used.
`CHANNEL_DISTANCEFILTER`	All `FMOD_MODE.AS_3D` based voices will add a software lowpass and highpass filter effect into the DSP chain which will act as a distance-automated bandpass filter. Use fmod_system_set_advanced_settings to adjust the center frequency.
`PROFILE_ENABLE`	Enable TCP/IP based host which allows FMOD Studio or FMOD Profiler to connect to it, and view memory, CPU and the DSP network graph in real-time.
`VOL0_BECOMES_VIRTUAL`	Any sounds that are 0 volume will go virtual and not be processed except for having their positions updated virtually. Use fmod_system_set_advanced_settings to adjust what volume besides zero to switch to virtual at.
`GEOMETRY_USECLOSEST`	With the geometry engine, only process the closest polygon rather than accumulating all polygons the sound to listener line intersects.
`PREFER_DOLBY_DOWNMIX`	When using `FMOD_SPEAKERMODE._5POINT1` with a stereo output device, use the Dolby Pro Logic II downmix algorithm instead of the default stereo downmix algorithm.
`THREAD_UNSAFE`	Disables thread safety for API calls. Only use this if FMOD is being called from a single thread, and if Studio API is not being used!
`PROFILE_METER_ALL`	Slower, but adds level metering for every single DSP unit in the graph. Use fmod_dsp_set_metering_enabled to turn meters off individually. Setting this flag implies `FMOD_INIT.PROFILE_ENABLE`.
`MEMORY_TRACKING`	Enables memory allocation tracking. Currently this is only useful when using the Studio API. Increases memory footprint and reduces performance. This flag is implied by `FMOD_STUDIO_INIT.MEMORY_TRACKING`.

Member	Description
`CONNECTED`	Device is currently plugged in.
`DEFAULT`	Device is the user's preferred choice.

Member	Description
`MS`	Milliseconds.
`PCM`	PCM samples, related to milliseconds * samplerate / 1000.
`PCMBYTES`	Bytes, related to PCM samples * channels * datawidth (i.e. 16bit = 2 bytes).
`RAWBYTES`	Raw file bytes of (compressed) sound data (does not include headers). Only used by fmod_sound_get_length and fmod_channel_get_position.
`PCMFRACTION`	Fractions of 1 PCM sample. Unsigned int range 0 to 0xFFFFFFFF. Used for sub-sample granularity for DSP purposes.
`MODORDER`	MOD/S3M/XM/IT. Order in a sequenced module format. Use fmod_sound_get_format to determine the PCM format being decoded to.
`MODROW`	MOD/S3M/XM/IT. Current row in a sequenced module format. Cannot use with fmod_channel_set_position. fmod_sound_get_length will return the number of rows in the currently playing or seeked to pattern.
`MODPATTERN`	MOD/S3M/XM/IT. Current pattern in a sequenced module format. Cannot use with fmod_channel_set_position. fmod_sound_get_length will return the number of patterns in the song and fmod_channel_get_position will return the currently playing pattern.

Member	Description
`DEVICELISTCHANGED`	Called from fmod_system_update when the enumerated list of devices has changed. Called from the main (calling) thread when set from the Core API or Studio API in synchronous mode, and from the Studio Update Thread when in default / async mode.
`DEVICELOST`	Deprecated.
`MEMORYALLOCATIONFAILED`	Called directly when a memory allocation fails.
`THREADCREATED`	Called from the game thread when a thread is created.
`BADDSPCONNECTION`	Deprecated.
`PREMIX`	Called from the mixer thread before it starts the next block.
`POSTMIX`	Called from the mixer thread after it finishes a block.
`ERROR`	Called directly when an API function returns an error, including delayed async functions.
`MIDMIX`	Called from the mixer thread after clocks have been updated before the main mix occurs.
`THREADDESTROYED`	Called from the game thread when a thread is destroyed.
`PREUPDATE`	Called at start of fmod_system_update from the main (calling) thread when set from the Core API or Studio API in synchronous mode, and from the Studio Update Thread when in default / async mode.
`POSTUPDATE`	Called at end of fmod_system_update from the main (calling) thread when set from the Core API or Studio API in synchronous mode, and from the Studio Update Thread when in default / async mode.
`RECORDLISTCHANGED`	Called from fmod_system_update when the enumerated list of recording devices has changed. Called from the main (calling) thread when set from the Core API or Studio API in synchronous mode, and from the Studio Update Thread when in default / async mode.
`BUFFEREDNOMIX`	Called from the feeder thread after audio was consumed from the ring buffer, but not enough to allow another mix to run.
`DEVICEREINITIALIZE`	Called from fmod_system_update when an output device is re-initialized. Called from the main (calling) thread when set from the Core API or Studio API in synchronous mode, and from the Studio Update Thread when in default / async mode.
`OUTPUTUNDERRUN`	Called from the mixer thread when the device output attempts to read more samples than are available in the output buffer.
`RECORDPOSITIONCHANGED`	Called from the mixer thread when the System record position changed.
`ALL`	Mask representing all callback types.

Member	Description
`DEFAULT`	Default for all modes listed below. `FMOD_MODE.LOOP_OFF`, `FMOD_MODE.AS_2D`, `FMOD_MODE.AS_3D_WORLDRELATIVE`, `FMOD_MODE.AS_3D_INVERSEROLLOFF`
`LOOP_OFF`	For non looping Sounds. (DEFAULT). Overrides `FMOD_MODE.LOOP_NORMAL` / `FMOD_MODE.LOOP_BIDI`.
`LOOP_NORMAL`	For forward looping Sounds.
`LOOP_BIDI`	For bidirectional looping Sounds. (only works on non-streaming, real voices).
`AS_2D`	Ignores any 3D processing. (DEFAULT).
`AS_3D`	Makes the Sound positionable in 3D. Overrides `FMOD_MODE.AS_2D`.
`CREATESTREAM`	Decompress at runtime, streaming from the source provided (i.e. from disk). Overrides `FMOD_MODE.CREATESAMPLE` and `FMOD_MODE.CREATECOMPRESSEDSAMPLE`. Note a stream can only be played once at a time due to a stream only having 1 stream buffer and file handle. Open multiple streams to have them play concurrently.
`CREATESAMPLE`	Decompress at loadtime, decompressing or decoding whole file into memory as the target sample format (i.e. PCM). Fastest for playback and most flexible.
`CREATECOMPRESSEDSAMPLE`	Load MP2/MP3/FADPCM/IMAADPCM/Vorbis/AT9 or XMA into memory and leave it compressed. Vorbis/AT9/FADPCM encoding only supported in the .FSB container format. During playback the FMOD software mixer will decode it in realtime as a 'compressed sample'. Overrides `FMOD_MODE.CREATESAMPLE`. If the sound data is not one of the supported formats, it will behave as if it was created with `FMOD_MODE.CREATESAMPLE` and decode the sound into PCM.
`OPENUSER`	Opens a user-created static sample or stream. When used, the first argument of fmod_system_create_sound and fmod_system_create_stream, name_or_data, is ignored, so recommended practice is to pass null or equivalent. The following data must be provided using FmodSystemCreateSoundExInfo: cbsize, length, numchannels, defaultfrequency, format, and optionally read callback. If a user-created 'sample' is created with no read callback, the sample will be empty. If this is the case, use fmod_sound_lock and fmod_sound_unlock to place sound data into the Sound.
`OPENMEMORY`	When used, the first argument of fmod_system_create_sound and fmod_system_create_stream, `name_or_buff`, is interpreted as a pointer to memory instead of filename for creating sounds. The following data must be provided using FmodSystemCreateSoundExInfo: cbsize, and length. If used with `FMOD_MODE.CREATESAMPLE` or `FMOD_MODE.CREATECOMPRESSEDSAMPLE`, FMOD duplicates the memory into its own buffers. Your own buffer can be freed after open, unless you are using `FMOD_MODE.NONBLOCKING` then wait until the Sound is in the `FMOD_OPENSTATE.READY` state. If used with `FMOD_MODE.CREATESTREAM`, FMOD will stream out of the Buffer that you passed in. In this case, your own buffer should not be freed until you have finished with and released the stream.
`OPENMEMORY_POINT`	When used, the first argument of fmod_system_create_sound and fmod_system_create_stream, `name_or_buff`, is interpreted as a pointer to memory instead of filename for creating sounds. The following data must be provided using FmodSystemCreateSoundExInfo: cbsize, and length. This differs to `FMOD_MODE.OPENMEMORY` in that it uses the Buffer memory as is, without duplicating the memory into its own buffers. Cannot be freed after open, only after fmod_sound_release. Will not work if the data is compressed and `FMOD_MODE.CREATECOMPRESSEDSAMPLE` is not used. Cannot be used in conjunction with `FmodSystemCreateSoundExInfo.encryptionkey`.
`OPENRAW`	Will ignore file format and treat as raw pcm. The following data must be provided using FmodSystemCreateSoundExInfo: cbsize, numchannels, defaultfrequency, and format. Must be little endian data.
`OPENONLY`	Just open the file, don't prebuffer or read. Good for fast opens for info, or when fmod_sound_read_data is to be used.
`ACCURATETIME`	For fmod_system_create_sound - for accurate fmod_sound_get_length / fmod_channel_set_position on VBR MP3, and MOD/S3M/XM/IT/MIDI files. Scans file first, so takes longer to open. `FMOD_MODE.OPENONLY` does not affect this.
`MPEGSEARCH`	For corrupted / bad MP3 files. This will search all the way through the file until it hits a valid MPEG header. Normally only searches for 4k.
`NONBLOCKING`	For opening Sounds and getting streamed subsounds (seeking) asynchronously. Use fmod_sound_get_open_state to poll the state of the Sound as it opens or retrieves the subsound in the background.
`UNIQUE`	Unique Sound, can only be played one at a time.
`AS_3D_HEADRELATIVE`	Make the Sound's position, velocity and orientation relative to the listener.
`AS_3D_WORLDRELATIVE`	Make the Sound's position, velocity and orientation absolute (relative to the world). (DEFAULT)
`AS_3D_INVERSEROLLOFF`	This sound follows an inverse roll-off model. Below mindistance, the volume is unattenuated; as distance increases above mindistance, the volume attenuates using mindistance/distance as the gradient until it reaches maxdistance, where it stops attenuating. For this roll-off mode, distance values greater than mindistance are scaled according to the rolloffscale. This roll-off mode accurately models the way sounds attenuate over distance in the real world. (DEFAULT)
`AS_3D_LINEARROLLOFF`	This sound follows a linear roll-off model. Below mindistance, the volume is unattenuated; as distance increases from mindistance to maxdistance, the volume attenuates to silence using a linear gradient. For this roll-off mode, distance values greater than mindistance are scaled according to the rolloffscale. While this roll-off mode is not as realistic as inverse roll-off mode, it is easier to comprehend.
`AS_3D_LINEARSQUAREROLLOFF`	This sound follows a linear-square roll-off model. Below mindistance, the volume is unattenuated; as distance increases from mindistance to maxdistance, the volume attenuates to silence according to a linear squared gradient. For this roll-off mode, distance values greater than mindistance are scaled according to the rolloffscale. This roll-off mode provides steeper volume ramping close to the mindistance, and more gradual ramping close to the maxdistance, than linear roll-off mode.
`AS_3D_INVERSETAPEREDROLLOFF`	This sound follows a combination of the inverse and linear-square roll-off models. At short distances where inverse roll-off would provide greater attenuation, it functions as inverse roll-off mode; then at greater distances where linear-square roll-off mode would provide greater attenuation, it uses that roll-off mode instead. For this roll-off mode, distance values greater than mindistance are scaled according to the rolloffscale. Inverse tapered roll-off mode approximates realistic behavior while still guaranteeing the sound attenuates to silence at maxdistance.
`AS_3D_CUSTOMROLLOFF`	This sound follows a roll-off model defined by fmod_sound_set_3d_custom_rolloff / fmod_channel_control_set_3d_custom_rolloff. This roll-off mode provides greater freedom and flexibility than any other, but must be defined manually.
`AS_3D_IGNOREGEOMETRY`	Is not affected by geometry occlusion. If not specified in fmod_sound_set_mode, or fmod_channel_control_set_mode, the flag is cleared and it is affected by geometry again.
`IGNORETAGS`	Skips id3v2/asf/etc. tag checks when opening a Sound, to reduce seek/read overhead when opening files.
`LOWMEM`	Removes some features from samples to give a lower memory overhead, like fmod_sound_get_name.
`MODEVIRTUAL_PLAYFROMSTART`	For Channels that start virtual (due to being quiet or low importance), instead of swapping back to audible, and playing at the correct offset according to time, this flag makes the Channel play from the start.

Member	Description
`FRONT_LEFT`	Front left channel.
`FRONT_RIGHT`	Front right channel.
`FRONT_CENTER`	Front center channel.
`LOW_FREQUENCY`	Low frequency channel.
`SURROUND_LEFT`	Surround left channel.
`SURROUND_RIGHT`	Surround right channel.
`BACK_LEFT`	Back left channel.
`BACK_RIGHT`	Back right channel.
`BACK_CENTER`	Back center channel, not represented in any FMOD_SPEAKERMODE.
`MONO`	Mono channel mask.
`STEREO`	Stereo channel mask.
`LRC`	Left / right / center channel mask.
`QUAD`	Quadphonic channel mask.
`SURROUND`	5.0 surround channel mask.
`SURROUND_5POINT1`	5.1 surround channel mask.
`SURROUND_5POINT1_REARS`	5.1 surround channel mask, using rears instead of surrounds.
`SURROUND_7POINT0`	7.0 surround channel mask.
`SURROUND_7POINT1`	7.1 surround channel mask.

Member	Description
`NONE`	Use when a port index is not required
`FLAG_VR_CONTROLLER`	Use as a flag to indicate the intended controller is associated with a VR headset

Member	Description
`PLATFORM_MIN`	Lower bound of platform specific priority range.
`PLATFORM_MAX`	Upper bound of platform specific priority range.
`DEFAULT`	For a given thread use the default listed below, i.e. `FMOD_THREAD_TYPE.MIXER` uses `FMOD_THREAD_PRIORITY.MIXER`.
`LOW`	Low platform agnostic priority.
`MEDIUM`	Medium platform agnostic priority.
`HIGH`	High platform agnostic priority.
`VERY_HIGH`	Very high platform agnostic priority.
`EXTREME`	Extreme platform agnostic priority.
`CRITICAL`	Critical platform agnostic priority.
`MIXER`	Default priority for `FMOD_THREAD_TYPE.MIXER`.
`FEEDER`	Default priority for `FMOD_THREAD_TYPE.FEEDER`.
`STREAM`	Default priority for `FMOD_THREAD_TYPE.STREAM`.
`FILE`	Default priority for `FMOD_THREAD_TYPE.FILE`.
`NONBLOCKING`	Default priority for `FMOD_THREAD_TYPE.NONBLOCKING`.
`RECORD`	Default priority for `FMOD_THREAD_TYPE.RECORD`.
`GEOMETRY`	Default priority for `FMOD_THREAD_TYPE.GEOMETRY`.
`PROFILER`	Default priority for `FMOD_THREAD_TYPE.PROFILER`.
`STUDIO_UPDATE`	Default priority for `FMOD_THREAD_TYPE.STUDIO_UPDATE`.
`STUDIO_LOAD_BANK`	Default priority for `FMOD_THREAD_TYPE.STUDIO_LOAD_BANK`.
`STUDIO_LOAD_SAMPLE`	Default priority for `FMOD_THREAD_TYPE.STUDIO_LOAD_SAMPLE`.
`CONVOLUTION1`	Default priority for `FMOD_THREAD_TYPE.CONVOLUTION1`.
`CONVOLUTION2`	Default priority for `FMOD_THREAD_TYPE.CONVOLUTION2`.

Member	Description
`GROUP_DEFAULT`	For a given thread use the default listed below, i.e. `FMOD_THREAD_TYPE.MIXER` uses `FMOD_THREAD_AFFINITY.MIXER`.
`GROUP_A`	Grouping A is recommended to isolate the mixer thread `FMOD_THREAD_TYPE.MIXER`.
`GROUP_B`	Grouping B is recommended to isolate the Studio update thread `FMOD_THREAD_TYPE.STUDIO_UPDATE`.
`GROUP_C`	Grouping C is recommended for all remaining threads.
`MIXER`	Default affinity for `FMOD_THREAD_TYPE.MIXER`.
`FEEDER`	Default affinity for `FMOD_THREAD_TYPE.FEEDER`.
`STREAM`	Default affinity for `FMOD_THREAD_TYPE.STREAM`.
`FILE`	Default affinity for `FMOD_THREAD_TYPE.FILE`.
`NONBLOCKING`	Default affinity for `FMOD_THREAD_TYPE.NONBLOCKING`.
`RECORD`	Default affinity for `FMOD_THREAD_TYPE.RECORD`.
`GEOMETRY`	Default affinity for `FMOD_THREAD_TYPE.GEOMETRY`.
`PROFILER`	Default affinity for `FMOD_THREAD_TYPE.PROFILER`.
`STUDIO_UPDATE`	Default affinity for `FMOD_THREAD_TYPE.STUDIO_UPDATE`.
`STUDIO_LOAD_BANK`	Default affinity for `FMOD_THREAD_TYPE.STUDIO_LOAD_BANK`.
`STUDIO_LOAD_SAMPLE`	Default affinity for `FMOD_THREAD_TYPE.STUDIO_LOAD_SAMPLE`.
`CONVOLUTION1`	Default affinity for `FMOD_THREAD_TYPE.CONVOLUTION1`.
`CONVOLUTION2`	Default affinity for `FMOD_THREAD_TYPE.CONVOLUTION2`.
`CORE_ALL`	Assign to all cores.
`CORE_0`	Assign to core 0.
`CORE_1`	Assign to core 1.
`CORE_2`	Assign to core 2.
`CORE_3`	Assign to core 3.
`CORE_4`	Assign to core 4.
`CORE_5`	Assign to core 5.
`CORE_6`	Assign to core 6.
`CORE_7`	Assign to core 7.
`CORE_8`	Assign to core 8.
`CORE_9`	Assign to core 9.
`CORE_10`	Assign to core 10.
`CORE_11`	Assign to core 11.
`CORE_12`	Assign to core 12.
`CORE_13`	Assign to core 13.
`CORE_14`	Assign to core 14.
`CORE_15`	Assign to core 15.

Member	Description
`FMOD_PRESET_OFF`	{ decay_time: 1000, early_delay: 7, late_delay: 11, hf_reference: 5000, hf_decay_ratio: 100, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 20, early_late_mix: 96, wet_level: -80.0 }
`FMOD_PRESET_GENERIC`	{ decay_time: 1500, early_delay: 7, late_delay: 11, hf_reference: 5000, hf_decay_ratio: 83, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 14500, early_late_mix: 96, wet_level: -8.0 }
`FMOD_PRESET_PADDEDCELL`	{ decay_time: 170, early_delay: 1, late_delay: 2, hf_reference: 5000, hf_decay_ratio: 10, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 160, early_late_mix: 84, wet_level: -7.8 }
`FMOD_PRESET_ROOM`	{ decay_time: 400, early_delay: 2, late_delay: 3, hf_reference: 5000, hf_decay_ratio: 83, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 6050, early_late_mix: 88, wet_level: -9.4 }
`FMOD_PRESET_BATHROOM`	{ decay_time: 1500, early_delay: 7, late_delay: 11, hf_reference: 5000, hf_decay_ratio: 54, diffusion: 100, density: 60, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 2900, early_late_mix: 83, wet_level: 0.5 }
`FMOD_PRESET_LIVINGROOM`	{ decay_time: 500, early_delay: 3, late_delay: 4, hf_reference: 5000, hf_decay_ratio: 10, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 160, early_late_mix: 58, wet_level: -19.0 }
`FMOD_PRESET_STONEROOM`	{ decay_time: 2300, early_delay: 12, late_delay: 17, hf_reference: 5000, hf_decay_ratio: 64, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 7800, early_late_mix: 71, wet_level: -8.5 }
`FMOD_PRESET_AUDITORIUM`	{ decay_time: 4300, early_delay: 20, late_delay: 30, hf_reference: 5000, hf_decay_ratio: 59, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 5850, early_late_mix: 64, wet_level: -11.7 }
`FMOD_PRESET_CONCERTHALL`	{ decay_time: 3900, early_delay: 20, late_delay: 29, hf_reference: 5000, hf_decay_ratio: 70, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 5650, early_late_mix: 80, wet_level: -9.8 }
`FMOD_PRESET_CAVE`	{ decay_time: 2900, early_delay: 15, late_delay: 22, hf_reference: 5000, hf_decay_ratio: 100, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 20000, early_late_mix: 59, wet_level: -11.3 }
`FMOD_PRESET_ARENA`	{ decay_time: 7200, early_delay: 20, late_delay: 30, hf_reference: 5000, hf_decay_ratio: 33, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 4500, early_late_mix: 80, wet_level: -9.6 }
`FMOD_PRESET_HANGAR`	{ decay_time: 10000, early_delay: 20, late_delay: 30, hf_reference: 5000, hf_decay_ratio: 23, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 3400, early_late_mix: 72, wet_level: -7.4 }
`FMOD_PRESET_CARPETTEDHALLWAY`	{ decay_time: 300, early_delay: 2, late_delay: 30, hf_reference: 5000, hf_decay_ratio: 10, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 500, early_late_mix: 56, wet_level: -24.0 }
`FMOD_PRESET_HALLWAY`	{ decay_time: 1500, early_delay: 7, late_delay: 11, hf_reference: 5000, hf_decay_ratio: 59, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 7800, early_late_mix: 87, wet_level: -5.5 }
`FMOD_PRESET_STONECORRIDOR`	{ decay_time: 270, early_delay: 13, late_delay: 20, hf_reference: 5000, hf_decay_ratio: 79, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 9000, early_late_mix: 86, wet_level: -6.0 }
`FMOD_PRESET_ALLEY`	{ decay_time: 1500, early_delay: 7, late_delay: 11, hf_reference: 5000, hf_decay_ratio: 86, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 8300, early_late_mix: 80, wet_level: -9.8 }
`FMOD_PRESET_FOREST`	{ decay_time: 1500, early_delay: 162, late_delay: 88, hf_reference: 5000, hf_decay_ratio: 54, diffusion: 79, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 760, early_late_mix: 94, wet_level: -12.3 }
`FMOD_PRESET_CITY`	{ decay_time: 1500, early_delay: 7, late_delay: 11, hf_reference: 5000, hf_decay_ratio: 67, diffusion: 50, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 4050, early_late_mix: 66, wet_level: -26.0 }
`FMOD_PRESET_MOUNTAINS`	{ decay_time: 1500, early_delay: 300, late_delay: 100, hf_reference: 5000, hf_decay_ratio: 21, diffusion: 27, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 1220, early_late_mix: 82, wet_level: -24.0 }
`FMOD_PRESET_QUARRY`	{ decay_time: 1500, early_delay: 61, late_delay: 25, hf_reference: 5000, hf_decay_ratio: 83, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 3400, early_late_mix: 100, wet_level: -5.0 }
`FMOD_PRESET_PLAIN`	{ decay_time: 1500, early_delay: 179, late_delay: 100, hf_reference: 5000, hf_decay_ratio: 50, diffusion: 21, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 1670, early_late_mix: 65, wet_level: -28.0 }
`FMOD_PRESET_PARKINGLOT`	{ decay_time: 1700, early_delay: 8, late_delay: 12, hf_reference: 5000, hf_decay_ratio: 100, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 20000, early_late_mix: 56, wet_level: -19.5 }
`FMOD_PRESET_SEWERPIPE`	{ decay_time: 2800, early_delay: 14, late_delay: 21, hf_reference: 5000, hf_decay_ratio: 14, diffusion: 80, density: 60, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 3400, early_late_mix: 66, wet_level: 1.2 }
`FMOD_PRESET_UNDERWATER`	{ decay_time: 1500, early_delay: 7, late_delay: 11, hf_reference: 5000, hf_decay_ratio: 10, diffusion: 100, density: 100, low_shelf_frequency: 250, low_shelf_gain: 0, high_cut: 500, early_late_mix: 92, wet_level: 7.0 }

Member	Description
`OK`	No errors.
`ERR_BADCOMMAND`	Tried to call a function on a data type that does not allow this type of functionality (i.e. calling fmod_sound_lock on a streaming Sound).
`ERR_CHANNEL_ALLOC`	Error trying to allocate a Channel.
`ERR_CHANNEL_STOLEN`	The specified Channel has been reused to play another Sound.
`ERR_DMA`	DMA Failure. See debug output for more information.
`ERR_DSP_CONNECTION`	DSP connection error. Connection possibly caused a cyclic dependency or connected dsps with incompatible buffer counts.
`ERR_DSP_DONTPROCESS`	DSP return code from a DSP process query callback. Tells mixer not to call the process callback and therefore not consume CPU. Use this to optimize the DSP graph.
`ERR_DSP_FORMAT`	DSP Format error. A DSP unit may have attempted to connect to this network with the wrong format, or a matrix may have been set with the wrong size if the target unit has a specified channel map.
`ERR_DSP_INUSE`	DSP is already in the mixer's DSP network. It must be removed before being reinserted or released.
`ERR_DSP_NOTFOUND`	DSP connection error. Couldn't find the DSP unit specified.
`ERR_DSP_RESERVED`	DSP operation error. Cannot perform operation on this DSP as it is reserved by the system.
`ERR_DSP_SILENCE`	DSP return code from a DSP process query callback. Tells mixer silence would be produced from read, so go idle and not consume CPU. Use this to optimize the DSP graph.
`ERR_DSP_TYPE`	DSP operation cannot be performed on a DSP of this type.
`ERR_FILE_BAD`	Error loading file.
`ERR_FILE_COULDNOTSEEK`	Couldn't perform seek operation. This is a limitation of the medium (i.e. netstreams) or the file format.
`ERR_FILE_DISKEJECTED`	Media was ejected while reading.
`ERR_FILE_EOF`	End of file unexpectedly reached while trying to read essential data (truncated?).
`ERR_FILE_ENDOFDATA`	End of current chunk reached while trying to read data.
`ERR_FILE_NOTFOUND`	File not found.
`ERR_FORMAT`	Unsupported file or audio format.
`ERR_HEADER_MISMATCH`	There is a version mismatch between the FMOD header and either the FMOD Studio library or the FMOD Core library.
`ERR_HTTP`	A HTTP error occurred. This is a catch-all for HTTP errors not listed elsewhere.
`ERR_HTTP_ACCESS`	The specified resource requires authentication or is forbidden.
`ERR_HTTP_PROXY_AUTH`	Proxy authentication is required to access the specified resource.
`ERR_HTTP_SERVER_ERROR`	A HTTP server error occurred.
`ERR_HTTP_TIMEOUT`	The HTTP request timed out.
`ERR_INITIALIZATION`	FMOD was not initialized correctly to support this function.
`ERR_INITIALIZED`	Cannot call this command after fmod_system_init.
`ERR_INTERNAL`	An error occured in the FMOD system. Use the logging version of FMOD for more information.
`ERR_INVALID_FLOAT`	Value passed in was a `NaN`, `infinity` or denormalized float.
`ERR_INVALID_HANDLE`	An invalid object handle was used.
`ERR_INVALID_PARAM`	An invalid parameter was passed to this function.
`ERR_INVALID_POSITION`	An invalid seek position was passed to this function.
`ERR_INVALID_SPEAKER`	An invalid speaker was passed to this function based on the current speaker mode.
`ERR_INVALID_SYNCPOINT`	The syncpoint did not come from this Sound handle.
`ERR_INVALID_THREAD`	Tried to call a function on a thread that is not supported.
`ERR_INVALID_VECTOR`	The vectors passed in are not unit length, or perpendicular.
`ERR_MAXAUDIBLE`	Reached maximum audible playback count for this Sound's SoundGroup.
`ERR_MEMORY`	Not enough memory or resources.
`ERR_MEMORY_CANTPOINT`	Can't use `FMOD_MODE.OPENMEMORY_POINT` on non PCM source data, or non mp3/xma/adpcm data if `FMOD_MODE.CREATECOMPRESSEDSAMPLE` was used.

Member	Description
`CHANNEL`	Type representing Channel
`CHANNELGROUP`	Type representing ChannelGroup

Member	Description
`MIXER`	Thread responsible for mixing and processing blocks of audio.
`FEEDER`	Thread used by some output plugins for transferring buffered audio from `FMOD_THREAD_TYPE.MIXER` to the sound output device.
`STREAM`	Thread that decodes compressed audio to PCM for Sounds created as `FMOD_MODE.CREATESTREAM`.
`FILE`	Thread that reads compressed audio from disk to be consumed by `FMOD_THREAD_TYPE.STREAM`.
`NONBLOCKING`	Thread that processes the creation of Sounds asynchronously when opened with `FMOD_MODE.NONBLOCKING`.
`RECORD`	Thread used by some output plugins for transferring audio from a microphone to `FMOD_THREAD_TYPE.MIXER`.
`GEOMETRY`	Thread used by the Geometry system for performing background calculations.
`PROFILER`	Thread for network communication when using `FMOD_INIT.PROFILE_ENABLE`.
`STUDIO_UPDATE`	Thread for processing Studio API commands and scheduling sound playback.
`STUDIO_LOAD_BANK`	Thread for asynchronously loading Studio::Bank metadata.
`STUDIO_LOAD_SAMPLE`	Thread for asynchronously loading Studio::Bank sample data.
`CONVOLUTION1`	Thread for processing medium size delay lines for `FMOD_DSP_TYPE.CONVOLUTIONREVERB`.
`CONVOLUTION2`	Thread for processing larger size delay lines for `FMOD_DSP_TYPE.CONVOLUTIONREVERB`.

Member	Description
`AUTODETECT`	Picks the best output mode for the platform. This is the default.
`UNKNOWN`	All - 3rd party plugin, unknown. This is for use with fmod_system_get_output only.
`NOSOUND`	All - Perform all mixing but discard the final output.
`WAVWRITER`	All - Writes output to a .wav file.
`NOSOUND_NRT`	All - Non-realtime version of `FMOD_OUTPUTTYPE.NOSOUND`, one mix per fmod_system_update.
`WAVWRITER_NRT`	All - Non-realtime version of `FMOD_OUTPUTTYPE.WAVWRITER`, one mix per fmod_system_update.
`WASAPI`	Win / UWP / Xbox One / Game Core - Windows Audio Session API. (Default on Windows, Xbox One, Game Core and UWP)
`ASIO`	Win - Low latency ASIO 2.0.
`PULSEAUDIO`	Linux - Pulse Audio. (Default on Linux if available)
`ALSA`	Linux - Advanced Linux Sound Architecture. (Default on Linux if PulseAudio isn't available)
`COREAUDIO`	Mac / iOS - Core Audio. (Default on Mac and iOS)
`AUDIOTRACK`	Android - Java Audio Track. (Default on Android 2.2 and below)
`OPENSL`	Android - OpenSL ES. (Default on Android 2.3 up to 7.1)
`AUDIOOUT`	PS4 / PS5 - Audio Out. (Default on PS4, PS5)
`AUDIO3D`	PS4 - Audio3D.
`WEBAUDIO`	HTML5 - Web Audio ScriptProcessorNode output. (Default on HTML5 if AudioWorkletNode isn't available)
`NNAUDIO`	Switch - nn::audio. (Default on Switch)
`WINSONIC`	Win10 / Xbox One / Game Core - Windows Sonic.
`AAUDIO`	Android - AAudio. (Default on Android 8.1 and above)
`AUDIOWORKLET`	HTML5 - Web Audio AudioWorkletNode output. (Default on HTML5 if available)
`PHASE`	iOS - PHASE framework. (Disabled)
`OHAUDIO`	OpenHarmony - OHAudio.

Member	Description
`TTY`	Default log location per platform, i.e. Visual Studio output window, stderr, LogCat, etc.
`FILE`	Write log to specified file path.
`CALLBACK`	Call specified callback with log information.

Member	Description
`DEFAULT`	Default speaker mode for the chosen output mode which will resolve after fmod_system_init.
`RAW`	Assume there is no special mapping from a given channel to a speaker, channels map 1:1 in order. Use fmod_system_set_software_format to specify the speaker count.
`MONO`	1 speaker setup (monaural).
`STEREO`	2 speaker setup (stereo) front left, front right.
`QUAD`	4 speaker setup (4.0) front left, front right, surround left, surround right.
`SURROUND`	5 speaker setup (5.0) front left, front right, center, surround left, surround right.
`_5POINT1`	6 speaker setup (5.1) front left, front right, center, low frequency, surround left, surround right.
`_7POINT1`	8 speaker setup (7.1) front left, front right, center, low frequency, surround left, surround right, back left, back right.
`_7POINT1POINT4`	12 speaker setup (7.1.4) front left, front right, center, low frequency, surround left, surround right, back left, back right, top front left, top front right, top back left, top back right.

Member	Description
`NONE`	No speaker
`FRONT_LEFT`	The front left speaker
`FRONT_RIGHT`	The front right speaker
`FRONT_CENTER`	The front center speaker
`LOW_FREQUENCY`	The LFE or 'subwoofer' speaker
`SURROUND_LEFT`	The surround left (usually to the side) speaker
`SURROUND_RIGHT`	The surround right (usually to the side) speaker
`BACK_LEFT`	The back left speaker
`BACK_RIGHT`	The back right speaker
`TOP_FRONT_LEFT`	The top front left speaker
`TOP_FRONT_RIGHT`	The top front right speaker
`TOP_BACK_LEFT`	The top back left speaker
`TOP_BACK_RIGHT`	The top back right speaker

Member	Description
`DEFAULT`	Left, Right, Center, LFE, Surround Left, Surround Right, Back Left, Back Right (see FMOD_SPEAKER enumeration)
`WAVEFORMAT`	Left, Right, Center, LFE, Back Left, Back Right, Surround Left, Surround Right (as per Microsoft .wav WAVEFORMAT structure master order)
`PROTOOLS`	Left, Center, Right, Surround Left, Surround Right, LFE
`ALLMONO`	Mono, Mono, Mono, Mono, Mono, Mono, ... (each channel up to `FMOD_MAX_CHANNEL_WIDTH` treated as mono)
`ALLSTEREO`	Left, Right, Left, Right, Left, Right, ... (each pair of channels up to `FMOD_MAX_CHANNEL_WIDTH` treated as stereo)
`ALSA`	Left, Right, Surround Left, Surround Right, Center, LFE (as per Linux ALSA channel order)

Member	Description
`OUTPUT`	Audio output interface plugin represented with `FMOD_OUTPUT_DESCRIPTION`.
`CODEC`	File format codec plugin represented with `FMOD_CODEC_DESCRIPTION`.
`DSP`	DSP unit plugin represented with `FMOD_DSP_DESCRIPTION`.

Member	Description
`UNKNOWN`	Unknown or custom codec plugin.
`AIFF`	Audio Interchange File Format (.aif, .aiff). Uncompressed integer formats only.
`ASF`	Microsoft Advanced Systems Format (.asf, .wma, .wmv). Platform provided decoder, available only on Windows.
`DLS`	Downloadable Sound (.dls). Multi-sound bank format used by MIDI (.mid).
`FLAC`	Free Lossless Audio Codec (.flac).
`FSB`	FMOD Sample Bank (.fsb). Proprietary multi-sound bank format. Supported encodings: PCM16, FADPCM, Vorbis, AT9, XMA, Opus.
`IT`	Impulse Tracker (.it).
`MIDI`	Musical Instrument Digital Interface (.mid).
`MOD`	Protracker / Fasttracker Module File (.mod).
`MPEG`	Moving Picture Experts Group (.mp2, .mp3). Also supports .wav (RIFF) container format.
`OGGVORBIS`	Ogg Vorbis (.ogg).
`PLAYLIST`	Play list information container (.asx, .pls, .m3u, .wax). No audio, tags only.
`RAW`	Raw uncompressed PCM data (.raw).
`S3M`	ScreamTracker 3 Module (.s3m).
`USER`	User created sound.
`WAV`	Microsoft Waveform Audio File Format (.wav). Supported encodings: Uncompressed PCM, IMA ADPCM. Platform provided ACM decoder extensions, available only on Windows.
`XM`	FastTracker 2 Extended Module (.xm).
`XMA`	Microsoft XMA bit-stream supported by FSB (.fsb) container format. Platform provided decoder, available only on Xbox.
`AUDIOQUEUE`	Apple Audio Queue decoder (.mp4, .m4a, .mp3). Supported encodings: AAC, ALAC, MP3. Platform provided decoder, available only on iOS / tvOS devices.
`AT9`	Sony ATRAC9 bit-stream supported by FSB (.fsb) container format. Platform provided decoder, available only on PlayStation.
`VORBIS`	Vorbis bit-stream supported by FSB (.fsb) container format.
`MEDIA_FOUNDATION`	Microsoft Media Foundation decoder (.asf, .wma, .wmv, .mp4, .m4a). Platform provided decoder, available only on UWP.
`MEDIACODEC`	Google Media Codec decoder (.m4a, .mp4). Platform provided decoder, available only on Android.
`FADPCM`	FMOD Adaptive Differential Pulse Code Modulation bit-stream supported by FSB (.fsb) container format.
`OPUS`	Opus bit-stream supported by FSB (.fsb) container format. Platform provided decoder, available only on Xbox Series X

Member	Description
`NONE`	Uninitalized / unknown.
`PCM8`	8bit integer PCM data.
`PCM16`	16bit integer PCM data.
`PCM24`	24bit integer PCM data.
`PCM32`	32bit integer PCM data.
`PCMFLOAT`	32bit floating point PCM data.
`BITSTREAM`	Sound data is in its native compressed format. See `FMOD_MODE.CREATECOMPRESSEDSAMPLE`

Member	Description
`READY`	Opened and ready to play.
`LOADING`	Initial load in progress.
`ERROR`	Failed to open - file not found, out of memory, etc. See return value of fmod_sound_get_open_state for what happened.
`CONNECTING`	Connecting to remote host (internet sounds only).
`BUFFERING`	Buffering data.
`SEEKING`	Seeking to subsound and re-flushing stream buffer.
`PLAYING`	Ready and playing, but not possible to release at this time without stalling the main thread.
`SETPOSITION`	Seeking within a stream to a different position.

constants

Constants

Constants

FMOD_VERSION

FMOD_DEBUG_FLAGS

FMOD_MEMORY_TYPE

FMOD_INIT

FMOD_DRIVER_STATE

FMOD_TIMEUNIT

FMOD_SYSTEM_CALLBACK

FMOD_MODE

FMOD_CHANNELMASK

FMOD_PORT_INDEX

FMOD_THREAD_PRIORITY

FMOD_THREAD_STACK_SIZE

FMOD_THREAD_AFFINITY

FMOD_REVERB_PRESETS

FMOD_MAX_CHANNEL_WIDTH

FMOD_MAX_SYSTEMS

FMOD_MAX_LISTENERS

FMOD_REVERB_MAXINSTANCES

FMOD_THREAD_TYPE

FMOD_RESULT

FMOD_CHANNELCONTROL_TYPE

FMOD_OUTPUTTYPE

FMOD_DEBUG_MODE

FMOD_SPEAKERMODE

FMOD_SPEAKER

FMOD_CHANNELORDER

FMOD_PLUGINTYPE

FMOD_SOUND_TYPE

FMOD_SOUND_FORMAT

FMOD_OPENSTATE

FMOD_SOUNDGROUP_BEHAVIOR

FMOD_CHANNELCONTROL_CALLBACK_TYPE

FMOD_CHANNELCONTROL_DSP_INDEX

FMOD_ERRORCALLBACK_INSTANCETYPE

FMOD_DSP_RESAMPLER

FMOD_DSP_CALLBACK_TYPE

FMOD_DSPCONNECTION_TYPE

FMOD_TAGTYPE

FMOD_TAGDATATYPE

FMOD_PORT_TYPE

FMOD_CODEC_SEEK_METHOD

FMOD_DSP_TYPE

FMOD_DSP_OSCILLATOR

FMOD_DSP_LOWPASS

FMOD_DSP_ITLOWPASS

FMOD_DSP_HIGHPASS

FMOD_DSP_ECHO

FMOD_DSP_FADER

FMOD_DSP_FLANGE

FMOD_DSP_DISTORTION

FMOD_DSP_NORMALIZE

FMOD_DSP_LIMITER

FMOD_DSP_PARAMEQ

FMOD_DSP_MULTIBAND_EQ

FMOD_DSP_MULTIBAND_EQ_FILTER_TYPE

FMOD_DSP_PITCHSHIFT

FMOD_DSP_CHORUS

FMOD_DSP_ITECHO

FMOD_DSP_COMPRESSOR

FMOD_DSP_SFXREVERB

FMOD_DSP_LOWPASS_SIMPLE

FMOD_DSP_DELAY

FMOD_DSP_TREMOLO

FMOD_DSP_SEND

FMOD_DSP_RETURN

FMOD_DSP_HIGHPASS_SIMPLE

FMOD_DSP_PAN_2D_STEREO_MODE_TYPE

FMOD_DSP_PAN_MODE_TYPE

FMOD_DSP_PAN_3D_ROLLOFF_TYPE

FMOD_DSP_PAN_3D_EXTENT_MODE_TYPE

FMOD_DSP_PAN

FMOD_DSP_THREE_EQ_CROSSOVERSLOPE_TYPE

FMOD_DSP_THREE_EQ

FMOD_DSP_FFT_WINDOW

FMOD_DSP_FFT

FMOD_DSP_LOUDNESS_METER

FMOD_DSP_LOUDNESS_METER_STATE_TYPE

Member	Description
`FAIL`	Excess sounds will fail when calling fmod_system_play_sound.
`MUTE`	Excess sounds will begin mute and will become audible when sufficient sounds are stopped.
`STEALLOWEST`	Excess sounds will steal from the quietest Sound playing in the group.

Member	Description
`END`	Called when a sound ends. Supported by Channel only.
`VIRTUALVOICE`	Called when a Channel is made virtual or real. Supported by Channel objects only.
`SYNCPOINT`	Called when a syncpoint is encountered. Can be from wav file markers or user added. Supported by Channel only.
`OCCLUSION`	Called when geometry occlusion values are calculated. Can be used to clamp or change the value. Supported by Channel and ChannelGroup.

Member	Description
`HEAD`	Head of the DSP chain, equivalent of index 0.
`FADER`	Built-in fader DSP.
`TAIL`	Tail of the DSP chain, equivalent of the number of DSPs minus 1.

Member	Description
`NONE`	Type representing no known instance type.
`SYSTEM`	Type representing System.
`CHANNEL`	Type representing Channel.
`CHANNELGROUP`	Type representing ChannelGroup.
`CHANNELCONTROL`	Type representing ChannelControl.https://www.fmod.com/docs/2.02/api/core-api-channelcontrol.html
`SOUND`	Type representing Sound.
`SOUNDGROUP`	Type representing SoundGroup.
`DSP`	Type representing DSP.
`DSPCONNECTION`	Type representing DSPConnection.
`GEOMETRY`	Type representing Geometry.
`REVERB3D`	Type representing Reverb3D.
`STUDIO_SYSTEM`	Type representing Studio::System.
`STUDIO_EVENTDESCRIPTION`	Type representing Studio::EventDescription.
`STUDIO_EVENTINSTANCE`	Type representing Studio::EventInstance.
`STUDIO_PARAMETERINSTANCE`	Deprecated.
`STUDIO_BUS`	Type representing Studio::Bus.
`STUDIO_VCA`	Type representing Studio::VCA.
`STUDIO_BANK`	Type representing Studio::Bank.
`STUDIO_COMMANDREPLAY`	Type representing Studio::CommandReplay.

Member	Description
`DEFAULT`	Default interpolation method, same as `FMOD_DSP_RESAMPLER.LINEAR`.
`NOINTERP`	No interpolation. High frequency aliasing hiss will be audible depending on the sample rate of the sound.
`LINEAR`	Linear interpolation (default method). Fast and good quality, causes very slight lowpass effect on low frequency sounds.
`CUBIC`	Cubic interpolation. Slower than linear interpolation but better quality.
`SPLINE`	5 point spline interpolation. Slowest resampling method but best quality.

Member	Description
`STANDARD`	Default connection type. Audio is mixed from the input to the output DSP's audible buffer.
`SIDECHAIN`	Sidechain connection type. Audio is mixed from the input to the output DSP's sidechain buffer.
`SEND`	Send connection type. Audio is mixed from the input to the output DSP's audible buffer, but the input is NOT executed, only copied from. A standard connection or sidechain needs to make an input execute to generate data.
`SEND_SIDECHAIN`	Send sidechain connection type. Audio is mixed from the input to the output DSP's sidechain buffer, but the input is NOT executed, only copied from. A standard connection or sidechain needs to make an input execute to generate data.

Member	Description
`UNKNOWN`	Tag type that is not recognized by FMOD
`ID3V1`	MP3 ID3 Tag 1.0. Typically 1 tag stored 128 bytes from end of an MP3 file.
`ID3V2`	MP3 ID3 Tag 2.0. Variable length tags with more than 1 possible.
`VORBISCOMMENT`	Metadata container used in Vorbis, FLAC, Theora, Speex and Opus file formats.
`SHOUTCAST`	SHOUTcast internet stream metadata which can be issued during playback.
`ICECAST`	Icecast internet stream metadata which can be issued during playback.
`ASF`	Advanced Systems Format metadata typically associated with Windows Media formats such as WMA.
`MIDI`	Metadata stored inside a MIDI file.
`PLAYLIST`	Playlist files such as PLS,M3U,ASX and WAX will populate playlist information through this tag type.
`FMOD`	Tag type used by FMOD's MIDI, MOD, S3M, XM, IT format support, and netstreams to notify of internet stream events like a sample rate change.
`USER`	For codec developers, this tag type can be used with `FMOD_CODEC_METADATA_FUNC` to generate custom metadata.

Member	Description
`BINARY`	Raw binary data. see FmodSoundTag structure for length of data in bytes.
`INT`	Integer - Note this integer could be 8bit / 16bit / 32bit / 64bit. See FmodSoundTag structure for integer size (1 vs 2 vs 4 vs 8 bytes).
`FLOAT`	IEEE floating point number. See FmodSoundTag structure to confirm if the float data is 32bit or 64bit (4 vs 8 bytes).
`STRING`	8bit ASCII char string. See FmodSoundTag structure for string length in bytes.
`STRING_UTF16`	16bit UTF string. Assume little endian byte order. See FmodSoundTag structure for string length in bytes.
`STRING_UTF16BE`	16bit UTF string Big endian byte order. See FmodSoundTag structure for string length in bytes.
`STRING_UTF8`	8 bit UTF string. See FmodSoundTag structure for string length in bytes.

Member	Description
`MUSIC`	Background music, pass `FMOD_PORT_INDEX.NONE` as port index.
`COPYRIGHT_MUSIC`	Copyright background music, pass `FMOD_PORT_INDEX.NONE` as port index.
`VOICE`	Voice chat, pass platform specific user ID of desired user as port index.
`CONTROLLER`	Controller speaker, pass platform specific user ID of desired user as port index.
`PERSONAL`	Personal audio device, pass platform specific user ID of desired user as port index.
`VIBRATION`	Controller vibration, pass platform specific user ID of desired user as port index.
`AUX`	Auxiliary output port, pass `FMOD_PORT_INDEX.NONE` as port index.

Member	Description
`SET`	Seeks from the beginning.
`CURRENT`	Seeks from the current position.
`END`	Seeks from the end.