CRIWARE initialization component More...

Inherits CriMonoBehaviour.

Public Member Functions
void	Initialize ()
	Initializes the plug-in (for manual initialization) More...

void	Shutdown ()
	Terminates the plug-in (for manual termination) More...

Static Public Member Functions
static void	AddAudioEffectInterface (IntPtr effect_interface)
	Registers the interface of a custom effect More...

Public Attributes
bool	initializesFileSystem = true

CriFsConfig	fileSystemConfig = new CriFsConfig()

bool	initializesAtom = true

CriAtomConfig	atomConfig = new CriAtomConfig()

bool	initializesMana = true

CriManaConfig	manaConfig = new CriManaConfig()

bool	dontInitializeOnAwake = false

bool	dontDestroyOnLoad = false

Detailed Description

CRIWARE initialization component

Member Function Documentation

void Initialize ( )

inline

Initializes the plug-in (for manual initialization)

Description:: Initializes the plug-in.
By default, this function is automatically called in the Awake function, so the application does not need to call it directly.

Use this function if you want to dynamically change the initialization parameters from the script.

Note:: When using this function, check the CriWare.CriWareInitializer::dontInitializeOnAwake property on the Inspector to disable the automatic initialization.
In addition, this function must be called before any plug-in APIs. Call it in a script with a higher Script Execution Order.

void Shutdown ( )

inline

Terminates the plug-in (for manual termination)

Description:: Exits the plug-in.
By default, this function is automatically called in the OnDestroy function, so the application does not need to call it directly.

static void AddAudioEffectInterface ( IntPtr effect_interface )

inlinestatic

Registers the interface of a custom effect

Description:: A method for registering the interface of the ASR bus effect (custom effect) implemented by users. You can create your own ASR bus effect by using the CRI ADX Audio Effect Plugin SDK.
Normally, you can only use the provided effect processing. By implementing the custom effects library according to the rules defined by CRIWARE, users can prepare the custom effects interface for CRIWAER Unity Plug-in.
By registering the pointer to this interface with the CRIWAER Unity Plug-in using this function, the custom effect is enabled when the CRI library is initialized.
Note that the registered custom effects is forcibly unregistered when the CRI library is finalized. When initializing the CRI library again, call this function again to register the custom effect interface.

Note:: Be sure to call this function before initializing the CRI library. The custom effect interface added by this function is actually enabled in the initialization process of the CRI library.

bool initializesFileSystem = true

Whether to initialize the CRI File System library

CriFsConfig fileSystemConfig = new CriFsConfig()

Initialization configuration of the CRI File System library

bool initializesAtom = true

Whether to initialize the CRI Atom library

Initialization configuration of the CRI Atom library

bool initializesMana = true

Whether to initialize the CRI Mana library

Initialization configuration of the CRI Mana library

bool dontInitializeOnAwake = false

Whether to initialize the library on Awake

bool dontDestroyOnLoad = false

Whether to finalize the library at scene change

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