C# Class FMOD.Studio.EventDescription

Inheritance: HandleBase

Show file Open project: fmod/UnityIntegration Class Usage Examples

Public Methods

Method	Description
EventDescription ( IntPtr raw ) : System
createInstance ( EventInstance &instance ) : RESULT
getID ( System.Guid &id ) : RESULT
getInstanceCount ( int &count ) : RESULT
getInstanceList ( EventInstance &array ) : RESULT
getLength ( int &length ) : RESULT
getMaximumDistance ( float &distance ) : RESULT
getMinimumDistance ( float &distance ) : RESULT
getParameter ( string name, PARAMETER_DESCRIPTION &parameter ) : RESULT
getParameterByIndex ( int index, PARAMETER_DESCRIPTION &parameter ) : RESULT
getParameterCount ( int &count ) : RESULT
getPath ( string &path ) : RESULT
getSampleLoadingState ( LOADING_STATE &state ) : RESULT
getSoundSize ( float &size ) : RESULT
getUserData ( IntPtr &userData ) : RESULT
getUserProperty ( string name, USER_PROPERTY &property ) : RESULT
getUserPropertyByIndex ( int index, USER_PROPERTY &property ) : RESULT
getUserPropertyCount ( int &count ) : RESULT
hasCue ( bool &cue ) : RESULT
is3D ( bool &is3D ) : RESULT
isOneshot ( bool &oneshot ) : RESULT
isSnapshot ( bool &snapshot ) : RESULT
isStream ( bool &isStream ) : RESULT
loadSampleData ( ) : RESULT
releaseAllInstances ( ) : RESULT
setCallback ( EVENT_CALLBACK callback, EVENT_CALLBACK_TYPE callbackmask = EVENT_CALLBACK_TYPE.ALL ) : RESULT
setUserData ( IntPtr userData ) : RESULT
unloadSampleData ( ) : RESULT

Protected Methods

Method	Description
isValidInternal ( ) : bool

Private Methods

Method	Description
FMOD_Studio_EventDescription_CreateInstance ( IntPtr eventdescription, IntPtr &instance ) : RESULT
FMOD_Studio_EventDescription_GetID ( IntPtr eventdescription, [ id ) : RESULT
FMOD_Studio_EventDescription_GetInstanceCount ( IntPtr eventdescription, int &count ) : RESULT
FMOD_Studio_EventDescription_GetInstanceList ( IntPtr eventdescription, IntPtr array, int capacity, int &count ) : RESULT
FMOD_Studio_EventDescription_GetLength ( IntPtr eventdescription, int &length ) : RESULT
FMOD_Studio_EventDescription_GetMaximumDistance ( IntPtr eventdescription, float &distance ) : RESULT
FMOD_Studio_EventDescription_GetMinimumDistance ( IntPtr eventdescription, float &distance ) : RESULT
FMOD_Studio_EventDescription_GetParameter ( IntPtr eventdescription, byte name, PARAMETER_DESCRIPTION_INTERNAL &parameter ) : RESULT
FMOD_Studio_EventDescription_GetParameterByIndex ( IntPtr eventdescription, int index, PARAMETER_DESCRIPTION_INTERNAL &parameter ) : RESULT
FMOD_Studio_EventDescription_GetParameterCount ( IntPtr eventdescription, int &count ) : RESULT
FMOD_Studio_EventDescription_GetPath ( IntPtr eventdescription, [ path, int size, int &retrieved ) : RESULT
FMOD_Studio_EventDescription_GetSampleLoadingState ( IntPtr eventdescription, LOADING_STATE &state ) : RESULT
FMOD_Studio_EventDescription_GetSoundSize ( IntPtr eventdescription, float &size ) : RESULT
FMOD_Studio_EventDescription_GetUserData ( IntPtr eventdescription, IntPtr &userData ) : RESULT
FMOD_Studio_EventDescription_GetUserProperty ( IntPtr eventdescription, byte name, USER_PROPERTY_INTERNAL &property ) : RESULT
FMOD_Studio_EventDescription_GetUserPropertyByIndex ( IntPtr eventdescription, int index, USER_PROPERTY_INTERNAL &property ) : RESULT
FMOD_Studio_EventDescription_GetUserPropertyCount ( IntPtr eventdescription, int &count ) : RESULT
FMOD_Studio_EventDescription_HasCue ( IntPtr eventdescription, bool &cue ) : RESULT
FMOD_Studio_EventDescription_Is3D ( IntPtr eventdescription, bool &is3D ) : RESULT
FMOD_Studio_EventDescription_IsOneshot ( IntPtr eventdescription, bool &oneshot ) : RESULT
FMOD_Studio_EventDescription_IsSnapshot ( IntPtr eventdescription, bool &snapshot ) : RESULT
FMOD_Studio_EventDescription_IsStream ( IntPtr eventdescription, bool &isStream ) : RESULT
FMOD_Studio_EventDescription_IsValid ( IntPtr eventdescription ) : bool
FMOD_Studio_EventDescription_LoadSampleData ( IntPtr eventdescription ) : RESULT
FMOD_Studio_EventDescription_ReleaseAllInstances ( IntPtr eventdescription ) : RESULT
FMOD_Studio_EventDescription_SetCallback ( IntPtr eventdescription, EVENT_CALLBACK callback, EVENT_CALLBACK_TYPE callbackmask ) : RESULT
FMOD_Studio_EventDescription_SetUserData ( IntPtr eventdescription, IntPtr userData ) : RESULT
FMOD_Studio_EventDescription_UnloadSampleData ( IntPtr eventdescription ) : RESULT

Method Details

EventDescription() public method

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

createInstance() public method

public createInstance ( EventInstance &instance ) : RESULT
instance	EventInstance
return	RESULT

getID() public method

public getID ( System.Guid &id ) : RESULT
id	System.Guid
return	RESULT

getInstanceCount() public method

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

getInstanceList() public method

public getInstanceList ( EventInstance &array ) : RESULT
array	EventInstance
return	RESULT

getLength() public method

public getLength ( int &length ) : RESULT
length	int
return	RESULT

getMaximumDistance() public method

public getMaximumDistance ( float &distance ) : RESULT
distance	float
return	RESULT

getMinimumDistance() public method

public getMinimumDistance ( float &distance ) : RESULT
distance	float
return	RESULT

getParameter() public method

public getParameter ( string name, PARAMETER_DESCRIPTION &parameter ) : RESULT
name	string
parameter	PARAMETER_DESCRIPTION
return	RESULT

getParameterByIndex() public method

public getParameterByIndex ( int index, PARAMETER_DESCRIPTION &parameter ) : RESULT
index	int
parameter	PARAMETER_DESCRIPTION
return	RESULT

getParameterCount() public method

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

getPath() public method

public getPath ( string &path ) : RESULT
path	string
return	RESULT

getSampleLoadingState() public method

public getSampleLoadingState ( LOADING_STATE &state ) : RESULT
state	LOADING_STATE
return	RESULT

getSoundSize() public method

public getSoundSize ( float &size ) : RESULT
size	float
return	RESULT

getUserData() public method

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

getUserProperty() public method

public getUserProperty ( string name, USER_PROPERTY &property ) : RESULT
name	string
property	USER_PROPERTY
return	RESULT

getUserPropertyByIndex() public method

public getUserPropertyByIndex ( int index, USER_PROPERTY &property ) : RESULT
index	int
property	USER_PROPERTY
return	RESULT

getUserPropertyCount() public method

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

hasCue() public method

public hasCue ( bool &cue ) : RESULT
cue	bool
return	RESULT

is3D() public method

public is3D ( bool &is3D ) : RESULT
is3D	bool
return	RESULT

isOneshot() public method

public isOneshot ( bool &oneshot ) : RESULT
oneshot	bool
return	RESULT

isSnapshot() public method

public isSnapshot ( bool &snapshot ) : RESULT
snapshot	bool
return	RESULT

isStream() public method

public isStream ( bool &isStream ) : RESULT
isStream	bool
return	RESULT

isValidInternal() protected method

protected isValidInternal ( ) : bool
return	bool

loadSampleData() public method

public loadSampleData ( ) : RESULT
return	RESULT

releaseAllInstances() public method

public releaseAllInstances ( ) : RESULT
return	RESULT

setCallback() public method

public setCallback ( EVENT_CALLBACK callback, EVENT_CALLBACK_TYPE callbackmask = EVENT_CALLBACK_TYPE.ALL ) : RESULT
callback	EVENT_CALLBACK
callbackmask	EVENT_CALLBACK_TYPE
return	RESULT

setUserData() public method

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

unloadSampleData() public method

public unloadSampleData ( ) : RESULT
return	RESULT