C# Class FMOD.Studio.EventInstance

Inheritance: HandleBase

Datei anzeigen Open project: fmod/UnityIntegration Class Usage Examples

Public Methods

Method	Description
EventInstance ( IntPtr raw ) : System
get3DAttributes ( FMOD.Studio.ATTRIBUTES_3D &attributes ) : RESULT
getChannelGroup ( FMOD &group ) : RESULT
getDescription ( EventDescription &description ) : RESULT
getListenerMask ( uint &mask ) : RESULT
getParameter ( string name, ParameterInstance &instance ) : RESULT
getParameterByIndex ( int index, ParameterInstance &instance ) : RESULT
getParameterCount ( int &count ) : RESULT
getParameterValue ( string name, float &value ) : RESULT
getParameterValueByIndex ( int index, float &value ) : RESULT
getPaused ( bool &paused ) : RESULT
getPitch ( float &pitch ) : RESULT
getPlaybackState ( PLAYBACK_STATE &state ) : RESULT
getProperty ( EVENT_PROPERTY index, float &value ) : RESULT
getTimelinePosition ( int &position ) : RESULT
getUserData ( IntPtr &userData ) : RESULT
getVolume ( float &volume ) : RESULT
isVirtual ( bool &virtualState ) : RESULT
release ( ) : RESULT
set3DAttributes ( FMOD.Studio.ATTRIBUTES_3D attributes ) : RESULT
setCallback ( EVENT_CALLBACK callback, EVENT_CALLBACK_TYPE callbackmask = EVENT_CALLBACK_TYPE.ALL ) : RESULT
setListenerMask ( uint mask ) : RESULT
setParameterValue ( string name, float value ) : RESULT
setParameterValueByIndex ( int index, float value ) : RESULT
setPaused ( bool paused ) : RESULT
setPitch ( float pitch ) : RESULT
setProperty ( EVENT_PROPERTY index, float value ) : RESULT
setTimelinePosition ( int position ) : RESULT
setUserData ( IntPtr userData ) : RESULT
setVolume ( float volume ) : RESULT
start ( ) : RESULT
stop ( STOP_MODE mode ) : RESULT
triggerCue ( ) : RESULT

Protected Methods

Method	Description
isValidInternal ( ) : bool

Private Methods

Method	Description
FMOD_Studio_EventInstance_Get3DAttributes ( IntPtr _event, FMOD.Studio.ATTRIBUTES_3D &attributes ) : RESULT
FMOD_Studio_EventInstance_GetChannelGroup ( IntPtr _event, IntPtr &group ) : RESULT
FMOD_Studio_EventInstance_GetDescription ( IntPtr _event, IntPtr &description ) : RESULT
FMOD_Studio_EventInstance_GetListenerMask ( IntPtr _event, uint &mask ) : RESULT
FMOD_Studio_EventInstance_GetParameter ( IntPtr _event, byte name, IntPtr &parameter ) : RESULT
FMOD_Studio_EventInstance_GetParameterByIndex ( IntPtr _event, int index, IntPtr &parameter ) : RESULT
FMOD_Studio_EventInstance_GetParameterCount ( IntPtr _event, int &count ) : RESULT
FMOD_Studio_EventInstance_GetParameterValue ( IntPtr _event, byte name, float &value ) : RESULT
FMOD_Studio_EventInstance_GetParameterValueByIndex ( IntPtr _event, int index, float &value ) : RESULT
FMOD_Studio_EventInstance_GetPaused ( IntPtr _event, bool &paused ) : RESULT
FMOD_Studio_EventInstance_GetPitch ( IntPtr _event, float &pitch ) : RESULT
FMOD_Studio_EventInstance_GetPlaybackState ( IntPtr _event, PLAYBACK_STATE &state ) : RESULT
FMOD_Studio_EventInstance_GetProperty ( IntPtr _event, EVENT_PROPERTY index, float &value ) : RESULT
FMOD_Studio_EventInstance_GetTimelinePosition ( IntPtr _event, int &position ) : RESULT
FMOD_Studio_EventInstance_GetUserData ( IntPtr _event, IntPtr &userData ) : RESULT
FMOD_Studio_EventInstance_GetVolume ( IntPtr _event, float &volume ) : RESULT
FMOD_Studio_EventInstance_IsValid ( IntPtr _event ) : bool
FMOD_Studio_EventInstance_IsVirtual ( IntPtr _event, bool &virtualState ) : RESULT
FMOD_Studio_EventInstance_Release ( IntPtr _event ) : RESULT
FMOD_Studio_EventInstance_Set3DAttributes ( IntPtr _event, FMOD.Studio.ATTRIBUTES_3D &attributes ) : RESULT
FMOD_Studio_EventInstance_SetCallback ( IntPtr _event, EVENT_CALLBACK callback, EVENT_CALLBACK_TYPE callbackmask ) : RESULT
FMOD_Studio_EventInstance_SetListenerMask ( IntPtr _event, uint mask ) : RESULT
FMOD_Studio_EventInstance_SetParameterValue ( IntPtr _event, byte name, float value ) : RESULT
FMOD_Studio_EventInstance_SetParameterValueByIndex ( IntPtr _event, int index, float value ) : RESULT
FMOD_Studio_EventInstance_SetPaused ( IntPtr _event, bool paused ) : RESULT
FMOD_Studio_EventInstance_SetPitch ( IntPtr _event, float pitch ) : RESULT
FMOD_Studio_EventInstance_SetProperty ( IntPtr _event, EVENT_PROPERTY index, float value ) : RESULT
FMOD_Studio_EventInstance_SetTimelinePosition ( IntPtr _event, int position ) : RESULT
FMOD_Studio_EventInstance_SetUserData ( IntPtr _event, IntPtr userData ) : RESULT
FMOD_Studio_EventInstance_SetVolume ( IntPtr _event, float volume ) : RESULT
FMOD_Studio_EventInstance_Start ( IntPtr _event ) : RESULT
FMOD_Studio_EventInstance_Stop ( IntPtr _event, STOP_MODE mode ) : RESULT
FMOD_Studio_EventInstance_TriggerCue ( IntPtr _event ) : RESULT

Method Details

EventInstance() public method

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

get3DAttributes() public method

public get3DAttributes ( FMOD.Studio.ATTRIBUTES_3D &attributes ) : RESULT
attributes	FMOD.Studio.ATTRIBUTES_3D
return	RESULT

getChannelGroup() public method

public getChannelGroup ( FMOD &group ) : RESULT
group	FMOD
return	RESULT

getDescription() public method

public getDescription ( EventDescription &description ) : RESULT
description	EventDescription
return	RESULT

getListenerMask() public method

public getListenerMask ( uint &mask ) : RESULT
mask	uint
return	RESULT

getParameter() public method

public getParameter ( string name, ParameterInstance &instance ) : RESULT
name	string
instance	ParameterInstance
return	RESULT

getParameterByIndex() public method

public getParameterByIndex ( int index, ParameterInstance &instance ) : RESULT
index	int
instance	ParameterInstance
return	RESULT

getParameterCount() public method

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

getParameterValue() public method

public getParameterValue ( string name, float &value ) : RESULT
name	string
value	float
return	RESULT

getParameterValueByIndex() public method

public getParameterValueByIndex ( int index, float &value ) : RESULT
index	int
value	float
return	RESULT

getPaused() public method

public getPaused ( bool &paused ) : RESULT
paused	bool
return	RESULT

getPitch() public method

public getPitch ( float &pitch ) : RESULT
pitch	float
return	RESULT

getPlaybackState() public method

public getPlaybackState ( PLAYBACK_STATE &state ) : RESULT
state	PLAYBACK_STATE
return	RESULT

getProperty() public method

public getProperty ( EVENT_PROPERTY index, float &value ) : RESULT
index	EVENT_PROPERTY
value	float
return	RESULT

getTimelinePosition() public method

public getTimelinePosition ( int &position ) : RESULT
position	int
return	RESULT

getUserData() public method

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

getVolume() public method

public getVolume ( float &volume ) : RESULT
volume	float
return	RESULT

isValidInternal() protected method

protected isValidInternal ( ) : bool
return	bool

isVirtual() public method

public isVirtual ( bool &virtualState ) : RESULT
virtualState	bool
return	RESULT

release() public method

public release ( ) : RESULT
return	RESULT

set3DAttributes() public method

public set3DAttributes ( FMOD.Studio.ATTRIBUTES_3D attributes ) : RESULT
attributes	FMOD.Studio.ATTRIBUTES_3D
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

setListenerMask() public method

public setListenerMask ( uint mask ) : RESULT
mask	uint
return	RESULT

setParameterValue() public method

public setParameterValue ( string name, float value ) : RESULT
name	string
value	float
return	RESULT

setParameterValueByIndex() public method

public setParameterValueByIndex ( int index, float value ) : RESULT
index	int
value	float
return	RESULT

setPaused() public method

public setPaused ( bool paused ) : RESULT
paused	bool
return	RESULT

setPitch() public method

public setPitch ( float pitch ) : RESULT
pitch	float
return	RESULT

setProperty() public method

public setProperty ( EVENT_PROPERTY index, float value ) : RESULT
index	EVENT_PROPERTY
value	float
return	RESULT

setTimelinePosition() public method

public setTimelinePosition ( int position ) : RESULT
position	int
return	RESULT

setUserData() public method

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

setVolume() public method

public setVolume ( float volume ) : RESULT
volume	float
return	RESULT

start() public method

public start ( ) : RESULT
return	RESULT

stop() public method

public stop ( STOP_MODE mode ) : RESULT
mode	STOP_MODE
return	RESULT

triggerCue() public method

public triggerCue ( ) : RESULT
return	RESULT