Unigine.Plugins.FMOD.EventDescription Class
Notice
This set of functions is available when the FMOD plugin is loaded.
The description for an FMOD Studio Event.
Event descriptions belong to banks and can be queried after the relevant bank has been loaded. Event descriptions may be retrieved via path or GUID lookup, or by enumerating all descriptions in a bank.
EventDescription Class
Properties
bool IsSampleUnloading#
The value indicating if the sample is unloading.
bool IsSampleUnloaded#
The value indicating if the sample is unloaded.
bool IsSampleLoading#
The value indicating if the sample loading is in progress.
bool IsSampleLoaded#
The value indicating if the sample is loaded and ready to play.
bool IsSampleError#
The value indicating if the sample has failed to load.
bool IsValid#
The value indicating if the event description is valid.
int Length#
The length of the timeline.
bool IsDopplerEnabled#
The value indicating if the doppler effect is enabled.
bool IsOneShot#
The value indicating if the event is a oneshot event.
Members
EventInstance CreateEvent ( ) #
Creates a playable instance.Return value
EventInstance object.void ReleaseAllEvents ( ) #
Releases all instances.void LoadSampleData ( ) #
Loads all non-streaming sample data.void UnloadSampleData ( ) #
Unloads all non-streaming sample data. Sample data will not be unloaded until all instances of the event are released.void Release ( ) #
Marks the event instance for release. Event instances marked for release are destroyed by the asynchronous update when they are in the stopped state.void ReleaseFromStudio ( ) #
Auxiliary function, should not be used.void Update ( ) #
Updates the position of the event instance in world space.string GetPath ( ) #
Returns the path to the event description.Return value
Path.Last update:
2023-03-15
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)