CRIWARE Unity Plugin Manual  Last Updated: 2024-07-12
CriAtomPlugin Class Reference

Global class of the CRI Atom library. More...

Static Public Member Functions

static void ExecuteQueuedCueLinkCallbacks ()
 Execution of the Cue Link callback More...
 
static void ExecuteQueuedEventCallbacks ()
 Execution of the sequence event callback More...
 
static void ExecuteQueuedBeatSyncCallbacks ()
 Execution of the beat synchronization callback More...
 
static int GetOutputSamplingRate ()
 Gets the output sampling rate More...
 
static int GetOutputChannels ()
 Gets the number of output channels More...
 

Events

static System.Action OnFinalized = null
 Event immediately after finalizing the Atom library More...
 

Detailed Description

Global class of the CRI Atom library.

Description:
Class that contains the initialization functions of the CRI Atom library as well as the definitions of the types used within the library.

Member Function Documentation

static void ExecuteQueuedCueLinkCallbacks ( )
inlinestatic

Execution of the Cue Link callback

Description:
A function to execute a Cue Link callback event triggered by the Atom Server thread.
When this function is called, the callback function registered in CriAtomEx::OnCueLinkCallback will be executed if an event has occurred.
Note:
This function is called periodically by the CriAtomServer component and usually does not need to be called by the user.
Calls this function if callbacks are needed when the application is not running (e.g. in an Editor extension).
static void ExecuteQueuedEventCallbacks ( )
inlinestatic

Execution of the sequence event callback

Description:
A function to execute a callback event synchronized with a callback marker triggered by the Atom Server thread.
When this function is called, the callback function registered in CriAtomExSequencer::OnCallback will be executed if an event has occurred.
Note:
This function is called periodically by the CriAtomServer component and usually does not need to be called by the user.
Calls this function if callbacks are needed when the application is not running (e.g. in an Editor extension).
static void ExecuteQueuedBeatSyncCallbacks ( )
inlinestatic

Execution of the beat synchronization callback

Description:
A function to execute a beat-synchronized callback event triggered by the Atom Server thread.
When this function is called, the callback functions registered in CriAtomExPlayer::OnBeatSyncCallback and CriAtomExBeatSync::OnCallback will be executed if an event has occurred.
Note:
This function is called periodically by the CriAtomServer component and usually does not need to be called by the user.
Calls this function if callbacks are needed when the application is not running (e.g. in an Editor extension).
static int GetOutputSamplingRate ( )
inlinestatic

Gets the output sampling rate

Returns
Output sampling rate
Description:
Gets the sampling rate of the PCM data output by the Atom library.
static int GetOutputChannels ( )
inlinestatic

Gets the number of output channels

Returns
The number of output channels
Description:
Gets the number of channels of the PCM data output by the Atom library.

Event Documentation

System.Action OnFinalized = null
static

Event immediately after finalizing the Atom library

Description:
The callback event being called immediately after the Atom library finalization.
When called after finalizing the library, the contents will be cleared.

The documentation for this class was generated from the following file: