FMOD.Studio Namespace Reference

Classes
struct	ADVANCEDSETTINGS
struct	Bank
struct	BANK_INFO
struct	BUFFER_INFO
struct	BUFFER_USAGE
struct	Bus
struct	COMMAND_INFO
struct	CommandReplay
struct	CPU_USAGE
struct	EventDescription
struct	EventInstance
struct	MEMORY_USAGE
struct	PARAMETER_DESCRIPTION
struct	PARAMETER_ID
struct	PLUGIN_INSTANCE_PROPERTIES
struct	PROGRAMMER_SOUND_PROPERTIES
struct	SOUND_INFO
class	STUDIO_VERSION
struct	System
struct	TIMELINE_BEAT_PROPERTIES
struct	TIMELINE_MARKER_PROPERTIES
struct	TIMELINE_NESTED_BEAT_PROPERTIES
struct	Union_IntBoolFloatString
struct	USER_PROPERTY
struct	Util
struct	VCA

Enumerations
enum	STOP_MODE : int { ALLOWFADEOUT , IMMEDIATE }
enum	LOADING_STATE : int {   UNLOADING , UNLOADED , LOADING , LOADED ,   ERROR }
enum	SYSTEM_CALLBACK_TYPE : uint {   PREUPDATE = 0x00000001 , POSTUPDATE = 0x00000002 , BANK_UNLOAD = 0x00000004 , LIVEUPDATE_CONNECTED = 0x00000008 ,   LIVEUPDATE_DISCONNECTED = 0x00000010 , ALL = 0xFFFFFFFF }
enum	PARAMETER_TYPE : int {   GAME_CONTROLLED , AUTOMATIC_DISTANCE , AUTOMATIC_EVENT_CONE_ANGLE , AUTOMATIC_EVENT_ORIENTATION ,   AUTOMATIC_DIRECTION , AUTOMATIC_ELEVATION , AUTOMATIC_LISTENER_ORIENTATION , AUTOMATIC_SPEED ,   AUTOMATIC_SPEED_ABSOLUTE , AUTOMATIC_DISTANCE_NORMALIZED , MAX }
enum	PARAMETER_FLAGS : uint {   READONLY = 0x00000001 , AUTOMATIC = 0x00000002 , GLOBAL = 0x00000004 , DISCRETE = 0x00000008 ,   LABELED = 0x00000010 }
enum	LOAD_MEMORY_MODE : int { LOAD_MEMORY , LOAD_MEMORY_POINT }
enum	LOAD_MEMORY_ALIGNMENT : int { VALUE = 32 }
enum	USER_PROPERTY_TYPE : int { INTEGER , BOOLEAN , FLOAT , STRING }
enum	INITFLAGS : uint {   NORMAL = 0x00000000 , LIVEUPDATE = 0x00000001 , ALLOW_MISSING_PLUGINS = 0x00000002 , SYNCHRONOUS_UPDATE = 0x00000004 ,   DEFERRED_CALLBACKS = 0x00000008 , LOAD_FROM_UPDATE = 0x00000010 , MEMORY_TRACKING = 0x00000020 }
enum	LOAD_BANK_FLAGS : uint { NORMAL = 0x00000000 , NONBLOCKING = 0x00000001 , DECOMPRESS_SAMPLES = 0x00000002 , UNENCRYPTED = 0x00000004 }
enum	COMMANDCAPTURE_FLAGS : uint { NORMAL = 0x00000000 , FILEFLUSH = 0x00000001 , SKIP_INITIAL_STATE = 0x00000002 }
enum	COMMANDREPLAY_FLAGS : uint { NORMAL = 0x00000000 , SKIP_CLEANUP = 0x00000001 , FAST_FORWARD = 0x00000002 , SKIP_BANK_LOAD = 0x00000004 }
enum	PLAYBACK_STATE : int {   PLAYING , SUSTAINING , STOPPED , STARTING ,   STOPPING }
enum	EVENT_PROPERTY : int {   CHANNELPRIORITY , SCHEDULE_DELAY , SCHEDULE_LOOKAHEAD , MINIMUM_DISTANCE ,   MAXIMUM_DISTANCE , COOLDOWN , MAX }
enum	EVENT_CALLBACK_TYPE : uint {   CREATED = 0x00000001 , DESTROYED = 0x00000002 , STARTING = 0x00000004 , STARTED = 0x00000008 ,   RESTARTED = 0x00000010 , STOPPED = 0x00000020 , START_FAILED = 0x00000040 , CREATE_PROGRAMMER_SOUND = 0x00000080 ,   DESTROY_PROGRAMMER_SOUND = 0x00000100 , PLUGIN_CREATED = 0x00000200 , PLUGIN_DESTROYED = 0x00000400 , TIMELINE_MARKER = 0x00000800 ,   TIMELINE_BEAT = 0x00001000 , SOUND_PLAYED = 0x00002000 , SOUND_STOPPED = 0x00004000 , REAL_TO_VIRTUAL = 0x00008000 ,   VIRTUAL_TO_REAL = 0x00010000 , START_EVENT_COMMAND = 0x00020000 , NESTED_TIMELINE_BEAT = 0x00040000 , ALL = 0xFFFFFFFF }
enum	INSTANCETYPE : int {   NONE , SYSTEM , EVENTDESCRIPTION , EVENTINSTANCE ,   PARAMETERINSTANCE , BUS , VCA , BANK ,   COMMANDREPLAY }

Functions
delegate RESULT	SYSTEM_CALLBACK (IntPtr system, SYSTEM_CALLBACK_TYPE type, IntPtr commanddata, IntPtr userdata)
delegate RESULT	EVENT_CALLBACK (EVENT_CALLBACK_TYPE type, IntPtr _event, IntPtr parameters)
delegate RESULT	COMMANDREPLAY_FRAME_CALLBACK (IntPtr replay, int commandindex, float currenttime, IntPtr userdata)
delegate RESULT	COMMANDREPLAY_LOAD_BANK_CALLBACK (IntPtr replay, int commandindex, GUID bankguid, IntPtr bankfilename, LOAD_BANK_FLAGS flags, out IntPtr bank, IntPtr userdata)
delegate RESULT	COMMANDREPLAY_CREATE_INSTANCE_CALLBACK (IntPtr replay, int commandindex, IntPtr eventdescription, out IntPtr instance, IntPtr userdata)

Enumeration Type Documentation

COMMANDCAPTURE_FLAGS

enum FMOD.Studio.COMMANDCAPTURE_FLAGS : uint

Enumerator
NORMAL
FILEFLUSH
SKIP_INITIAL_STATE

COMMANDREPLAY_FLAGS

enum FMOD.Studio.COMMANDREPLAY_FLAGS : uint

Enumerator
NORMAL
SKIP_CLEANUP
FAST_FORWARD
SKIP_BANK_LOAD

EVENT_CALLBACK_TYPE

enum FMOD.Studio.EVENT_CALLBACK_TYPE : uint

Enumerator
CREATED
DESTROYED
STARTING
STARTED
RESTARTED
STOPPED
START_FAILED
CREATE_PROGRAMMER_SOUND
DESTROY_PROGRAMMER_SOUND
PLUGIN_CREATED
PLUGIN_DESTROYED
TIMELINE_MARKER
TIMELINE_BEAT
SOUND_PLAYED
SOUND_STOPPED
REAL_TO_VIRTUAL
VIRTUAL_TO_REAL
START_EVENT_COMMAND
NESTED_TIMELINE_BEAT
ALL

EVENT_PROPERTY

enum FMOD.Studio.EVENT_PROPERTY : int

Enumerator
CHANNELPRIORITY
SCHEDULE_DELAY
SCHEDULE_LOOKAHEAD
MINIMUM_DISTANCE
MAXIMUM_DISTANCE
COOLDOWN
MAX

INITFLAGS

enum FMOD.Studio.INITFLAGS : uint

Enumerator
NORMAL
LIVEUPDATE
ALLOW_MISSING_PLUGINS
SYNCHRONOUS_UPDATE
DEFERRED_CALLBACKS
LOAD_FROM_UPDATE
MEMORY_TRACKING

INSTANCETYPE

enum FMOD.Studio.INSTANCETYPE : int

Enumerator
NONE
SYSTEM
EVENTDESCRIPTION
EVENTINSTANCE
PARAMETERINSTANCE
BUS
VCA
BANK
COMMANDREPLAY

LOAD_BANK_FLAGS

enum FMOD.Studio.LOAD_BANK_FLAGS : uint

Enumerator
NORMAL
NONBLOCKING
DECOMPRESS_SAMPLES
UNENCRYPTED

LOAD_MEMORY_ALIGNMENT

enum FMOD.Studio.LOAD_MEMORY_ALIGNMENT : int

Enumerator
VALUE

LOAD_MEMORY_MODE

enum FMOD.Studio.LOAD_MEMORY_MODE : int

Enumerator
LOAD_MEMORY
LOAD_MEMORY_POINT

LOADING_STATE

enum FMOD.Studio.LOADING_STATE : int

Enumerator
UNLOADING
UNLOADED
LOADING
LOADED
ERROR

PARAMETER_FLAGS

enum FMOD.Studio.PARAMETER_FLAGS : uint

Enumerator
READONLY
AUTOMATIC
GLOBAL
DISCRETE
LABELED

PARAMETER_TYPE

enum FMOD.Studio.PARAMETER_TYPE : int

Enumerator
GAME_CONTROLLED
AUTOMATIC_DISTANCE
AUTOMATIC_EVENT_CONE_ANGLE
AUTOMATIC_EVENT_ORIENTATION
AUTOMATIC_DIRECTION
AUTOMATIC_ELEVATION
AUTOMATIC_LISTENER_ORIENTATION
AUTOMATIC_SPEED
AUTOMATIC_SPEED_ABSOLUTE
AUTOMATIC_DISTANCE_NORMALIZED
MAX

PLAYBACK_STATE

enum FMOD.Studio.PLAYBACK_STATE : int

Enumerator
PLAYING
SUSTAINING
STOPPED
STARTING
STOPPING

STOP_MODE

enum FMOD.Studio.STOP_MODE : int

Enumerator
ALLOWFADEOUT
IMMEDIATE

SYSTEM_CALLBACK_TYPE

enum FMOD.Studio.SYSTEM_CALLBACK_TYPE : uint

Enumerator
PREUPDATE
POSTUPDATE
BANK_UNLOAD
LIVEUPDATE_CONNECTED
LIVEUPDATE_DISCONNECTED
ALL

USER_PROPERTY_TYPE

enum FMOD.Studio.USER_PROPERTY_TYPE : int

Enumerator
INTEGER
BOOLEAN
FLOAT
STRING

Function Documentation

COMMANDREPLAY_CREATE_INSTANCE_CALLBACK()

delegate RESULT FMOD.Studio.COMMANDREPLAY_CREATE_INSTANCE_CALLBACK	(	IntPtr	replay,
		int	commandindex,
		IntPtr	eventdescription,
		out IntPtr	instance,
		IntPtr	userdata )

COMMANDREPLAY_FRAME_CALLBACK()

delegate RESULT FMOD.Studio.COMMANDREPLAY_FRAME_CALLBACK	(	IntPtr	replay,
		int	commandindex,
		float	currenttime,
		IntPtr	userdata )

COMMANDREPLAY_LOAD_BANK_CALLBACK()

delegate RESULT FMOD.Studio.COMMANDREPLAY_LOAD_BANK_CALLBACK	(	IntPtr	replay,
		int	commandindex,
		GUID	bankguid,
		IntPtr	bankfilename,
		LOAD_BANK_FLAGS	flags,
		out IntPtr	bank,
		IntPtr	userdata )

EVENT_CALLBACK()

delegate RESULT FMOD.Studio.EVENT_CALLBACK	(	EVENT_CALLBACK_TYPE	type,
		IntPtr	_event,
		IntPtr	parameters )

SYSTEM_CALLBACK()

delegate RESULT FMOD.Studio.SYSTEM_CALLBACK	(	IntPtr	system,
		SYSTEM_CALLBACK_TYPE	type,
		IntPtr	commanddata,
		IntPtr	userdata )