Eye of the Nile Docs
Everything you need to know to get started!
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Private Member Functions | List of all members
FMOD.Studio.EventDescription Struct Reference

Public Member Functions

RESULT getID (out GUID id)
 
RESULT getPath (out string path)
 
RESULT getParameterDescriptionCount (out int count)
 
RESULT getParameterDescriptionByIndex (int index, out PARAMETER_DESCRIPTION parameter)
 
RESULT getParameterDescriptionByName (string name, out PARAMETER_DESCRIPTION parameter)
 
RESULT getParameterDescriptionByID (PARAMETER_ID id, out PARAMETER_DESCRIPTION parameter)
 
RESULT getParameterLabelByIndex (int index, int labelindex, out string label)
 
RESULT getParameterLabelByName (string name, int labelindex, out string label)
 
RESULT getParameterLabelByID (PARAMETER_ID id, int labelindex, out string label)
 
RESULT getUserPropertyCount (out int count)
 
RESULT getUserPropertyByIndex (int index, out USER_PROPERTY property)
 
RESULT getUserProperty (string name, out USER_PROPERTY property)
 
RESULT getLength (out int length)
 
RESULT getMinMaxDistance (out float min, out float max)
 
RESULT getSoundSize (out float size)
 
RESULT isSnapshot (out bool snapshot)
 
RESULT isOneshot (out bool oneshot)
 
RESULT isStream (out bool isStream)
 
RESULT is3D (out bool is3D)
 
RESULT isDopplerEnabled (out bool doppler)
 
RESULT hasSustainPoint (out bool sustainPoint)
 
RESULT createInstance (out EventInstance instance)
 
RESULT getInstanceCount (out int count)
 
RESULT getInstanceList (out EventInstance[] array)
 
RESULT loadSampleData ()
 
RESULT unloadSampleData ()
 
RESULT getSampleLoadingState (out LOADING_STATE state)
 
RESULT releaseAllInstances ()
 
RESULT setCallback (EVENT_CALLBACK callback, EVENT_CALLBACK_TYPE callbackmask=EVENT_CALLBACK_TYPE.ALL)
 
RESULT getUserData (out IntPtr userdata)
 
RESULT setUserData (IntPtr userdata)
 
 EventDescription (IntPtr ptr)
 
bool hasHandle ()
 
void clearHandle ()
 
bool isValid ()
 

Public Attributes

IntPtr handle
 

Private Member Functions

static bool FMOD_Studio_EventDescription_IsValid (IntPtr eventdescription)
 
static RESULT FMOD_Studio_EventDescription_GetID (IntPtr eventdescription, out GUID id)
 
static RESULT FMOD_Studio_EventDescription_GetPath (IntPtr eventdescription, IntPtr path, int size, out int retrieved)
 
static RESULT FMOD_Studio_EventDescription_GetParameterDescriptionCount (IntPtr eventdescription, out int count)
 
static RESULT FMOD_Studio_EventDescription_GetParameterDescriptionByIndex (IntPtr eventdescription, int index, out PARAMETER_DESCRIPTION parameter)
 
static RESULT FMOD_Studio_EventDescription_GetParameterDescriptionByName (IntPtr eventdescription, byte[] name, out PARAMETER_DESCRIPTION parameter)
 
static RESULT FMOD_Studio_EventDescription_GetParameterDescriptionByID (IntPtr eventdescription, PARAMETER_ID id, out PARAMETER_DESCRIPTION parameter)
 
static RESULT FMOD_Studio_EventDescription_GetParameterLabelByIndex (IntPtr eventdescription, int index, int labelindex, IntPtr label, int size, out int retrieved)
 
static RESULT FMOD_Studio_EventDescription_GetParameterLabelByName (IntPtr eventdescription, byte[] name, int labelindex, IntPtr label, int size, out int retrieved)
 
static RESULT FMOD_Studio_EventDescription_GetParameterLabelByID (IntPtr eventdescription, PARAMETER_ID id, int labelindex, IntPtr label, int size, out int retrieved)
 
static RESULT FMOD_Studio_EventDescription_GetUserPropertyCount (IntPtr eventdescription, out int count)
 
static RESULT FMOD_Studio_EventDescription_GetUserPropertyByIndex (IntPtr eventdescription, int index, out USER_PROPERTY property)
 
static RESULT FMOD_Studio_EventDescription_GetUserProperty (IntPtr eventdescription, byte[] name, out USER_PROPERTY property)
 
static RESULT FMOD_Studio_EventDescription_GetLength (IntPtr eventdescription, out int length)
 
static RESULT FMOD_Studio_EventDescription_GetMinMaxDistance (IntPtr eventdescription, out float min, out float max)
 
static RESULT FMOD_Studio_EventDescription_GetSoundSize (IntPtr eventdescription, out float size)
 
static RESULT FMOD_Studio_EventDescription_IsSnapshot (IntPtr eventdescription, out bool snapshot)
 
static RESULT FMOD_Studio_EventDescription_IsOneshot (IntPtr eventdescription, out bool oneshot)
 
static RESULT FMOD_Studio_EventDescription_IsStream (IntPtr eventdescription, out bool isStream)
 
static RESULT FMOD_Studio_EventDescription_Is3D (IntPtr eventdescription, out bool is3D)
 
static RESULT FMOD_Studio_EventDescription_IsDopplerEnabled (IntPtr eventdescription, out bool doppler)
 
static RESULT FMOD_Studio_EventDescription_HasSustainPoint (IntPtr eventdescription, out bool sustainPoint)
 
static RESULT FMOD_Studio_EventDescription_CreateInstance (IntPtr eventdescription, out IntPtr instance)
 
static RESULT FMOD_Studio_EventDescription_GetInstanceCount (IntPtr eventdescription, out int count)
 
static RESULT FMOD_Studio_EventDescription_GetInstanceList (IntPtr eventdescription, IntPtr[] array, int capacity, out int count)
 
static RESULT FMOD_Studio_EventDescription_LoadSampleData (IntPtr eventdescription)
 
static RESULT FMOD_Studio_EventDescription_UnloadSampleData (IntPtr eventdescription)
 
static RESULT FMOD_Studio_EventDescription_GetSampleLoadingState (IntPtr eventdescription, out LOADING_STATE state)
 
static RESULT FMOD_Studio_EventDescription_ReleaseAllInstances (IntPtr eventdescription)
 
static RESULT FMOD_Studio_EventDescription_SetCallback (IntPtr eventdescription, EVENT_CALLBACK callback, EVENT_CALLBACK_TYPE callbackmask)
 
static RESULT FMOD_Studio_EventDescription_GetUserData (IntPtr eventdescription, out IntPtr userdata)
 
static RESULT FMOD_Studio_EventDescription_SetUserData (IntPtr eventdescription, IntPtr userdata)
 

Constructor & Destructor Documentation

◆ EventDescription()

FMOD.Studio.EventDescription.EventDescription ( IntPtr ptr)

Member Function Documentation

◆ clearHandle()

void FMOD.Studio.EventDescription.clearHandle ( )

◆ createInstance()

RESULT FMOD.Studio.EventDescription.createInstance ( out EventInstance instance)

◆ FMOD_Studio_EventDescription_CreateInstance()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_CreateInstance ( IntPtr eventdescription,
out IntPtr instance )
private

◆ FMOD_Studio_EventDescription_GetID()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetID ( IntPtr eventdescription,
out GUID id )
private

◆ FMOD_Studio_EventDescription_GetInstanceCount()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetInstanceCount ( IntPtr eventdescription,
out int count )
private

◆ FMOD_Studio_EventDescription_GetInstanceList()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetInstanceList ( IntPtr eventdescription,
IntPtr[] array,
int capacity,
out int count )
private

◆ FMOD_Studio_EventDescription_GetLength()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetLength ( IntPtr eventdescription,
out int length )
private

◆ FMOD_Studio_EventDescription_GetMinMaxDistance()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetMinMaxDistance ( IntPtr eventdescription,
out float min,
out float max )
private

◆ FMOD_Studio_EventDescription_GetParameterDescriptionByID()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetParameterDescriptionByID ( IntPtr eventdescription,
PARAMETER_ID id,
out PARAMETER_DESCRIPTION parameter )
private

◆ FMOD_Studio_EventDescription_GetParameterDescriptionByIndex()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetParameterDescriptionByIndex ( IntPtr eventdescription,
int index,
out PARAMETER_DESCRIPTION parameter )
private

◆ FMOD_Studio_EventDescription_GetParameterDescriptionByName()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetParameterDescriptionByName ( IntPtr eventdescription,
byte[] name,
out PARAMETER_DESCRIPTION parameter )
private

◆ FMOD_Studio_EventDescription_GetParameterDescriptionCount()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetParameterDescriptionCount ( IntPtr eventdescription,
out int count )
private

◆ FMOD_Studio_EventDescription_GetParameterLabelByID()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetParameterLabelByID ( IntPtr eventdescription,
PARAMETER_ID id,
int labelindex,
IntPtr label,
int size,
out int retrieved )
private

◆ FMOD_Studio_EventDescription_GetParameterLabelByIndex()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetParameterLabelByIndex ( IntPtr eventdescription,
int index,
int labelindex,
IntPtr label,
int size,
out int retrieved )
private

◆ FMOD_Studio_EventDescription_GetParameterLabelByName()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetParameterLabelByName ( IntPtr eventdescription,
byte[] name,
int labelindex,
IntPtr label,
int size,
out int retrieved )
private

◆ FMOD_Studio_EventDescription_GetPath()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetPath ( IntPtr eventdescription,
IntPtr path,
int size,
out int retrieved )
private

◆ FMOD_Studio_EventDescription_GetSampleLoadingState()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetSampleLoadingState ( IntPtr eventdescription,
out LOADING_STATE state )
private

◆ FMOD_Studio_EventDescription_GetSoundSize()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetSoundSize ( IntPtr eventdescription,
out float size )
private

◆ FMOD_Studio_EventDescription_GetUserData()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetUserData ( IntPtr eventdescription,
out IntPtr userdata )
private

◆ FMOD_Studio_EventDescription_GetUserProperty()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetUserProperty ( IntPtr eventdescription,
byte[] name,
out USER_PROPERTY property )
private

◆ FMOD_Studio_EventDescription_GetUserPropertyByIndex()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetUserPropertyByIndex ( IntPtr eventdescription,
int index,
out USER_PROPERTY property )
private

◆ FMOD_Studio_EventDescription_GetUserPropertyCount()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_GetUserPropertyCount ( IntPtr eventdescription,
out int count )
private

◆ FMOD_Studio_EventDescription_HasSustainPoint()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_HasSustainPoint ( IntPtr eventdescription,
out bool sustainPoint )
private

◆ FMOD_Studio_EventDescription_Is3D()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_Is3D ( IntPtr eventdescription,
out bool is3D )
private

◆ FMOD_Studio_EventDescription_IsDopplerEnabled()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_IsDopplerEnabled ( IntPtr eventdescription,
out bool doppler )
private

◆ FMOD_Studio_EventDescription_IsOneshot()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_IsOneshot ( IntPtr eventdescription,
out bool oneshot )
private

◆ FMOD_Studio_EventDescription_IsSnapshot()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_IsSnapshot ( IntPtr eventdescription,
out bool snapshot )
private

◆ FMOD_Studio_EventDescription_IsStream()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_IsStream ( IntPtr eventdescription,
out bool isStream )
private

◆ FMOD_Studio_EventDescription_IsValid()

static bool FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_IsValid ( IntPtr eventdescription)
private

◆ FMOD_Studio_EventDescription_LoadSampleData()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_LoadSampleData ( IntPtr eventdescription)
private

◆ FMOD_Studio_EventDescription_ReleaseAllInstances()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_ReleaseAllInstances ( IntPtr eventdescription)
private

◆ FMOD_Studio_EventDescription_SetCallback()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_SetCallback ( IntPtr eventdescription,
EVENT_CALLBACK callback,
EVENT_CALLBACK_TYPE callbackmask )
private

◆ FMOD_Studio_EventDescription_SetUserData()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_SetUserData ( IntPtr eventdescription,
IntPtr userdata )
private

◆ FMOD_Studio_EventDescription_UnloadSampleData()

static RESULT FMOD.Studio.EventDescription.FMOD_Studio_EventDescription_UnloadSampleData ( IntPtr eventdescription)
private

◆ getID()

RESULT FMOD.Studio.EventDescription.getID ( out GUID id)

◆ getInstanceCount()

RESULT FMOD.Studio.EventDescription.getInstanceCount ( out int count)

◆ getInstanceList()

RESULT FMOD.Studio.EventDescription.getInstanceList ( out EventInstance[] array)

◆ getLength()

RESULT FMOD.Studio.EventDescription.getLength ( out int length)

◆ getMinMaxDistance()

RESULT FMOD.Studio.EventDescription.getMinMaxDistance ( out float min,
out float max )

◆ getParameterDescriptionByID()

RESULT FMOD.Studio.EventDescription.getParameterDescriptionByID ( PARAMETER_ID id,
out PARAMETER_DESCRIPTION parameter )

◆ getParameterDescriptionByIndex()

RESULT FMOD.Studio.EventDescription.getParameterDescriptionByIndex ( int index,
out PARAMETER_DESCRIPTION parameter )

◆ getParameterDescriptionByName()

RESULT FMOD.Studio.EventDescription.getParameterDescriptionByName ( string name,
out PARAMETER_DESCRIPTION parameter )

◆ getParameterDescriptionCount()

RESULT FMOD.Studio.EventDescription.getParameterDescriptionCount ( out int count)

◆ getParameterLabelByID()

RESULT FMOD.Studio.EventDescription.getParameterLabelByID ( PARAMETER_ID id,
int labelindex,
out string label )

◆ getParameterLabelByIndex()

RESULT FMOD.Studio.EventDescription.getParameterLabelByIndex ( int index,
int labelindex,
out string label )

◆ getParameterLabelByName()

RESULT FMOD.Studio.EventDescription.getParameterLabelByName ( string name,
int labelindex,
out string label )

◆ getPath()

RESULT FMOD.Studio.EventDescription.getPath ( out string path)

◆ getSampleLoadingState()

RESULT FMOD.Studio.EventDescription.getSampleLoadingState ( out LOADING_STATE state)

◆ getSoundSize()

RESULT FMOD.Studio.EventDescription.getSoundSize ( out float size)

◆ getUserData()

RESULT FMOD.Studio.EventDescription.getUserData ( out IntPtr userdata)

◆ getUserProperty()

RESULT FMOD.Studio.EventDescription.getUserProperty ( string name,
out USER_PROPERTY property )

◆ getUserPropertyByIndex()

RESULT FMOD.Studio.EventDescription.getUserPropertyByIndex ( int index,
out USER_PROPERTY property )

◆ getUserPropertyCount()

RESULT FMOD.Studio.EventDescription.getUserPropertyCount ( out int count)

◆ hasHandle()

bool FMOD.Studio.EventDescription.hasHandle ( )

◆ hasSustainPoint()

RESULT FMOD.Studio.EventDescription.hasSustainPoint ( out bool sustainPoint)

◆ is3D()

RESULT FMOD.Studio.EventDescription.is3D ( out bool is3D)

◆ isDopplerEnabled()

RESULT FMOD.Studio.EventDescription.isDopplerEnabled ( out bool doppler)

◆ isOneshot()

RESULT FMOD.Studio.EventDescription.isOneshot ( out bool oneshot)

◆ isSnapshot()

RESULT FMOD.Studio.EventDescription.isSnapshot ( out bool snapshot)

◆ isStream()

RESULT FMOD.Studio.EventDescription.isStream ( out bool isStream)

◆ isValid()

bool FMOD.Studio.EventDescription.isValid ( )

◆ loadSampleData()

RESULT FMOD.Studio.EventDescription.loadSampleData ( )

◆ releaseAllInstances()

RESULT FMOD.Studio.EventDescription.releaseAllInstances ( )

◆ setCallback()

RESULT FMOD.Studio.EventDescription.setCallback ( EVENT_CALLBACK callback,
EVENT_CALLBACK_TYPE callbackmask = EVENT_CALLBACK_TYPE::ALL )

◆ setUserData()

RESULT FMOD.Studio.EventDescription.setUserData ( IntPtr userdata)

◆ unloadSampleData()

RESULT FMOD.Studio.EventDescription.unloadSampleData ( )

Member Data Documentation

◆ handle

IntPtr FMOD.Studio.EventDescription.handle
The documentation for this struct was generated from the following file: