C# Class FMOD.Studio.System

Inheritance: HandleBase
Show file Open project: fmod/UnityIntegration Class Usage Examples

Public Methods

Method Description
System ( IntPtr raw ) : System
create ( System &studiosystem ) : RESULT
flushCommands ( ) : RESULT
flushSampleLoading ( ) : RESULT
getAdvancedSettings ( ADVANCEDSETTINGS &settings ) : RESULT
getBank ( string path, Bank &bank ) : RESULT
getBankByID ( System.Guid guid, Bank &bank ) : RESULT
getBankCount ( int &count ) : RESULT
getBankList ( Bank &array ) : RESULT
getBufferUsage ( BUFFER_USAGE &usage ) : RESULT
getBus ( string path, Bus &bus ) : RESULT
getBusByID ( System.Guid guid, Bus &bus ) : RESULT
getCPUUsage ( CPU_USAGE &usage ) : RESULT
getEvent ( string path, EventDescription &_event ) : RESULT
getEventByID ( System.Guid guid, EventDescription &_event ) : RESULT
getListenerAttributes ( int listener, FMOD.Studio.ATTRIBUTES_3D &attributes ) : RESULT
getLowLevelSystem ( FMOD &system ) : RESULT
getNumListeners ( int &numlisteners ) : RESULT
getSoundInfo ( string key, SOUND_INFO &info ) : RESULT
getUserData ( IntPtr &userData ) : RESULT
getVCA ( string path, VCA &vca ) : RESULT
getVCAByID ( System.Guid guid, VCA &vca ) : RESULT
initialize ( int maxchannels, INITFLAGS studioFlags, FMOD flags, IntPtr extradriverdata ) : RESULT
loadBankCustom ( BANK_INFO info, LOAD_BANK_FLAGS flags, Bank &bank ) : RESULT
loadBankFile ( string name, LOAD_BANK_FLAGS flags, Bank &bank ) : RESULT
loadBankMemory ( byte buffer, LOAD_BANK_FLAGS flags, Bank &bank ) : RESULT
loadCommandReplay ( string path, COMMANDREPLAY_FLAGS flags, CommandReplay &replay ) : RESULT
lookupID ( string path, System.Guid &guid ) : RESULT
lookupPath ( System.Guid guid, string &path ) : RESULT
release ( ) : RESULT
resetBufferUsage ( ) : RESULT
setAdvancedSettings ( ADVANCEDSETTINGS settings ) : RESULT
setCallback ( SYSTEM_CALLBACK callback, SYSTEM_CALLBACK_TYPE callbackmask = SYSTEM_CALLBACK_TYPE.ALL ) : RESULT
setListenerAttributes ( int listener, FMOD.Studio.ATTRIBUTES_3D attributes ) : RESULT
setNumListeners ( int numlisteners ) : RESULT
setUserData ( IntPtr userData ) : RESULT
startCommandCapture ( string path, COMMANDCAPTURE_FLAGS flags ) : RESULT
stopCommandCapture ( ) : RESULT
unloadAll ( ) : RESULT
update ( ) : RESULT

Protected Methods

Method Description
isValidInternal ( ) : bool

Private Methods

Method Description
FMOD_Studio_System_Create ( IntPtr &studiosystem, uint headerversion ) : RESULT
FMOD_Studio_System_FlushCommands ( IntPtr studiosystem ) : RESULT
FMOD_Studio_System_FlushSampleLoading ( IntPtr studiosystem ) : RESULT
FMOD_Studio_System_GetAdvancedSettings ( IntPtr studiosystem, ADVANCEDSETTINGS &settings ) : RESULT
FMOD_Studio_System_GetBank ( IntPtr studiosystem, byte path, IntPtr &bank ) : RESULT
FMOD_Studio_System_GetBankByID ( IntPtr studiosystem, byte guid, IntPtr &bank ) : RESULT
FMOD_Studio_System_GetBankCount ( IntPtr studiosystem, int &count ) : RESULT
FMOD_Studio_System_GetBankList ( IntPtr studiosystem, IntPtr array, int capacity, int &count ) : RESULT
FMOD_Studio_System_GetBufferUsage ( IntPtr studiosystem, BUFFER_USAGE &usage ) : RESULT
FMOD_Studio_System_GetBus ( IntPtr studiosystem, byte path, IntPtr &bus ) : RESULT
FMOD_Studio_System_GetBusByID ( IntPtr studiosystem, byte guid, IntPtr &bus ) : RESULT
FMOD_Studio_System_GetCPUUsage ( IntPtr studiosystem, CPU_USAGE &usage ) : RESULT
FMOD_Studio_System_GetEvent ( IntPtr studiosystem, byte path, IntPtr &description ) : RESULT
FMOD_Studio_System_GetEventByID ( IntPtr studiosystem, byte guid, IntPtr &description ) : RESULT
FMOD_Studio_System_GetListenerAttributes ( IntPtr studiosystem, int listener, FMOD.Studio.ATTRIBUTES_3D &attributes ) : RESULT
FMOD_Studio_System_GetLowLevelSystem ( IntPtr studiosystem, IntPtr &system ) : RESULT
FMOD_Studio_System_GetNumListeners ( IntPtr studiosystem, int &numlisteners ) : RESULT
FMOD_Studio_System_GetSoundInfo ( IntPtr studiosystem, byte key, IntPtr info ) : RESULT
FMOD_Studio_System_GetUserData ( IntPtr studiosystem, IntPtr &userData ) : RESULT
FMOD_Studio_System_GetVCA ( IntPtr studiosystem, byte path, IntPtr &vca ) : RESULT
FMOD_Studio_System_GetVCAByID ( IntPtr studiosystem, byte guid, IntPtr &vca ) : RESULT
FMOD_Studio_System_Initialize ( IntPtr studiosystem, int maxchannels, INITFLAGS studioFlags, FMOD flags, IntPtr extradriverdata ) : RESULT
FMOD_Studio_System_IsValid ( IntPtr studiosystem ) : bool
FMOD_Studio_System_LoadBankCustom ( IntPtr studiosystem, BANK_INFO &info, LOAD_BANK_FLAGS flags, IntPtr &bank ) : RESULT
FMOD_Studio_System_LoadBankFile ( IntPtr studiosystem, byte filename, LOAD_BANK_FLAGS flags, IntPtr &bank ) : RESULT
FMOD_Studio_System_LoadBankMemory ( IntPtr studiosystem, IntPtr buffer, int length, LOAD_MEMORY_MODE mode, LOAD_BANK_FLAGS flags, IntPtr &bank ) : RESULT
FMOD_Studio_System_LoadCommandReplay ( IntPtr studiosystem, byte path, COMMANDREPLAY_FLAGS flags, IntPtr &commandReplay ) : RESULT
FMOD_Studio_System_LookupID ( IntPtr studiosystem, byte path, [ guid ) : RESULT
FMOD_Studio_System_LookupPath ( IntPtr studiosystem, byte guid, [ path, int size, int &retrieved ) : RESULT
FMOD_Studio_System_Release ( IntPtr studiosystem ) : RESULT
FMOD_Studio_System_ResetBufferUsage ( IntPtr studiosystem ) : RESULT
FMOD_Studio_System_SetAdvancedSettings ( IntPtr studiosystem, ADVANCEDSETTINGS &settings ) : RESULT
FMOD_Studio_System_SetCallback ( IntPtr studiosystem, SYSTEM_CALLBACK callback, SYSTEM_CALLBACK_TYPE callbackmask ) : RESULT
FMOD_Studio_System_SetListenerAttributes ( IntPtr studiosystem, int listener, FMOD.Studio.ATTRIBUTES_3D &attributes ) : RESULT
FMOD_Studio_System_SetNumListeners ( IntPtr studiosystem, int numlisteners ) : RESULT
FMOD_Studio_System_SetUserData ( IntPtr studiosystem, IntPtr userData ) : RESULT
FMOD_Studio_System_StartCommandCapture ( IntPtr studiosystem, byte path, COMMANDCAPTURE_FLAGS flags ) : RESULT
FMOD_Studio_System_StopCommandCapture ( IntPtr studiosystem ) : RESULT
FMOD_Studio_System_UnloadAll ( IntPtr studiosystem ) : RESULT
FMOD_Studio_System_Update ( IntPtr studiosystem ) : RESULT

Method Details

System() public method

public System ( IntPtr raw ) : System
raw System.IntPtr
return System

create() public static method

public static create ( System &studiosystem ) : RESULT
studiosystem System
return RESULT

flushCommands() public method

public flushCommands ( ) : RESULT
return RESULT

flushSampleLoading() public method

public flushSampleLoading ( ) : RESULT
return RESULT

getAdvancedSettings() public method

public getAdvancedSettings ( ADVANCEDSETTINGS &settings ) : RESULT
settings ADVANCEDSETTINGS
return RESULT

getBank() public method

public getBank ( string path, Bank &bank ) : RESULT
path string
bank Bank
return RESULT

getBankByID() public method

public getBankByID ( System.Guid guid, Bank &bank ) : RESULT
guid System.Guid
bank Bank
return RESULT

getBankCount() public method

public getBankCount ( int &count ) : RESULT
count int
return RESULT

getBankList() public method

public getBankList ( Bank &array ) : RESULT
array Bank
return RESULT

getBufferUsage() public method

public getBufferUsage ( BUFFER_USAGE &usage ) : RESULT
usage BUFFER_USAGE
return RESULT

getBus() public method

public getBus ( string path, Bus &bus ) : RESULT
path string
bus Bus
return RESULT

getBusByID() public method

public getBusByID ( System.Guid guid, Bus &bus ) : RESULT
guid System.Guid
bus Bus
return RESULT

getCPUUsage() public method

public getCPUUsage ( CPU_USAGE &usage ) : RESULT
usage CPU_USAGE
return RESULT

getEvent() public method

public getEvent ( string path, EventDescription &_event ) : RESULT
path string
_event EventDescription
return RESULT

getEventByID() public method

public getEventByID ( System.Guid guid, EventDescription &_event ) : RESULT
guid System.Guid
_event EventDescription
return RESULT

getListenerAttributes() public method

public getListenerAttributes ( int listener, FMOD.Studio.ATTRIBUTES_3D &attributes ) : RESULT
listener int
attributes FMOD.Studio.ATTRIBUTES_3D
return RESULT

getLowLevelSystem() public method

public getLowLevelSystem ( FMOD &system ) : RESULT
system FMOD
return RESULT

getNumListeners() public method

public getNumListeners ( int &numlisteners ) : RESULT
numlisteners int
return RESULT

getSoundInfo() public method

public getSoundInfo ( string key, SOUND_INFO &info ) : RESULT
key string
info SOUND_INFO
return RESULT

getUserData() public method

public getUserData ( IntPtr &userData ) : RESULT
userData System.IntPtr
return RESULT

getVCA() public method

public getVCA ( string path, VCA &vca ) : RESULT
path string
vca VCA
return RESULT

getVCAByID() public method

public getVCAByID ( System.Guid guid, VCA &vca ) : RESULT
guid System.Guid
vca VCA
return RESULT

initialize() public method

public initialize ( int maxchannels, INITFLAGS studioFlags, FMOD flags, IntPtr extradriverdata ) : RESULT
maxchannels int
studioFlags INITFLAGS
flags FMOD
extradriverdata System.IntPtr
return RESULT

isValidInternal() protected method

protected isValidInternal ( ) : bool
return bool

loadBankCustom() public method

public loadBankCustom ( BANK_INFO info, LOAD_BANK_FLAGS flags, Bank &bank ) : RESULT
info BANK_INFO
flags LOAD_BANK_FLAGS
bank Bank
return RESULT

loadBankFile() public method

public loadBankFile ( string name, LOAD_BANK_FLAGS flags, Bank &bank ) : RESULT
name string
flags LOAD_BANK_FLAGS
bank Bank
return RESULT

loadBankMemory() public method

public loadBankMemory ( byte buffer, LOAD_BANK_FLAGS flags, Bank &bank ) : RESULT
buffer byte
flags LOAD_BANK_FLAGS
bank Bank
return RESULT

loadCommandReplay() public method

public loadCommandReplay ( string path, COMMANDREPLAY_FLAGS flags, CommandReplay &replay ) : RESULT
path string
flags COMMANDREPLAY_FLAGS
replay CommandReplay
return RESULT

lookupID() public method

public lookupID ( string path, System.Guid &guid ) : RESULT
path string
guid System.Guid
return RESULT

lookupPath() public method

public lookupPath ( System.Guid guid, string &path ) : RESULT
guid System.Guid
path string
return RESULT

release() public method

public release ( ) : RESULT
return RESULT

resetBufferUsage() public method

public resetBufferUsage ( ) : RESULT
return RESULT

setAdvancedSettings() public method

public setAdvancedSettings ( ADVANCEDSETTINGS settings ) : RESULT
settings ADVANCEDSETTINGS
return RESULT

setCallback() public method

public setCallback ( SYSTEM_CALLBACK callback, SYSTEM_CALLBACK_TYPE callbackmask = SYSTEM_CALLBACK_TYPE.ALL ) : RESULT
callback SYSTEM_CALLBACK
callbackmask SYSTEM_CALLBACK_TYPE
return RESULT

setListenerAttributes() public method

public setListenerAttributes ( int listener, FMOD.Studio.ATTRIBUTES_3D attributes ) : RESULT
listener int
attributes FMOD.Studio.ATTRIBUTES_3D
return RESULT

setNumListeners() public method

public setNumListeners ( int numlisteners ) : RESULT
numlisteners int
return RESULT

setUserData() public method

public setUserData ( IntPtr userData ) : RESULT
userData System.IntPtr
return RESULT

startCommandCapture() public method

public startCommandCapture ( string path, COMMANDCAPTURE_FLAGS flags ) : RESULT
path string
flags COMMANDCAPTURE_FLAGS
return RESULT

stopCommandCapture() public method

public stopCommandCapture ( ) : RESULT
return RESULT

unloadAll() public method

public unloadAll ( ) : RESULT
return RESULT

update() public method

public update ( ) : RESULT
return RESULT