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

A class that contains the APIs for debugging the CriAtomExAcf application. More...

Classes

struct  AisacControlInfo
 AISAC control information More...
 
struct  CategoryInfo
 Category information More...
 
struct  DspBusInfo
 DSP bus setting information More...
 
struct  GlobalAisacInfo
 Global AISAC information More...
 
struct  SelectorInfo
 Selector information More...
 
struct  SelectorLabelInfo
 Selector Label information More...
 

Public Types

enum  AisacType { Normal, AutoModulation }
 AISAC type More...
 

Static Public Member Functions

static int GetNumCategories ()
 Gets the number of Categories More...
 
static bool GetCategoryInfoByIndex (ushort index, out CategoryInfo categoryInfo)
 Gets the Category information (index specified) More...
 
static bool GetCategoryInfoByName (string name, out CategoryInfo categoryInfo)
 Gets the Category information (name specified) More...
 
static bool GetCategoryInfoById (uint id, out CategoryInfo categoryInfo)
 Gets the Category information (ID specified) More...
 
static int GetNumBuses ()
 Gets the number of DSP buses More...
 
static bool GetDspBusInformation (ushort index, out DspBusInfo dspBusInfo)
 Gets the DSP bus More...
 
static int GetNumAisacControls ()
 Gets the number of AISAC controls More...
 
static bool GetAisacControlInfo (ushort index, out AisacControlInfo info)
 Gets the AISAC control information More...
 
static uint GetAisacControlIdByName (string name)
 Getting the AISAC control ID (specifying the AISAC control name) More...
 
static string GetAisacControlNameById (uint id)
 Gets the AISAC control name (specifying the AISAC control ID) More...
 
static int GetNumGlobalAisacs ()
 Gets the number of global AISACs More...
 
static bool GetGlobalAisacInfo (ushort index, out GlobalAisacInfo info)
 Gets the global AISAC information More...
 
static bool GetGlobalAisacInfoByName (string name, out GlobalAisacInfo info)
 Gets the global AISAC information More...
 
static int GetNumSelectors ()
 Gets the number of selectors More...
 
static bool GetSelectorInfoByIndex (ushort index, out SelectorInfo info)
 Gets the selector information More...
 
static bool GetSelectorInfoByName (string name, out SelectorInfo info)
 Gets the selector information More...
 
static bool GetSelectorLabelInfo (ref SelectorInfo selectorInfo, ushort index, out SelectorLabelInfo labelInfo)
 Gets the Selector Label information More...
 

Detailed Description

A class that contains the APIs for debugging the CriAtomExAcf application.

Member Enumeration Documentation

enum AisacType
strong

AISAC type

Enumerator
Normal 

Normal type

AutoModulation 

Auto modulation type

Member Function Documentation

static int GetNumCategories ( )
inlinestatic

Gets the number of Categories

Returns
The number of Categories
Description:
Gets the number of Categories contained in the registered ACF.
static bool GetCategoryInfoByIndex ( ushort  index,
out CategoryInfo  categoryInfo 
)
inlinestatic

Gets the Category information (index specified)

Parameters
indexCategory index
categoryInfoCategory information
Returns
Whether the information could be obtained
Description:
Gets information relative to a category by specifying its index.
If the category at the specified index does not exist, false is returned.
static bool GetCategoryInfoByName ( string  name,
out CategoryInfo  categoryInfo 
)
inlinestatic

Gets the Category information (name specified)

Parameters
nameCategory name
categoryInfoCategory information
Returns
Whether the information could be obtained
Description:
Gets information relative to a category by specifying its index.
If the category at the specified index does not exist, false is returned.
static bool GetCategoryInfoById ( uint  id,
out CategoryInfo  categoryInfo 
)
inlinestatic

Gets the Category information (ID specified)

Parameters
idCategory ID
categoryInfoCategory information
Returns
Whether the information could be obtained
Description:
Gets information relative to a category by specifying its index.
If the category at the specified index does not exist, false is returned.
static int GetNumBuses ( )
inlinestatic

Gets the number of DSP buses

Returns
Number of DSP buses
Description:
Gets the number of buses contained in the registered ACF.
static bool GetDspBusInformation ( ushort  index,
out DspBusInfo  dspBusInfo 
)
inlinestatic

Gets the DSP bus

Parameters
indexBus index
dspBusInfoBus information
Returns
Whether the bus information could be acquired
Description:
Gets information relative to a DSP Bus by specifying its index.
If the DSP bus with the specified index does not exist, false is returned.
static int GetNumAisacControls ( )
inlinestatic

Gets the number of AISAC controls

Returns
The number of AISAC controls
Description:
Gets the number of AISAC controls contained in the registered ACF.
Returns -1 if no ACF file is registered.
static bool GetAisacControlInfo ( ushort  index,
out AisacControlInfo  info 
)
inlinestatic

Gets the AISAC control information

Parameters
indexAISAC control index
infoAISAC control information
Returns
Whether the information could be obtained
Description:
Obtains the AISAC control information from the AISAC control index.
Returns false if there is no AISAC control at the specified index.
static uint GetAisacControlIdByName ( string  name)
inlinestatic

Getting the AISAC control ID (specifying the AISAC control name)

Parameters
nameAISAC control name
Returns
AISAC control ID
Description:
Gets the AISAC control ID from the AISAC control name.
Returns CriAtomEx.InvalidAisacControlId if ACF is not registered or the AISAC control with the specified AISAC control name does not exist.
static string GetAisacControlNameById ( uint  id)
inlinestatic

Gets the AISAC control name (specifying the AISAC control ID)

Parameters
idAISAC control ID
Returns
AISAC control ID
Description:
Gets the AISAC control name from the AISAC control ID.
Returns null if ACF is not registered or the AISAC control with the specified AISAC control ID does not exist.
static int GetNumGlobalAisacs ( )
inlinestatic

Gets the number of global AISACs

Returns
The number of global AISACs
Description:
Gets the number of global AISAC contained in the registered ACF.
Returns -1 if no ACF file is registered.
static bool GetGlobalAisacInfo ( ushort  index,
out GlobalAisacInfo  info 
)
inlinestatic

Gets the global AISAC information

Parameters
indexGlobal AISAC index
infoGlobal AISAC information
Returns
Whether the information could be obtained
Description:
Gets information relative to a global AISAC by specifying its index.
If the global AISAC with the specified index does not exist, false is returned.
static bool GetGlobalAisacInfoByName ( string  name,
out GlobalAisacInfo  info 
)
inlinestatic

Gets the global AISAC information

Parameters
nameGlobal AISAC name
infoGlobal AISAC information
Returns
Whether the information could be obtained
Description:
Gets information relative to a global AISAC by specifying its name.
If the global AISAC with the specified name does not exist, false is returned.
static int GetNumSelectors ( )
inlinestatic

Gets the number of selectors

Returns
The number of selectors
Description:
Gets the number of selectors contained in the registered ACF.
Returns -1 if no ACF file is registered.
static bool GetSelectorInfoByIndex ( ushort  index,
out SelectorInfo  info 
)
inlinestatic

Gets the selector information

Parameters
indexSelector index
infoSelector information
Returns
Whether the information could be obtained
Description:
Gets information relative to a selector by specifying its index.
If no selector exists at the specified index, false is returned.
static bool GetSelectorInfoByName ( string  name,
out SelectorInfo  info 
)
inlinestatic

Gets the selector information

Parameters
nameSelector name
infoSelector information
Returns
Whether the information could be obtained
Description:
Gets information relative to a selector by specifying its name.
If no selector with the specified name exists, false is returned.
static bool GetSelectorLabelInfo ( ref SelectorInfo  selectorInfo,
ushort  index,
out SelectorLabelInfo  labelInfo 
)
inlinestatic

Gets the Selector Label information

Parameters
selectorInfoSelector information
indexLabel index
labelInfoSelector Label information
Returns
Whether the information could be obtained
Description:
Gets information relative to a selector label by specifying its index.
If no selector label with the specified index exists, false will be returned.

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