EventDescription Class

Members

---

int isSampleUnloading ( ) #

Returns the sample data unloading state.

Return value

1 if the sample is unloading, otherwise, 0.

int isSampleUnloaded ( ) #

Returns the sample data unloaded state.

Return value

1 if the sample is unloaded, otherwise, 0.

int isSampleLoading ( ) #

Returns the sample data loading state.

Return value

1 if the sample is loading, otherwise, 0.

int isSampleLoaded ( ) #

Returns the sample data loaded state.

Return value

1 if the sample is loaded, otherwise, 0.

int isSampleError ( ) #

Returns the value indicating if the sample data has failed to load.

Return value

1 if the sample has failed to load, otherwise, 0.

int isValid ( ) #

Returns the value indicating if the event description is valid.

Return value

1 if the event description is valid, otherwise, 0.

int getLength ( ) #

Returns the length of the timeline.

Return value

Timeline length.

int isDopplerEnabled ( ) #

Returns the value indicating if the doppler effect is enabled for the event.

Return value

1 if the doppler effect is enabled, otherwise, 0.

int isOneShot ( ) #

Returns the value indicating if the event is a oneshot event.

Return value

1 if the event is a oneshot event, otherwise, 0.

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.