CriAtomExAcf Class Reference

ACF data More...

Classes
struct	AcfDspBusInfo
	A structure for getting the DSP bus setting information More...
struct	AcfDspBusLinkInfo
	A structure for getting the DSP bus link information More...
struct	AcfDspSettingInfo
	A structure for getting the DSP bus setting information More...
struct	AcfDspSettingSnapshotInfo
	A structure for getting the DSP bus setting snapshot information More...
struct	AcfInfo
	ACF information More...
struct	AisacGraphInfo
	A structure for getting the AISAC Graph information More...
struct	CategoryInfo
	A structure for getting the Category information More...
struct	GlobalAisacInfo
	A structure for getting the AISAC information More...
struct	SelectorInfo
	A structure for getting the selector information More...
struct	SelectorLabelInfo
	A structure for getting the Selector Label information More...

Public Types
enum	DspBusOutputType {   None = 0, Main = 1, MainPassthrough = 2, PadHaptic = 3,   PadSpeaker = 4, Personal = 5, PersonalPassthrough = 6 }
	バス出力タイプ More...
enum	AcfDspBusLinkType : uint { preVolume = 0, postVolume, postPan }
	DSP bus link type More...
enum	AcfAisacType : uint { normal = 0, autoModulation }
	AISAC type More...
enum	AisacGraphType : int {   none = 0, volume, pitch, bandpassHigh,   bandpassLow, biquadFreq, biquadQ, busSend0,   busSend1, busSend2, busSend3, busSend4,   busSend5, busSend6, busSend7, pan3dAngel,   pan3dVolume, pan3dInteriorDistance, pan3dCenter, pan3dLfe,   aisac0, aisac1, aisac2, aisac3,   aisac4, aisac5, aisac6, aisac7,   aisac8, aisac9, aisac10, aisac11,   aisac12, aisac13, aisac14, aisac15,   priority, preDelayTime, biquadGain, pan3dMixdownCenter,   pan3dMixdownLfe, egAttack, egRelease, playbackRatio,   drySendL, drySendR, drySendCenter, drySendLfe,   drySendSl, drySendSr, drySendEx1, drySendEx2,   panSpread }
	AISAC graph type More...
enum	CharacterEncoding : uint { utf8 = 0, sjis = 1 }
	Character code More...

Static Public Member Functions
static int	GetNumAisacControls ()
	Gets the number of AISAC controls More...
static bool	GetAisacControlInfo (ushort index, out CriAtomEx.AisacControlInfo info)
	Gets the AISAC control information More...
static int	GetNumDspSettings ()
	Gets the number of DSP bus settings More...
static int	GetNumDspSettings (IntPtr acfData, int size)
	Acquiring the DSP bus setting (from the specified ACF data) More...
static string	GetDspSettingNameByIndex (ushort index)
	Acquiring the DSP bus setting's name More...
static string	GetDspSettingNameByIndex (IntPtr acfData, int size, ushort index)
	Acquiring the DSP bus setting's name (from the specified ACF data) More...
static bool	GetDspSettingInformation (string name, out AcfDspSettingInfo info)
	Gets the DSP bus setting information More...
static bool	GetDspSettingSnapshotInformation (ushort index, out AcfDspSettingSnapshotInfo info)
	Gets the DSP bus setting snapshot information More...
static bool	GetDspBusInformation (ushort index, out AcfDspBusInfo info)
	Gets the DSP bus More...
static bool	GetDspBusLinkInformation (ushort index, out AcfDspBusLinkInfo info)
	Gets the DSP bus link More...
static int	GetNumCategories ()
	Gets the number of Categories More...
static int	GetNumCategoriesPerPlayback ()
	Gets the number of Category references per playback More...
static bool	GetCategoryInfoByIndex (ushort index, out CategoryInfo info)
	Gets the Category information (index specified) More...
static bool	GetCategoryInfoByName (string name, out CategoryInfo info)
	Gets the Category information (Category name specified) More...
static bool	GetCategoryInfoById (uint id, out CategoryInfo info)
	Gets the Category information (Category ID specified) More...
static int	GetNumGlobalAisacs ()
	Gets the number of Global AISACs More...
static bool	GetGlobalAisacInfoByIndex (ushort index, out GlobalAisacInfo info)
	Gets the Global AISAC information (index specified) More...
static bool	GetGlobalAisacInfoByName (string name, out GlobalAisacInfo info)
	Gets the Global AISAC information (name specified) More...
static bool	GetGlobalAisacGraphInfo (GlobalAisacInfo aisacInfo, ushort graphIndex, out AisacGraphInfo graphInfo)
	Gets the Global AISAC Graph information More...
static bool	GetGlobalAisacValue (GlobalAisacInfo aisacInfo, float control, AisacGraphType type, out float value)
	Gets the Global AISAC value More...
static bool	GetAcfInfo (out AcfInfo acfInfo)
	Gets the ACF information More...
static int	GetNumSelectors ()
	Gets the number of selectors More...
static bool	GetSelectorInfoByIndex (ushort index, out SelectorInfo info)
	Gets the selector information (index specified) More...
static bool	GetSelectorInfoByName (string name, out SelectorInfo info)
	Gets the selector information (name specified) More...
static bool	GetSelectorLabelInfo (SelectorInfo selectorInfo, ushort labelIndex, out SelectorLabelInfo info)
	Gets the Selector Label information More...
static int	GetNumBuses ()
	Gets the number of buses More...
static int	GetMaxBusesOfDspBusSettings ()
	Gets the maximum number of buses in the DSP bus settings More...
static string	FindBusName (string busName)
	Gets the bus name in ACF More...
static CriAtomExOutputPort	GetOutputPort (string name)
	Get the output port object from the ACF by name More...

Detailed Description

ACF data

Description:

A class which manages the project settings set on CRI Atom Craft.
Acquires various information described in the ACF file.

Member Enumeration Documentation

enum DspBusOutputType

strong

バス出力タイプ

ツールで設定したバスの出力タイプです。 パッド出力や個人出力は、プラットフォーム機能に依存します。 対応状況については、各種プラットフォーム向けのマニュアルを参照してください。

See also

CriAtomExAcf.DspBusInfo

Enumerator
None	ルーティングバス
Main	メインスピーカー出力
MainPassthrough	メインパススルー出力
PadHaptic	パッド音声振動出力
PadSpeaker	パッドスピーカー出力
Personal	個人出力
PersonalPassthrough	個人出力パススルー

enum AcfDspBusLinkType : uint

strong

DSP bus link type

See also

CriAtomExAcf::AcfDspBusLinkInfo

Enumerator
preVolume	Pre-volume type
postVolume	Post volume type
postPan	Post Panning type

enum AcfAisacType : uint

strong

AISAC type

See also

CriAtomExAcf::GlobalAisacInfo

Enumerator
normal	Normal type
autoModulation	Auto modulation type

enum AisacGraphType : int

strong

AISAC graph type

See also

CriAtomExAcf::AisacGraphInfo

Enumerator
none	Unused
volume	Volume
pitch	Pitch
bandpassHigh	High cutoff frequency of the BandPass Filter
bandpassLow	Low cutoff frequency of the BandPass Filter
biquadFreq	Biquad Filter frequency
biquadQ	Q value of the Biquad Filter
busSend0	Bus Send Level 0
busSend1	Bus Send Level 1
busSend2	Bus Send Level 2
busSend3	Bus Send Level 3
busSend4	Bus Send Level 4
busSend5	Bus Send Level 5
busSend6	Bus Send Level 6
busSend7	Bus Send Level 7
pan3dAngel	Panning 3D angle
pan3dVolume	Panning 3D volume
pan3dInteriorDistance	Panning 3D distance
pan3dCenter	Not used in ACB Ver.0.11.00 and later.
pan3dLfe	Not used in ACB Ver.0.11.00 and later.
aisac0	AISAC control ID 0
aisac1	AISAC control ID 1
aisac2	AISAC control ID 2
aisac3	AISAC control ID 3
aisac4	AISAC control ID 4
aisac5	AISAC control ID 5
aisac6	AISAC control ID 6
aisac7	AISAC control ID 7
aisac8	AISAC control ID 8
aisac9	AISAC control ID 9
aisac10	AISAC control ID 10
aisac11	AISAC control ID 11
aisac12	AISAC control ID 12
aisac13	AISAC control ID 13
aisac14	AISAC control ID 14
aisac15	AISAC control ID 15
priority	Voice Priority
preDelayTime	Pre-delay
biquadGain	Biquad Filter gain
pan3dMixdownCenter	Panning 3D center level
pan3dMixdownLfe	Panning 3D LFE level
egAttack	Envelope Attack
egRelease	Envelope Release
playbackRatio	Sequence playback ratio
drySendL	L ch dry send
drySendR	R ch dry send
drySendCenter	Center ch dry send
drySendLfe	LFE ch dry send
drySendSl	Surround L ch dry send
drySendSr	Surround R ch dry send
drySendEx1	Ex1 ch dry send
drySendEx2	Ex2 ch dry send
panSpread	Panning spread

enum CharacterEncoding : uint

strong

Character code

Description:

Indicates the character code (character encoding method).

See also

CriAtomExAcf::AcfInfo

Enumerator
utf8	UTF-8
sjis	Shift_JIS

Member Function Documentation

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 CriAtomEx.AisacControlInfo  info  )

inlinestatic

Gets the AISAC control information

Parameters

index	AISAC control index
info	AISAC control information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets the AISAC control information from the AISAC control index.
Returns False if there is no AISAC control with the specified index.

static int GetNumDspSettings ( )

inlinestatic

Gets the number of DSP bus settings

Returns

The number of DSP bus settings

Description:

Gets the number of DSP bus settings included in the ACF data registered with the library.
This function returns -1 when ACF data is not registered.

static int GetNumDspSettings ( IntPtr  acfData, int  size  )

inlinestatic

Acquiring the DSP bus setting (from the specified ACF data)

Parameters

acfData	ACF data pointer
size	ACF data size

Returns

The number of DSP bus settings

Description:

Gets the number of DSP bus settings contained in the specified ACF data.
This function can be called before the ACF data is registered.

static string GetDspSettingNameByIndex ( ushort  index )

inlinestatic

Acquiring the DSP bus setting's name

Parameters

index

DSP bus setting index

Returns

DSP bus setting name

Description:

Obtains the DSP bus setting name from the ACF data registered with the library.
Returns null if no ACF data is registered or the DSP bus setting with the specified index does not exist.

static string GetDspSettingNameByIndex ( IntPtr  acfData, int  size, ushort  index  )

inlinestatic

Acquiring the DSP bus setting's name (from the specified ACF data)

Parameters

acfData	ACF data pointer
size	ACF data size
index	DSP bus setting index

Returns

DSP bus setting name

Description:

Obtains the DSP bus setting name from the ACF data registered with the library.
This function can be called before the ACF data is registered.

static bool GetDspSettingInformation ( string  name, out AcfDspSettingInfo  info  )

inlinestatic

Gets the DSP bus setting information

Parameters

name	Setting name
info	Setting information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets the setting information by specifying the setting name.
Returns false if there is no DSP setting with the specified setting name.

static bool GetDspSettingSnapshotInformation ( ushort  index, out AcfDspSettingSnapshotInfo  info  )

inlinestatic

Gets the DSP bus setting snapshot information

Parameters

index	Snapshot index
info	Snapshot information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets the snapshot information by specifying the snapshot index.
Returns FALSE if there is no snapshot with the specified setting name.
For the snapshot index, calculate an appropriate value based on the snapshotStartIndex and numSnapshots members in the CriAtomExAcf::AcfDspSettingInfo structure of the parent DSP bus setting information.

static bool GetDspBusInformation ( ushort  index, out AcfDspBusInfo  info  )

inlinestatic

Gets the DSP bus

Parameters

index	Bus index
info	Bus information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets the DSP bus information by specifying the index.
Returns False if there is no DSP bus with the specified index name.

static bool GetDspBusLinkInformation ( ushort  index, out AcfDspBusLinkInfo  info  )

inlinestatic

Gets the DSP bus link

Parameters

index	DSP bus link index
info	DSP bus link information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets the bus link information by specifying the index.
Returns False if there is no DSP bus link with the specified index name.

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 int GetNumCategoriesPerPlayback ( )

inlinestatic

Gets the number of Category references per playback

Returns

The number of Category references per playback

Description:

Gets the number of Category references by playback contained in the registered ACF.

static bool GetCategoryInfoByIndex ( ushort  index, out CategoryInfo  info  )

inlinestatic

Gets the Category information (index specified)

Parameters

index	Category index
info	Category information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets the Category information from the Category index.
Returns False if there is no Category with the specified index.

static bool GetCategoryInfoByName ( string  name, out CategoryInfo  info  )

inlinestatic

Gets the Category information (Category name specified)

Parameters

name	Specify Category name
info	Category information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets Category information from the Category name.
Returns False if there is no Category with the specified Category name.

static bool GetCategoryInfoById ( uint  id, out CategoryInfo  info  )

inlinestatic

Gets the Category information (Category ID specified)

Parameters

id	Category ID
info	Category information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets the Category information from the Category ID.
Returns False if there is no category with the specified category ID.

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.

static bool GetGlobalAisacInfoByIndex ( ushort  index, out GlobalAisacInfo  info  )

inlinestatic

Gets the Global AISAC information (index specified)

Parameters

index	Global AISAC index
info	Global AISAC information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets AISAC information from the Global AISAC index.
Returns False if there is no Global AISAC with the specified index.

static bool GetGlobalAisacInfoByName ( string  name, out GlobalAisacInfo  info  )

inlinestatic

Gets the Global AISAC information (name specified)

Parameters

name	Global AISAC name
info	Global AISAC information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets the AISAC information from the Global AISAC name
Returns False if there is no Global AISAC with the specified name.

static bool GetGlobalAisacGraphInfo ( GlobalAisacInfo  aisacInfo, ushort  graphIndex, out AisacGraphInfo  graphInfo  )

inlinestatic

Gets the Global AISAC Graph information

Parameters

aisacInfo	Global AISAC information
graphIndex	Global AISAC graph index
graphInfo	AISAC graph information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets the graph information from the Global AISAC information and graph index.
Returns False if there is no Global AISAC with the specified index.

static bool GetGlobalAisacValue ( GlobalAisacInfo  aisacInfo, float  control, AisacGraphType  type, out float  value  )

inlinestatic

Gets the Global AISAC value

Parameters

aisacInfo	Global AISAC information
control	AISAC control value
type	Graph type
value	AISAC value

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets the AISAC value by specifying Global AISAC information, control value and graph type.
Returns False if there is no Global AISAC with the specified index or there is no graph.

static bool GetAcfInfo ( out AcfInfo  acfInfo )

inlinestatic

Gets the ACF information

Parameters

acfInfo

ACF information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets various information on the ACF data registered with the library.
Returns False if acquisition of the ACF information failed.

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.

static bool GetSelectorInfoByIndex ( ushort  index, out SelectorInfo  info  )

inlinestatic

Gets the selector information (index specified)

Parameters

index	Selector index
info	Selector information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets the selector information from the selector index.
Returns False if there is no selector with the specified index.

static bool GetSelectorInfoByName ( string  name, out SelectorInfo  info  )

inlinestatic

Gets the selector information (name specified)

Parameters

name	Selector name
info	Selector information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Get the selector information from the selector name.
Returns False if there is no selector with the specified name.

static bool GetSelectorLabelInfo ( SelectorInfo  selectorInfo, ushort  labelIndex, out SelectorLabelInfo  info  )

inlinestatic

Gets the Selector Label information

Parameters

selectorInfo	Selector information
labelIndex	Label index
info	Selector Label information

Returns

Whether the information can be acquired. (Could be acquired: True / could not be acquired: False)

Description:

Gets the Selector Label information from the selector information and Selector Label index.
Returns False if there is no Selector Label with the specified index.

static int GetNumBuses ( )

inlinestatic

Gets the number of buses

Returns

The number of buses

Description:

Gets the number of buses contained in the registered ACF.

static int GetMaxBusesOfDspBusSettings ( )

inlinestatic

Gets the maximum number of buses in the DSP bus settings

Returns

Maximum number of buses in the DSP bus settings

Description:

Gets the maximum number of buses in the DSP bus settings contained in the registered ACF.

static string FindBusName ( string  busName )

inlinestatic

Gets the bus name in ACF

Parameters

busName

Bus name

Returns

Bus name in ACF

Description:

Gets the string in the ACF for the specified bus name.
Returns NULL if you specify a bus name that does not exist.

static CriAtomExOutputPort GetOutputPort ( string  name )

inlinestatic

Get the output port object from the ACF by name

Parameters

name	Output port name

Returns

Output port object

Description:

Gets the output port object with the specified name from the output ports defined in the ACF.
Output port objects in the ACF are generated when the ACF is registered.
The output port names registered in the ACF are listed in its header.
Since the default ASR Rack is set for the output port object after it is generated,
the appropriate ASR Rack must be specified with CriWare.CriAtomExOutputPort.SetAsrRackId for the object returned by this function.

See also

CriWare.CriAtomEx.RegisterAcf, CriWare.CriAtomExOutputPort.SetAsrRackId

---

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

• CriAtomExAcf.cs