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.EventInstance Struct Reference

Public Member Functions

RESULT getDescription (out EventDescription description)
 
RESULT getVolume (out float volume)
 
RESULT getVolume (out float volume, out float finalvolume)
 
RESULT setVolume (float volume)
 
RESULT getPitch (out float pitch)
 
RESULT getPitch (out float pitch, out float finalpitch)
 
RESULT setPitch (float pitch)
 
RESULT get3DAttributes (out ATTRIBUTES_3D attributes)
 
RESULT set3DAttributes (ATTRIBUTES_3D attributes)
 
RESULT getListenerMask (out uint mask)
 
RESULT setListenerMask (uint mask)
 
RESULT getProperty (EVENT_PROPERTY index, out float value)
 
RESULT setProperty (EVENT_PROPERTY index, float value)
 
RESULT getReverbLevel (int index, out float level)
 
RESULT setReverbLevel (int index, float level)
 
RESULT getPaused (out bool paused)
 
RESULT setPaused (bool paused)
 
RESULT start ()
 
RESULT stop (STOP_MODE mode)
 
RESULT getTimelinePosition (out int position)
 
RESULT setTimelinePosition (int position)
 
RESULT getPlaybackState (out PLAYBACK_STATE state)
 
RESULT getChannelGroup (out FMOD.ChannelGroup group)
 
RESULT getMinMaxDistance (out float min, out float max)
 
RESULT release ()
 
RESULT isVirtual (out bool virtualstate)
 
RESULT getParameterByID (PARAMETER_ID id, out float value)
 
RESULT getParameterByID (PARAMETER_ID id, out float value, out float finalvalue)
 
RESULT setParameterByID (PARAMETER_ID id, float value, bool ignoreseekspeed=false)
 
RESULT setParameterByIDWithLabel (PARAMETER_ID id, string label, bool ignoreseekspeed=false)
 
RESULT setParametersByIDs (PARAMETER_ID[] ids, float[] values, int count, bool ignoreseekspeed=false)
 
RESULT getParameterByName (string name, out float value)
 
RESULT getParameterByName (string name, out float value, out float finalvalue)
 
RESULT setParameterByName (string name, float value, bool ignoreseekspeed=false)
 
RESULT setParameterByNameWithLabel (string name, string label, bool ignoreseekspeed=false)
 
RESULT keyOff ()
 
RESULT setCallback (EVENT_CALLBACK callback, EVENT_CALLBACK_TYPE callbackmask=EVENT_CALLBACK_TYPE.ALL)
 
RESULT getUserData (out IntPtr userdata)
 
RESULT setUserData (IntPtr userdata)
 
RESULT getCPUUsage (out uint exclusive, out uint inclusive)
 
RESULT getMemoryUsage (out MEMORY_USAGE memoryusage)
 
 EventInstance (IntPtr ptr)
 
bool hasHandle ()
 
void clearHandle ()
 
bool isValid ()
 

Public Attributes

IntPtr handle
 

Private Member Functions

static bool FMOD_Studio_EventInstance_IsValid (IntPtr _event)
 
static RESULT FMOD_Studio_EventInstance_GetDescription (IntPtr _event, out IntPtr description)
 
static RESULT FMOD_Studio_EventInstance_GetVolume (IntPtr _event, out float volume, IntPtr zero)
 
static RESULT FMOD_Studio_EventInstance_GetVolume (IntPtr _event, out float volume, out float finalvolume)
 
static RESULT FMOD_Studio_EventInstance_SetVolume (IntPtr _event, float volume)
 
static RESULT FMOD_Studio_EventInstance_GetPitch (IntPtr _event, out float pitch, IntPtr zero)
 
static RESULT FMOD_Studio_EventInstance_GetPitch (IntPtr _event, out float pitch, out float finalpitch)
 
static RESULT FMOD_Studio_EventInstance_SetPitch (IntPtr _event, float pitch)
 
static RESULT FMOD_Studio_EventInstance_Get3DAttributes (IntPtr _event, out ATTRIBUTES_3D attributes)
 
static RESULT FMOD_Studio_EventInstance_Set3DAttributes (IntPtr _event, ref ATTRIBUTES_3D attributes)
 
static RESULT FMOD_Studio_EventInstance_GetListenerMask (IntPtr _event, out uint mask)
 
static RESULT FMOD_Studio_EventInstance_SetListenerMask (IntPtr _event, uint mask)
 
static RESULT FMOD_Studio_EventInstance_GetProperty (IntPtr _event, EVENT_PROPERTY index, out float value)
 
static RESULT FMOD_Studio_EventInstance_SetProperty (IntPtr _event, EVENT_PROPERTY index, float value)
 
static RESULT FMOD_Studio_EventInstance_GetReverbLevel (IntPtr _event, int index, out float level)
 
static RESULT FMOD_Studio_EventInstance_SetReverbLevel (IntPtr _event, int index, float level)
 
static RESULT FMOD_Studio_EventInstance_GetPaused (IntPtr _event, out bool paused)
 
static RESULT FMOD_Studio_EventInstance_SetPaused (IntPtr _event, bool paused)
 
static RESULT FMOD_Studio_EventInstance_Start (IntPtr _event)
 
static RESULT FMOD_Studio_EventInstance_Stop (IntPtr _event, STOP_MODE mode)
 
static RESULT FMOD_Studio_EventInstance_GetTimelinePosition (IntPtr _event, out int position)
 
static RESULT FMOD_Studio_EventInstance_SetTimelinePosition (IntPtr _event, int position)
 
static RESULT FMOD_Studio_EventInstance_GetPlaybackState (IntPtr _event, out PLAYBACK_STATE state)
 
static RESULT FMOD_Studio_EventInstance_GetChannelGroup (IntPtr _event, out IntPtr group)
 
static RESULT FMOD_Studio_EventInstance_GetMinMaxDistance (IntPtr _event, out float min, out float max)
 
static RESULT FMOD_Studio_EventInstance_Release (IntPtr _event)
 
static RESULT FMOD_Studio_EventInstance_IsVirtual (IntPtr _event, out bool virtualstate)
 
static RESULT FMOD_Studio_EventInstance_GetParameterByName (IntPtr _event, byte[] name, out float value, out float finalvalue)
 
static RESULT FMOD_Studio_EventInstance_SetParameterByName (IntPtr _event, byte[] name, float value, bool ignoreseekspeed)
 
static RESULT FMOD_Studio_EventInstance_SetParameterByNameWithLabel (IntPtr _event, byte[] name, byte[] label, bool ignoreseekspeed)
 
static RESULT FMOD_Studio_EventInstance_GetParameterByID (IntPtr _event, PARAMETER_ID id, out float value, out float finalvalue)
 
static RESULT FMOD_Studio_EventInstance_SetParameterByID (IntPtr _event, PARAMETER_ID id, float value, bool ignoreseekspeed)
 
static RESULT FMOD_Studio_EventInstance_SetParameterByIDWithLabel (IntPtr _event, PARAMETER_ID id, byte[] label, bool ignoreseekspeed)
 
static RESULT FMOD_Studio_EventInstance_SetParametersByIDs (IntPtr _event, PARAMETER_ID[] ids, float[] values, int count, bool ignoreseekspeed)
 
static RESULT FMOD_Studio_EventInstance_KeyOff (IntPtr _event)
 
static RESULT FMOD_Studio_EventInstance_SetCallback (IntPtr _event, EVENT_CALLBACK callback, EVENT_CALLBACK_TYPE callbackmask)
 
static RESULT FMOD_Studio_EventInstance_GetUserData (IntPtr _event, out IntPtr userdata)
 
static RESULT FMOD_Studio_EventInstance_SetUserData (IntPtr _event, IntPtr userdata)
 
static RESULT FMOD_Studio_EventInstance_GetCPUUsage (IntPtr _event, out uint exclusive, out uint inclusive)
 
static RESULT FMOD_Studio_EventInstance_GetMemoryUsage (IntPtr _event, out MEMORY_USAGE memoryusage)
 

Constructor & Destructor Documentation

◆ EventInstance()

FMOD.Studio.EventInstance.EventInstance ( IntPtr ptr)

Member Function Documentation

◆ clearHandle()

void FMOD.Studio.EventInstance.clearHandle ( )

◆ FMOD_Studio_EventInstance_Get3DAttributes()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_Get3DAttributes ( IntPtr _event,
out ATTRIBUTES_3D attributes )
private

◆ FMOD_Studio_EventInstance_GetChannelGroup()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetChannelGroup ( IntPtr _event,
out IntPtr group )
private

◆ FMOD_Studio_EventInstance_GetCPUUsage()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetCPUUsage ( IntPtr _event,
out uint exclusive,
out uint inclusive )
private

◆ FMOD_Studio_EventInstance_GetDescription()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetDescription ( IntPtr _event,
out IntPtr description )
private

◆ FMOD_Studio_EventInstance_GetListenerMask()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetListenerMask ( IntPtr _event,
out uint mask )
private

◆ FMOD_Studio_EventInstance_GetMemoryUsage()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetMemoryUsage ( IntPtr _event,
out MEMORY_USAGE memoryusage )
private

◆ FMOD_Studio_EventInstance_GetMinMaxDistance()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetMinMaxDistance ( IntPtr _event,
out float min,
out float max )
private

◆ FMOD_Studio_EventInstance_GetParameterByID()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetParameterByID ( IntPtr _event,
PARAMETER_ID id,
out float value,
out float finalvalue )
private

◆ FMOD_Studio_EventInstance_GetParameterByName()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetParameterByName ( IntPtr _event,
byte[] name,
out float value,
out float finalvalue )
private

◆ FMOD_Studio_EventInstance_GetPaused()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetPaused ( IntPtr _event,
out bool paused )
private

◆ FMOD_Studio_EventInstance_GetPitch() [1/2]

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetPitch ( IntPtr _event,
out float pitch,
IntPtr zero )
private

◆ FMOD_Studio_EventInstance_GetPitch() [2/2]

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetPitch ( IntPtr _event,
out float pitch,
out float finalpitch )
private

◆ FMOD_Studio_EventInstance_GetPlaybackState()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetPlaybackState ( IntPtr _event,
out PLAYBACK_STATE state )
private

◆ FMOD_Studio_EventInstance_GetProperty()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetProperty ( IntPtr _event,
EVENT_PROPERTY index,
out float value )
private

◆ FMOD_Studio_EventInstance_GetReverbLevel()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetReverbLevel ( IntPtr _event,
int index,
out float level )
private

◆ FMOD_Studio_EventInstance_GetTimelinePosition()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetTimelinePosition ( IntPtr _event,
out int position )
private

◆ FMOD_Studio_EventInstance_GetUserData()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetUserData ( IntPtr _event,
out IntPtr userdata )
private

◆ FMOD_Studio_EventInstance_GetVolume() [1/2]

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetVolume ( IntPtr _event,
out float volume,
IntPtr zero )
private

◆ FMOD_Studio_EventInstance_GetVolume() [2/2]

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_GetVolume ( IntPtr _event,
out float volume,
out float finalvolume )
private

◆ FMOD_Studio_EventInstance_IsValid()

static bool FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_IsValid ( IntPtr _event)
private

◆ FMOD_Studio_EventInstance_IsVirtual()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_IsVirtual ( IntPtr _event,
out bool virtualstate )
private

◆ FMOD_Studio_EventInstance_KeyOff()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_KeyOff ( IntPtr _event)
private

◆ FMOD_Studio_EventInstance_Release()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_Release ( IntPtr _event)
private

◆ FMOD_Studio_EventInstance_Set3DAttributes()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_Set3DAttributes ( IntPtr _event,
ref ATTRIBUTES_3D attributes )
private

◆ FMOD_Studio_EventInstance_SetCallback()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_SetCallback ( IntPtr _event,
EVENT_CALLBACK callback,
EVENT_CALLBACK_TYPE callbackmask )
private

◆ FMOD_Studio_EventInstance_SetListenerMask()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_SetListenerMask ( IntPtr _event,
uint mask )
private

◆ FMOD_Studio_EventInstance_SetParameterByID()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_SetParameterByID ( IntPtr _event,
PARAMETER_ID id,
float value,
bool ignoreseekspeed )
private

◆ FMOD_Studio_EventInstance_SetParameterByIDWithLabel()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_SetParameterByIDWithLabel ( IntPtr _event,
PARAMETER_ID id,
byte[] label,
bool ignoreseekspeed )
private

◆ FMOD_Studio_EventInstance_SetParameterByName()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_SetParameterByName ( IntPtr _event,
byte[] name,
float value,
bool ignoreseekspeed )
private

◆ FMOD_Studio_EventInstance_SetParameterByNameWithLabel()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_SetParameterByNameWithLabel ( IntPtr _event,
byte[] name,
byte[] label,
bool ignoreseekspeed )
private

◆ FMOD_Studio_EventInstance_SetParametersByIDs()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_SetParametersByIDs ( IntPtr _event,
PARAMETER_ID[] ids,
float[] values,
int count,
bool ignoreseekspeed )
private

◆ FMOD_Studio_EventInstance_SetPaused()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_SetPaused ( IntPtr _event,
bool paused )
private

◆ FMOD_Studio_EventInstance_SetPitch()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_SetPitch ( IntPtr _event,
float pitch )
private

◆ FMOD_Studio_EventInstance_SetProperty()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_SetProperty ( IntPtr _event,
EVENT_PROPERTY index,
float value )
private

◆ FMOD_Studio_EventInstance_SetReverbLevel()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_SetReverbLevel ( IntPtr _event,
int index,
float level )
private

◆ FMOD_Studio_EventInstance_SetTimelinePosition()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_SetTimelinePosition ( IntPtr _event,
int position )
private

◆ FMOD_Studio_EventInstance_SetUserData()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_SetUserData ( IntPtr _event,
IntPtr userdata )
private

◆ FMOD_Studio_EventInstance_SetVolume()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_SetVolume ( IntPtr _event,
float volume )
private

◆ FMOD_Studio_EventInstance_Start()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_Start ( IntPtr _event)
private

◆ FMOD_Studio_EventInstance_Stop()

static RESULT FMOD.Studio.EventInstance.FMOD_Studio_EventInstance_Stop ( IntPtr _event,
STOP_MODE mode )
private

◆ get3DAttributes()

RESULT FMOD.Studio.EventInstance.get3DAttributes ( out ATTRIBUTES_3D attributes)

◆ getChannelGroup()

RESULT FMOD.Studio.EventInstance.getChannelGroup ( out FMOD.ChannelGroup group)

◆ getCPUUsage()

RESULT FMOD.Studio.EventInstance.getCPUUsage ( out uint exclusive,
out uint inclusive )

◆ getDescription()

RESULT FMOD.Studio.EventInstance.getDescription ( out EventDescription description)

◆ getListenerMask()

RESULT FMOD.Studio.EventInstance.getListenerMask ( out uint mask)

◆ getMemoryUsage()

RESULT FMOD.Studio.EventInstance.getMemoryUsage ( out MEMORY_USAGE memoryusage)

◆ getMinMaxDistance()

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

◆ getParameterByID() [1/2]

RESULT FMOD.Studio.EventInstance.getParameterByID ( PARAMETER_ID id,
out float value )

◆ getParameterByID() [2/2]

RESULT FMOD.Studio.EventInstance.getParameterByID ( PARAMETER_ID id,
out float value,
out float finalvalue )

◆ getParameterByName() [1/2]

RESULT FMOD.Studio.EventInstance.getParameterByName ( string name,
out float value )

◆ getParameterByName() [2/2]

RESULT FMOD.Studio.EventInstance.getParameterByName ( string name,
out float value,
out float finalvalue )

◆ getPaused()

RESULT FMOD.Studio.EventInstance.getPaused ( out bool paused)

◆ getPitch() [1/2]

RESULT FMOD.Studio.EventInstance.getPitch ( out float pitch)

◆ getPitch() [2/2]

RESULT FMOD.Studio.EventInstance.getPitch ( out float pitch,
out float finalpitch )

◆ getPlaybackState()

RESULT FMOD.Studio.EventInstance.getPlaybackState ( out PLAYBACK_STATE state)

◆ getProperty()

RESULT FMOD.Studio.EventInstance.getProperty ( EVENT_PROPERTY index,
out float value )

◆ getReverbLevel()

RESULT FMOD.Studio.EventInstance.getReverbLevel ( int index,
out float level )

◆ getTimelinePosition()

RESULT FMOD.Studio.EventInstance.getTimelinePosition ( out int position)

◆ getUserData()

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

◆ getVolume() [1/2]

RESULT FMOD.Studio.EventInstance.getVolume ( out float volume)

◆ getVolume() [2/2]

RESULT FMOD.Studio.EventInstance.getVolume ( out float volume,
out float finalvolume )

◆ hasHandle()

bool FMOD.Studio.EventInstance.hasHandle ( )

◆ isValid()

bool FMOD.Studio.EventInstance.isValid ( )

◆ isVirtual()

RESULT FMOD.Studio.EventInstance.isVirtual ( out bool virtualstate)

◆ keyOff()

RESULT FMOD.Studio.EventInstance.keyOff ( )

◆ release()

RESULT FMOD.Studio.EventInstance.release ( )

◆ set3DAttributes()

RESULT FMOD.Studio.EventInstance.set3DAttributes ( ATTRIBUTES_3D attributes)

◆ setCallback()

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

◆ setListenerMask()

RESULT FMOD.Studio.EventInstance.setListenerMask ( uint mask)

◆ setParameterByID()

RESULT FMOD.Studio.EventInstance.setParameterByID ( PARAMETER_ID id,
float value,
bool ignoreseekspeed = false )

◆ setParameterByIDWithLabel()

RESULT FMOD.Studio.EventInstance.setParameterByIDWithLabel ( PARAMETER_ID id,
string label,
bool ignoreseekspeed = false )

◆ setParameterByName()

RESULT FMOD.Studio.EventInstance.setParameterByName ( string name,
float value,
bool ignoreseekspeed = false )

◆ setParameterByNameWithLabel()

RESULT FMOD.Studio.EventInstance.setParameterByNameWithLabel ( string name,
string label,
bool ignoreseekspeed = false )

◆ setParametersByIDs()

RESULT FMOD.Studio.EventInstance.setParametersByIDs ( PARAMETER_ID[] ids,
float[] values,
int count,
bool ignoreseekspeed = false )

◆ setPaused()

RESULT FMOD.Studio.EventInstance.setPaused ( bool paused)

◆ setPitch()

RESULT FMOD.Studio.EventInstance.setPitch ( float pitch)

◆ setProperty()

RESULT FMOD.Studio.EventInstance.setProperty ( EVENT_PROPERTY index,
float value )

◆ setReverbLevel()

RESULT FMOD.Studio.EventInstance.setReverbLevel ( int index,
float level )

◆ setTimelinePosition()

RESULT FMOD.Studio.EventInstance.setTimelinePosition ( int position)

◆ setUserData()

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

◆ setVolume()

RESULT FMOD.Studio.EventInstance.setVolume ( float volume)

◆ start()

RESULT FMOD.Studio.EventInstance.start ( )

◆ stop()

RESULT FMOD.Studio.EventInstance.stop ( STOP_MODE mode)

Member Data Documentation

◆ handle

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