CRIWARE Unity Plugin Manual  Last Updated: 2024-04-24
CriAtomExAcf クラス

ACFデータ [詳解]

クラス

struct  AcfDspBusInfo
 DSPバス設定情報取得用構造体 [詳解]
 
struct  AcfDspBusLinkInfo
 DSPバスリンク情報取得用構造体 [詳解]
 
struct  AcfDspSettingInfo
 DSPバス設定の情報取得用構造体 [詳解]
 
struct  AcfDspSettingSnapshotInfo
 DSPバス設定スナップショットの情報取得用構造体 [詳解]
 
struct  AcfInfo
 ACF情報 [詳解]
 
struct  AisacGraphInfo
 AISAC Graph情報取得用構造体 [詳解]
 
struct  CategoryInfo
 カテゴリ情報取得用構造体 [詳解]
 
struct  GlobalAisacInfo
 AISAC情報取得用構造体 [詳解]
 
struct  SelectorInfo
 セレクタ情報取得用構造体 [詳解]
 
struct  SelectorLabelInfo
 セレクタラベル情報取得用構造体 [詳解]
 

公開型

enum  AcfDspBusLinkType : uint { preVolume = 0, postVolume, postPan }
 DSPバスリンクタイプ [詳解]
 
enum  AcfAisacType : uint { normal = 0, autoModulation }
 AISACタイプ [詳解]
 
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グラフタイプ [詳解]
 
enum  CharacterEncoding : uint { utf8 = 0, sjis = 1 }
 文字コード [詳解]
 

静的公開メンバ関数

static int GetNumAisacControls ()
 AISACコントロール数の取得 [詳解]
 
static bool GetAisacControlInfo (ushort index, out CriAtomEx.AisacControlInfo info)
 AISACコントロール情報の取得 [詳解]
 
static int GetNumDspSettings ()
 DSPバス設定数の取得 [詳解]
 
static int GetNumDspSettings (IntPtr acfData, int size)
 DSPバス設定数の取得 (ACFデータ指定) [詳解]
 
static string GetDspSettingNameByIndex (ushort index)
 DSPバスセッティング名の取得 [詳解]
 
static string GetDspSettingNameByIndex (IntPtr acfData, int size, ushort index)
 DSPバスセッティング名の取得 (ACFデータ指定) [詳解]
 
static bool GetDspSettingInformation (string name, out AcfDspSettingInfo info)
 DSPバス設定情報の取得 [詳解]
 
static bool GetDspSettingSnapshotInformation (ushort index, out AcfDspSettingSnapshotInfo info)
 DSPバス設定スナップショット情報の取得 [詳解]
 
static bool GetDspBusInformation (ushort index, out AcfDspBusInfo info)
 DSPバスの取得 [詳解]
 
static bool GetDspBusLinkInformation (ushort index, out AcfDspBusLinkInfo info)
 DSPバスリンクの取得 [詳解]
 
static int GetNumCategories ()
 カテゴリ数の取得 [詳解]
 
static int GetNumCategoriesPerPlayback ()
 再生毎カテゴリ参照数の取得 [詳解]
 
static bool GetCategoryInfoByIndex (ushort index, out CategoryInfo info)
 カテゴリ情報の取得(インデックス指定) [詳解]
 
static bool GetCategoryInfoByName (string name, out CategoryInfo info)
 カテゴリ情報の取得(カテゴリ名指定) [詳解]
 
static bool GetCategoryInfoById (uint id, out CategoryInfo info)
 カテゴリ情報の取得(カテゴリID指定) [詳解]
 
static int GetNumGlobalAisacs ()
 Global AISAC数の取得 [詳解]
 
static bool GetGlobalAisacInfoByIndex (ushort index, out GlobalAisacInfo info)
 Global AISAC情報の取得(インデックス指定) [詳解]
 
static bool GetGlobalAisacInfoByName (string name, out GlobalAisacInfo info)
 Global AISAC情報の取得(名前指定) [詳解]
 
static bool GetGlobalAisacGraphInfo (GlobalAisacInfo aisacInfo, ushort graphIndex, out AisacGraphInfo graphInfo)
 Global AISAC Graph情報の取得 [詳解]
 
static bool GetGlobalAisacValue (GlobalAisacInfo aisacInfo, float control, AisacGraphType type, out float value)
 Global AISAC値の取得 [詳解]
 
static bool GetAcfInfo (out AcfInfo acfInfo)
 ACF情報の取得 [詳解]
 
static int GetNumSelectors ()
 セレクタ数の取得 [詳解]
 
static bool GetSelectorInfoByIndex (ushort index, out SelectorInfo info)
 セレクタ情報の取得(インデックス指定) [詳解]
 
static bool GetSelectorInfoByName (string name, out SelectorInfo info)
 セレクタ情報の取得(名前指定) [詳解]
 
static bool GetSelectorLabelInfo (SelectorInfo selectorInfo, ushort labelIndex, out SelectorLabelInfo info)
 セレクタラベル情報の取得 [詳解]
 
static int GetNumBuses ()
 バス数の取得 [詳解]
 
static int GetMaxBusesOfDspBusSettings ()
 DSPバス設定内の最大バス数の取得 [詳解]
 
static string FindBusName (string busName)
 ACF内のバス名取得 [詳解]
 
static CriAtomExOutputPort GetOutputPort (string name)
 ACFの出力ポートオブジェクトの取得(名前指定) [詳解]
 

詳解

ACFデータ

説明:
CRI Atom Craftで設定したプロジェクト設定を管理するクラスです。
ACFファイルに記述された各種情報を取得します。

列挙型メンバ詳解

enum AcfDspBusLinkType : uint
strong

DSPバスリンクタイプ

参照
CriAtomExAcf::AcfDspBusLinkInfo
列挙値
preVolume 

プレボリュームタイプ

postVolume 

ポストボリュームタイプ

postPan 

ポストパンタイプ

enum AcfAisacType : uint
strong

AISACタイプ

参照
CriAtomExAcf::GlobalAisacInfo
列挙値
normal 

ノーマルタイプ

autoModulation 

オートモジュレーションタイプ

enum AisacGraphType : int
strong

AISACグラフタイプ

参照
CriAtomExAcf::AisacGraphInfo
列挙値
none 

未使用

volume 

ボリューム

pitch 

ピッチ

bandpassHigh 

バンドパスフィルタの高域カットオフ周波数

bandpassLow 

バンドパスフィルタの低域カットオフ周波数

biquadFreq 

バイクアッドフィルタの周波数

biquadQ 

バイクアッドフィルタのQ値

busSend0 

バスセンドレベル0

busSend1 

バスセンドレベル1

busSend2 

バスセンドレベル2

busSend3 

バスセンドレベル3

busSend4 

バスセンドレベル4

busSend5 

バスセンドレベル5

busSend6 

バスセンドレベル6

busSend7 

バスセンドレベル7

pan3dAngel 

パンニング3D角度

pan3dVolume 

パンニング3Dボリューム

pan3dInteriorDistance 

パンニング3D距離

pan3dCenter 

ACB Ver.0.11.00以降では使用しない

pan3dLfe 

ACB Ver.0.11.00以降では使用しない

aisac0 

AISACコントロールID 0

aisac1 

AISACコントロールID 1

aisac2 

AISACコントロールID 2

aisac3 

AISACコントロールID 3

aisac4 

AISACコントロールID 4

aisac5 

AISACコントロールID 5

aisac6 

AISACコントロールID 6

aisac7 

AISACコントロールID 7

aisac8 

AISACコントロールID 8

aisac9 

AISACコントロールID 9

aisac10 

AISACコントロールID 10

aisac11 

AISACコントロールID 11

aisac12 

AISACコントロールID 12

aisac13 

AISACコントロールID 13

aisac14 

AISACコントロールID 14

aisac15 

AISACコントロールID 15

priority 

ボイスプライオリティ

preDelayTime 

プリディレイ

biquadGain 

バイクアッドフィルタのゲイン

pan3dMixdownCenter 

パンニング3D センターレベル

pan3dMixdownLfe 

パンニング3D LFEレベル

egAttack 

エンベロープ アタック

egRelease 

エンベロープ リリース

playbackRatio 

シーケンス再生レシオ

drySendL 

L chドライセンド

drySendR 

R chドライセンド

drySendCenter 

Center chドライセンド

drySendLfe 

LFE chドライセンド

drySendSl 

Surround L chドライセンド

drySendSr 

Surround R chドライセンド

drySendEx1 

Ex1 chドライセンド

drySendEx2 

Ex2 chドライセンド

panSpread 

パンスプレッド

enum CharacterEncoding : uint
strong

文字コード

説明:
文字コード(文字符号化方式)を表します。
参照
CriAtomExAcf::AcfInfo
列挙値
utf8 

UTF-8

sjis 

Shift_JIS

関数詳解

static int GetNumAisacControls ( )
inlinestatic

AISACコントロール数の取得

戻り値
AISACコントロール数
説明:
登録されたACFに含まれるAISACコントロールの数を取得します。
ACFが登録されていない場合、-1が返ります。
static bool GetAisacControlInfo ( ushort  index,
out CriAtomEx.AisacControlInfo  info 
)
inlinestatic

AISACコントロール情報の取得

引数
indexAISACコントロールインデックス
infoAISACコントロール情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
AISACコントロールインデックスからAISACコントロール情報を取得します。
指定したインデックスのAISACコントロールが存在しない場合、Falseが返ります。
static int GetNumDspSettings ( )
inlinestatic

DSPバス設定数の取得

戻り値
DSPバス設定数
説明:
ライブラリに登録されたACFデータに含まれるDSPバス設定の数を取得します。
ACFデータが登録されていない場合、本関数は -1 を返します。
static int GetNumDspSettings ( IntPtr  acfData,
int  size 
)
inlinestatic

DSPバス設定数の取得 (ACFデータ指定)

引数
acfDataACFデータのポインタ
sizeACFデータサイズ
戻り値
DSPバス設定数
説明:
指定したACFデータに含まれるDSPバス設定の数を取得します。
本関数はACFデータを登録する前でも実行可能です。
static string GetDspSettingNameByIndex ( ushort  index)
inlinestatic

DSPバスセッティング名の取得

引数
indexDSPバスセッティングのインデックス
戻り値
DSPバスセッティング名
説明:
ライブラリに登録されたACFデータからDSPバスセッティング名を取得します。
ACFデータが登録されていないか、 または指定したインデックスのDSPバスセッティングが存在しない場合、 本関数は null を返します。
static string GetDspSettingNameByIndex ( IntPtr  acfData,
int  size,
ushort  index 
)
inlinestatic

DSPバスセッティング名の取得 (ACFデータ指定)

引数
acfDataACFデータのポインタ
sizeACFデータサイズ
indexDSPバスセッティングのインデックス
戻り値
DSPバスセッティング名
説明:
ライブラリに登録されたACFデータからDSPバスセッティング名を取得します。
本関数はACFデータを登録する前でも実行可能です。
static bool GetDspSettingInformation ( string  name,
out AcfDspSettingInfo  info 
)
inlinestatic

DSPバス設定情報の取得

引数
nameセッティング名
infoセッティング情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
セッティング名を指定してセッティング情報を取得します。
指定したセッティング名のDSP settingが存在しない場合、Falseが返ります。
static bool GetDspSettingSnapshotInformation ( ushort  index,
out AcfDspSettingSnapshotInfo  info 
)
inlinestatic

DSPバス設定スナップショット情報の取得

引数
indexスナップショットインデックス
infoスナップショット情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
スナップショットインデックスを指定してスナップショット情報を取得します。
指定したセッティング名のスナップショットが存在しない場合、FALSEが返ります。
スナップショットインデックスは親となるDSPバス設定情報の CriAtomExAcf::AcfDspSettingInfo 構造体内の snapshotStartIndexメンバとnumSnapshotsメンバを元に適切な値を算出してください。
static bool GetDspBusInformation ( ushort  index,
out AcfDspBusInfo  info 
)
inlinestatic

DSPバスの取得

引数
indexバスインデックス
infoバス情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
インデックスを指定してDSPバス情報を取得します。
Returns False if there is no DSP bus with the specified index name.
static bool GetDspBusLinkInformation ( ushort  index,
out AcfDspBusLinkInfo  info 
)
inlinestatic

DSPバスリンクの取得

引数
indexDSPバスリンクインデックス
infoDSPバスリンク情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
インデックスを指定してバスリンク情報を取得します。
指定したインデックス名のDSPバスリンクが存在しない場合、Falseが返ります。
static int GetNumCategories ( )
inlinestatic

カテゴリ数の取得

戻り値
カテゴリ数
説明:
登録されたACFに含まれるカテゴリの数を取得します。
static int GetNumCategoriesPerPlayback ( )
inlinestatic

再生毎カテゴリ参照数の取得

戻り値
再生毎カテゴリ参照数
説明:
登録されたACFに含まれる再生毎カテゴリ参照数を取得します。
static bool GetCategoryInfoByIndex ( ushort  index,
out CategoryInfo  info 
)
inlinestatic

カテゴリ情報の取得(インデックス指定)

引数
indexカテゴリインデックス
infoカテゴリ情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
カテゴリインデックスからカテゴリ情報を取得します。
指定したインデックスのカテゴリが存在しない場合、Falseが返ります。
static bool GetCategoryInfoByName ( string  name,
out CategoryInfo  info 
)
inlinestatic

カテゴリ情報の取得(カテゴリ名指定)

引数
nameカテゴリ名指定
infoカテゴリ情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
カテゴリ名からカテゴリ情報を取得します。
指定したカテゴリ名のカテゴリが存在しない場合、Falseが返ります。
static bool GetCategoryInfoById ( uint  id,
out CategoryInfo  info 
)
inlinestatic

カテゴリ情報の取得(カテゴリID指定)

引数
idカテゴリID
infoカテゴリ情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
カテゴリIDからカテゴリ情報を取得します。
指定したカテゴリIDのカテゴリが存在しない場合、Falseが返ります。
static int GetNumGlobalAisacs ( )
inlinestatic

Global AISAC数の取得

戻り値
Global AISAC数
説明:
登録されたACFに含まれるGlobal AISACの数を取得します。
static bool GetGlobalAisacInfoByIndex ( ushort  index,
out GlobalAisacInfo  info 
)
inlinestatic

Global AISAC情報の取得(インデックス指定)

引数
indexGlobal AISACインデックス
infoGlobal AISAC情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
Global AISACインデックスからAISAC情報を取得します。
指定したインデックスのGlobal AISACが存在しない場合、Falseが返ります。
static bool GetGlobalAisacInfoByName ( string  name,
out GlobalAisacInfo  info 
)
inlinestatic

Global AISAC情報の取得(名前指定)

引数
nameGlobal AISAC名
infoGlobal AISAC情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
Global AISAC名からAISAC情報を取得します。
指定した名前のGlobal AISACが存在しない場合、Falseが返ります。
static bool GetGlobalAisacGraphInfo ( GlobalAisacInfo  aisacInfo,
ushort  graphIndex,
out AisacGraphInfo  graphInfo 
)
inlinestatic

Global AISAC Graph情報の取得

引数
aisacInfoGlobal AISAC情報
graphIndexGlobal AISAC graphインデックス
graphInfoAISAC graph情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
Global AISAC情報とgraphインデックスからgraph情報を取得します。
指定したインデックスのGlobal AISACが存在しない場合、Falseが返ります。
static bool GetGlobalAisacValue ( GlobalAisacInfo  aisacInfo,
float  control,
AisacGraphType  type,
out float  value 
)
inlinestatic

Global AISAC値の取得

引数
aisacInfoGlobal AISAC情報
controlAISACコントロール値
typeグラフタイプ
valueAISAC値
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
Global AISAC情報、コントロール値、グラフタイプを指定してAISAC値を取得します。
指定したインデックスのGlobal AISACが存在しない場合やグラフが存在しない場合は、Falseが返ります。
static bool GetAcfInfo ( out AcfInfo  acfInfo)
inlinestatic

ACF情報の取得

引数
acfInfoACF情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
ライブラリに登録されたACFデータの各種情報を取得します。
ACF情報の取得に失敗した場合、Falseが返ります。
static int GetNumSelectors ( )
inlinestatic

セレクタ数の取得

戻り値
セレクタ数
説明:
登録されたACFに含まれるセレクタの数を取得します。
static bool GetSelectorInfoByIndex ( ushort  index,
out SelectorInfo  info 
)
inlinestatic

セレクタ情報の取得(インデックス指定)

引数
indexセレクタインデックス
infoセレクタ情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
セレクタインデックスからセレクタ情報を取得します。
指定したインデックスのセレクタが存在しない場合、Falseが返ります。
static bool GetSelectorInfoByName ( string  name,
out SelectorInfo  info 
)
inlinestatic

セレクタ情報の取得(名前指定)

引数
nameセレクタ名
infoセレクタ情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
セレクタ名からセレクタ情報を取得します。
指定した名前のセレクタが存在しない場合、Falseが返ります。
static bool GetSelectorLabelInfo ( SelectorInfo  selectorInfo,
ushort  labelIndex,
out SelectorLabelInfo  info 
)
inlinestatic

セレクタラベル情報の取得

引数
selectorInfoセレクタ情報
labelIndexラベルインデックス
infoセレクタラベル情報
戻り値
情報が取得できたかどうか?(取得できた:True/取得できない:False)
説明:
セレクタ情報とセレクタラベルインデックスからセレクタラベル情報を取得します。
指定したインデックスのセレクタラベルが存在しない場合、Falseが返ります。
static int GetNumBuses ( )
inlinestatic

バス数の取得

戻り値
バス数
説明:
登録されたACFに含まれるバスの数を取得します。
static int GetMaxBusesOfDspBusSettings ( )
inlinestatic

DSPバス設定内の最大バス数の取得

戻り値
DSPバス設定内の最大バス数
説明:
登録されたACFに含まれるDSPバス設定内の最大バスの数を取得します。
static string FindBusName ( string  busName)
inlinestatic

ACF内のバス名取得

引数
busNameバス名
戻り値
ACF内バス名
説明:
指定されたバス名のACF内文字列を取得します。
存在しないバス名を指定した場合はNULLが返ります。
static CriAtomExOutputPort GetOutputPort ( string  name)
inlinestatic

ACFの出力ポートオブジェクトの取得(名前指定)

引数
name出力ポート名
戻り値
出力ポートオブジェクト
説明:
ACFに保持されている出力ポートの中から、指定した出力ポート名のオブジェクトを取得します。
ACFの出力ポートオブジェクトはACFの登録時に生成、保持されます。
ACFに登録された出力ポート名は、ACFのヘッダーに記載されています。
生成後の出力ポートオブジェクトにはデフォルトASRラックが設定されているため、この関数で取得したオブジェクトに対して
CriWare.CriAtomExOutputPort.SetAsrRackId で適切なASRラックを指定する必要があります。
参照
CriWare.CriAtomEx.RegisterAcf, CriWare.CriAtomExOutputPort.SetAsrRackId

このクラス詳解は次のファイルから抽出されました: