Class CriAtomExAcf
CriAtomExAcf API
Inherited Members
Namespace: CriWare
Assembly: CriWare.CriAtom.dll
Syntax
public static class CriAtomExAcf
Methods
FindBusName(ArgString)
ACF内のバス名取得
Declaration
public static NativeString FindBusName(ArgString busName)
Parameters
Type | Name | Description |
---|---|---|
ArgString | busName | バス名 |
Returns
Type | Description |
---|---|
NativeString | CriChar8* ACF内バス名 |
Remarks
説明: 指定されたバス名のACF内文字列を取得します。 存在しないバス名を指定した場合はnullが返ります。
GetAcfInfo(out Info)
ACF情報の取得
Declaration
public static bool GetAcfInfo(out CriAtomExAcf.Info acfInfo)
Parameters
Type | Name | Description |
---|---|---|
CriAtomExAcf.Info | acfInfo | ACF情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: ライブラリに登録されたACFデータの各種情報を取得します。 ACF情報の取得に失敗した場合、falseが返ります。
GetAcfInfoFromAcfData(IntPtr, int, out Info)
ACFデータからACF情報を取得
Declaration
public static bool GetAcfInfoFromAcfData(IntPtr acfData, int acfDataSize, out CriAtomExAcf.Info acfInfo)
Parameters
Type | Name | Description |
---|---|---|
IntPtr | acfData | ACFデータ |
int | acfDataSize | ACFデータサイズ |
CriAtomExAcf.Info | acfInfo | ACF情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: 指定されたACFデータの各種情報を取得します。 ACF情報の取得に失敗した場合、falseが返ります。
備考: GetAcfInfo(out Info) 関数と異なり、 ACF情報を登録する前でも本関数は実行可能です。
注意: 取得したACF情報内のポインタメンバは、ACFデータ領域内を指しています。(名前文字列へのポインタ等) 取得したACF情報を参照している間は、ACFデータ領域を解放しないようご注意ください。
See Also
GetAisacControlIdByName(ArgString)
AISACコントロールIDの取得(AISACコントロール名指定)
Declaration
public static uint GetAisacControlIdByName(ArgString name)
Parameters
Type | Name | Description |
---|---|---|
ArgString | name | AISACコントロール名 |
Returns
Type | Description |
---|---|
uint | AISACコントロールID |
Remarks
説明: AISACコントロール名からAISACコントロールIDを取得します。 ACFが登録されていない、または指定したAISACコントロール名のAISACコントロールが存在しない場合、InvalidAisacControlIdが返ります。
GetAisacControlInfo(ushort, out AisacControlInfo)
AISACコントロール情報の取得
Declaration
public static bool GetAisacControlInfo(ushort index, out CriAtomEx.AisacControlInfo info)
Parameters
Type | Name | Description |
---|---|---|
ushort | index | AISACコントロールインデックス |
CriAtomEx.AisacControlInfo | info | AISACコントロール情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: AISACコントロールインデックスからAISACコントロール情報を取得します。 指定したインデックスのAISACコントロールが存在しない場合、falseが返ります。
GetAisacControlNameById(uint)
AISACコントロール名の取得(AISACコントロールID指定)
Declaration
public static NativeString GetAisacControlNameById(uint id)
Parameters
Type | Name | Description |
---|---|---|
uint | id | AISACコントロールID |
Returns
Type | Description |
---|---|
NativeString | CriChar8* AISACコントロール名 |
Remarks
説明: AISACコントロールIDからAISACコントロール名を取得します。 ACFが登録されていない、または指定したAISACコントロールIDのAISACコントロールが存在しない場合、nullが返ります。
GetCategoryInfo(ushort, out Info)
カテゴリ情報の取得(インデックス指定)
Declaration
public static bool GetCategoryInfo(ushort index, out CriAtomExCategory.Info info)
Parameters
Type | Name | Description |
---|---|---|
ushort | index | カテゴリインデックス |
CriAtomExCategory.Info | info | カテゴリ情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: カテゴリインデックスからカテゴリ情報を取得します。 指定したインデックスのカテゴリが存在しない場合、falseが返ります。
GetCategoryInfoById(uint, out Info)
カテゴリ情報の取得(カテゴリID指定)
Declaration
public static bool GetCategoryInfoById(uint id, out CriAtomExCategory.Info info)
Parameters
Type | Name | Description |
---|---|---|
uint | id | カテゴリID |
CriAtomExCategory.Info | info | カテゴリ情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: カテゴリIDからカテゴリ情報を取得します。 指定したカテゴリIDのカテゴリが存在しない場合、falseが返ります。
GetCategoryInfoByName(ArgString, out Info)
カテゴリ情報の取得(カテゴリ名指定)
Declaration
public static bool GetCategoryInfoByName(ArgString name, out CriAtomExCategory.Info info)
Parameters
Type | Name | Description |
---|---|---|
ArgString | name | カテゴリ名 |
CriAtomExCategory.Info | info | カテゴリ情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: カテゴリ名からカテゴリ情報を取得します。 指定したカテゴリ名のカテゴリが存在しない場合、falseが返ります。
GetDspBusInformation(ushort, out DspBusInfo)
DSPバスの取得
Declaration
public static bool GetDspBusInformation(ushort index, out CriAtomExAcf.DspBusInfo info)
Parameters
Type | Name | Description |
---|---|---|
ushort | index | バスインデックス |
CriAtomExAcf.DspBusInfo | info | バス情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: インデックスを指定してDSPバス情報を取得します。 指定したインデックス名のDSPバスが存在しない場合、falseが返ります。
See Also
GetDspBusLinkInformation(ushort, out DspBusLinkInfo)
DSPバスリンクの取得
Declaration
public static bool GetDspBusLinkInformation(ushort index, out CriAtomExAcf.DspBusLinkInfo info)
Parameters
Type | Name | Description |
---|---|---|
ushort | index | DSPバスリンクインデックス |
CriAtomExAcf.DspBusLinkInfo | info | DSPバスリンク情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: インデックスを指定してバスリンク情報を取得します。 指定したインデックス名のDSPバスリンクが存在しない場合、falseが返ります。
See Also
GetDspFxName(ushort)
DSP FX名の取得
Declaration
public static NativeString GetDspFxName(ushort index)
Parameters
Type | Name | Description |
---|---|---|
ushort | index | DSP FXインデックス |
Returns
Type | Description |
---|---|
NativeString | CriChar8* 文字列へのポインタ。失敗した場合は、CRI_NULLが返ります。 |
Remarks
説明: インデックスを指定してDSP FX名を文字列で取得します。 DSP FX名はASRを使用する環境かつ、ACF Ver.1.16.00 以降のACFを使用した時に取得可能です。 ASRを使用しない環境、またはACF Ver.1.15.01 以前ではCRI_NULLが 返ります。GetAcfInfo(out Info) 関数でACFのバージョンを確認してご使用下さい。
See Also
GetDspFxParameters(ushort, IntPtr, int)
DSP FXパラメーターの取得
Declaration
public static bool GetDspFxParameters(ushort index, IntPtr parameters, int size)
Parameters
Type | Name | Description |
---|---|---|
ushort | index | DSP FXインデックス |
IntPtr | parameters | DSP FXパラメーター |
int | size | DSP FXパラメーターワークサイズ |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: インデックスを指定してACFからFXパラメーターを取得します。 指定したインデックス名のDSP FXが存在しない場合、CRI FALSEが返ります。 size引数にはDSP FXタイプに応じたパラメーターのサイズを指定してください。 サウンドレンダラにASRを指定した場合は、ACFにある実行時パラメーターがfloat配列の形式でparametersに取得されます。 ASR以外でのサウンドレンダラでは、パラメーター構造体が得られます。
See Also
GetDspSettingInformation(ArgString, out DspSettingInfo)
DSPバス設定情報の取得
Declaration
public static bool GetDspSettingInformation(ArgString name, out CriAtomExAcf.DspSettingInfo info)
Parameters
Type | Name | Description |
---|---|---|
ArgString | name | セッティング名 |
CriAtomExAcf.DspSettingInfo | info | セッティング情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: セッティング名を指定してセッティング情報を取得します。 指定したセッティング名のDsp settingが存在しない場合、falseが返ります。
See Also
GetDspSettingNameByIndex(ushort)
DSPバス設定名の取得(index指定)
Declaration
public static NativeString GetDspSettingNameByIndex(ushort index)
Parameters
Type | Name | Description |
---|---|---|
ushort | index | DSPバス設定インデックス |
Returns
Type | Description |
---|---|
NativeString | CriChar8* DSPバス設定名 |
Remarks
説明: ライブラリに登録されたACFデータからDSPバス設定名を取得します。 ACFデータが登録されていないか、 または指定したDSPバス設定インデックスのDSPバス設定が存在しない場合、 本関数は null を返します。
See Also
GetDspSettingNameByIndexFromAcfData(IntPtr, int, ushort)
ACFデータからDSPバス設定名を取得
Declaration
public static NativeString GetDspSettingNameByIndexFromAcfData(IntPtr acfData, int acfDataSize, ushort index)
Parameters
Type | Name | Description |
---|---|---|
IntPtr | acfData | ACFデータ |
int | acfDataSize | ACFデータサイズ |
ushort | index | DSPバス設定インデックス |
Returns
Type | Description |
---|---|
NativeString | CriChar8* DSPバス設定名 |
Remarks
説明: 指定されたACFデータに含まれるDSPバス設定名を取得します。 第 3 引数( index )には、何番目のDSPバス設定の名称を取得するかを指定します。
備考: GetDspSettingNameByIndex(ushort) 関数と異なり、 ACF情報を登録する前でも本関数は実行可能です。
See Also
GetDspSettingSnapshotInformation(ushort, out DspSettingSnapshotInfo)
DSPバス設定スナップショット情報の取得
Declaration
public static bool GetDspSettingSnapshotInformation(ushort index, out CriAtomExAcf.DspSettingSnapshotInfo info)
Parameters
Type | Name | Description |
---|---|---|
ushort | index | スナップショットインデックス |
CriAtomExAcf.DspSettingSnapshotInfo | info | スナップショット情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: スナップショットインデックスを指定してスナップショット情報を取得します。 指定したセッティング名のスナップショットが存在しない場合、falseが返ります。 スナップショットインデックスは親となるDSPバス設定情報の CriAtomExAcf.DspSettingInfo 構造体内の snapshot_start_indexメンバとnum_snapshotsメンバを元に適切な値を算出してください。
See Also
GetGlobalAisacGraphInfo(in GlobalAisacInfo, ushort, out AisacGraphInfo)
Global Aisac Graph情報の取得
Declaration
public static bool GetGlobalAisacGraphInfo(in CriAtomEx.GlobalAisacInfo aisacInfo, ushort graphIndex, out CriAtomEx.AisacGraphInfo graphInfo)
Parameters
Type | Name | Description |
---|---|---|
CriAtomEx.GlobalAisacInfo | aisacInfo | Global Aisac情報 |
ushort | graphIndex | Aisac graphインデックス |
CriAtomEx.AisacGraphInfo | graphInfo | Aisac graph情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: Global Aisac情報とgraphインデックスからgraph情報を取得します。 指定したインデックスのGlobal Aisacが存在しない場合、falseが返ります。
GetGlobalAisacInfo(ushort, out GlobalAisacInfo)
Global Aisac情報の取得(インデックス指定)
Declaration
public static bool GetGlobalAisacInfo(ushort index, out CriAtomEx.GlobalAisacInfo info)
Parameters
Type | Name | Description |
---|---|---|
ushort | index | Global Aisacインデックス |
CriAtomEx.GlobalAisacInfo | info | Global Aisac情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: Global AisacインデックスからAisac情報を取得します。 指定したインデックスのGlobal Aisacが存在しない場合、falseが返ります。
GetGlobalAisacInfoByName(ArgString, out GlobalAisacInfo)
Global Aisac情報の取得(名前指定)
Declaration
public static bool GetGlobalAisacInfoByName(ArgString name, out CriAtomEx.GlobalAisacInfo info)
Parameters
Type | Name | Description |
---|---|---|
ArgString | name | Global Aisac名 |
CriAtomEx.GlobalAisacInfo | info | Global Aisac情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: Global Aisac名からAisac情報を取得します。 指定した名前のGlobal Aisacが存在しない場合、falseが返ります。
GetGlobalAisacValue(in GlobalAisacInfo, float, AisacGraphType, out float)
Global Aisac値の取得
Declaration
public static bool GetGlobalAisacValue(in CriAtomEx.GlobalAisacInfo aisacInfo, float control, CriAtomEx.AisacGraphType type, out float value)
Parameters
Type | Name | Description |
---|---|---|
CriAtomEx.GlobalAisacInfo | aisacInfo | Global Aisac情報 |
float | control | AISACコントロール値 |
CriAtomEx.AisacGraphType | type | グラフタイプ |
float | value | AISAC値 |
Returns
Type | Description |
---|---|
bool | 値が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: Global Aisac情報、コントロール値、グラフタイプを指定してAisac値を取得します。 指定したインデックスのGlobal Aisacが存在しない場合やグラフが存在しない場合は、falseが返ります。
GetMaxBusesOfDspBusSettings()
DSPバス設定内の最大バス数の取得
Declaration
public static int GetMaxBusesOfDspBusSettings()
Returns
Type | Description |
---|---|
int | DSPバス設定内の最大バス数 |
Remarks
説明: 登録されたACFに含まれるDSPバス設定内の最大バスの数を取得します。
GetMaxBusesOfDspBusSettingsFromAcfData(IntPtr, int)
ACFデータからDSPバス設定内の最大バス数を取得
Declaration
public static int GetMaxBusesOfDspBusSettingsFromAcfData(IntPtr acfData, int acfDataSize)
Parameters
Type | Name | Description |
---|---|---|
IntPtr | acfData | ACFデータ |
int | acfDataSize | ACFデータサイズ |
Returns
Type | Description |
---|---|
int | DSPバス設定内の最大バス数 |
Remarks
説明: 指定されたACFに含まれるDSPバス設定内の最大バスの数を取得します。
備考: GetMaxBusesOfDspBusSettings() 関数と異なり、 ACF情報を登録する前でも本関数は実行可能です。
See Also
GetNumAisacControls()
AISACコントロール数の取得
Declaration
public static int GetNumAisacControls()
Returns
Type | Description |
---|---|
int | AISACコントロール数 |
Remarks
説明: 登録されたACFに含まれるAISACコントロールの数を取得します。 ACFが登録されていない場合、-1が返ります。
GetNumBuses()
バス数の取得
Declaration
public static int GetNumBuses()
Returns
Type | Description |
---|---|
int | バス数 |
Remarks
説明: 登録されたACFに含まれるバスの数を取得します。
GetNumBusesFromAcfData(IntPtr, int)
ACFデータからバス数を取得
Declaration
public static int GetNumBusesFromAcfData(IntPtr acfData, int acfDataSize)
Parameters
Type | Name | Description |
---|---|---|
IntPtr | acfData | ACFデータ |
int | acfDataSize | ACFデータサイズ |
Returns
Type | Description |
---|---|
int | バス数 |
Remarks
説明: 指定されたACFに含まれるバスの数を取得します。
備考: GetNumBuses() 関数と異なり、 ACF情報を登録する前でも本関数は実行可能です。
See Also
GetNumCategories()
カテゴリ数の取得
Declaration
public static int GetNumCategories()
Returns
Type | Description |
---|---|
int | カテゴリ数 |
Remarks
説明: 登録されたACFに含まれるカテゴリの数を取得します。
GetNumCategoriesFromAcfData(IntPtr, int)
ACFデータからカテゴリ数を取得
Declaration
public static int GetNumCategoriesFromAcfData(IntPtr acfData, int acfDataSize)
Parameters
Type | Name | Description |
---|---|---|
IntPtr | acfData | ACFデータ |
int | acfDataSize | ACFデータサイズ |
Returns
Type | Description |
---|---|
int | カテゴリ数 |
Remarks
説明: 指定されたACFに含まれるカテゴリの数を取得します。
備考: GetNumCategories() 関数と異なり、 ACF情報を登録する前でも本関数は実行可能です。
See Also
GetNumCategoriesPerPlayback()
再生毎カテゴリ参照数の取得
Declaration
public static int GetNumCategoriesPerPlayback()
Returns
Type | Description |
---|---|
int | 再生毎カテゴリ参照数 |
Remarks
説明: 登録されたACFに含まれる再生毎カテゴリ参照数を取得します。
GetNumCategoriesPerPlaybackFromAcfData(IntPtr, int)
ACFデータから再生毎カテゴリ参照数を取得
Declaration
public static int GetNumCategoriesPerPlaybackFromAcfData(IntPtr acfData, int acfDataSize)
Parameters
Type | Name | Description |
---|---|---|
IntPtr | acfData | ACFデータ |
int | acfDataSize | ACFデータサイズ |
Returns
Type | Description |
---|---|
int | 再生毎カテゴリ参照数 |
Remarks
説明: 指定されたACFに含まれるカテゴリの数を取得します。
備考: GetNumCategoriesPerPlayback() 関数と異なり、 ACF情報を登録する前でも本関数は実行可能です。
See Also
GetNumDspSettings()
DSPバス設定数の取得
Declaration
public static int GetNumDspSettings()
Returns
Type | Description |
---|---|
int | DSPバス設定数 |
Remarks
説明: ライブラリに登録されたACFデータに含まれるDSPバス設定の数を取得します。 ACFデータが登録されていない場合、本関数は -1 を返します。
See Also
GetNumDspSettingsFromAcfData(IntPtr, int)
ACFデータからDSPバス設定数を取得
Declaration
public static int GetNumDspSettingsFromAcfData(IntPtr acfData, int acfDataSize)
Parameters
Type | Name | Description |
---|---|---|
IntPtr | acfData | ACFデータ |
int | acfDataSize | ACFデータサイズ |
Returns
Type | Description |
---|---|
int | DSPバス設定数 |
Remarks
説明: 指定されたACFに含まれるDSPバス設定の数を取得します。
備考: GetNumDspSettings() 関数と異なり、 ACF情報を登録する前でも本関数は実行可能です。
See Also
GetNumGlobalAisacs()
Global Aisac数の取得
Declaration
public static int GetNumGlobalAisacs()
Returns
Type | Description |
---|---|
int | Global Aisac数 |
Remarks
説明: 登録されたACFに含まれるGlobal Aisacの数を取得します。
GetNumSelectors()
セレクター数の取得
Declaration
public static int GetNumSelectors()
Returns
Type | Description |
---|---|
int | セレクター数 |
Remarks
説明: 登録されたACFに含まれるセレクターの数を取得します。
GetOutputPortHnByName(ArgString)
ACFの出力ポートオブジェクトの取得(名前指定)
Declaration
public static CriAtomExOutputPort GetOutputPortHnByName(ArgString name)
Parameters
Type | Name | Description |
---|---|---|
ArgString | name | 出力ポート名 |
Returns
Type | Description |
---|---|
CriAtomExOutputPort |
Remarks
説明: ACFに保持されている出力ポートの中から、指定した出力ポート名のオブジェクトを取得します。 ACFの出力ポートオブジェクトはACFの登録時に生成、保持されます。 ACFに登録された出力ポート名は、ACFのヘッダーに記載されています。 生成後の出力ポートオブジェクトにはデフォルトASRラックが設定されているため、この関数で取得したオブジェクトに対して SetAsrRackId(CriAtomExAsrRack) 関数で適切なASRラックを指定する必要があります。
See Also
GetSelectorInfoByIndex(ushort, out SelectorInfo)
セレクター情報の取得(インデックス指定)
Declaration
public static bool GetSelectorInfoByIndex(ushort index, out CriAtomEx.SelectorInfo info)
Parameters
Type | Name | Description |
---|---|---|
ushort | index | セレクターインデックス |
CriAtomEx.SelectorInfo | info | セレクター情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: セレクターインデックスからセレクター情報を取得します。 指定したインデックスのセレクターが存在しない場合、falseが返ります。
GetSelectorInfoByName(ArgString, out SelectorInfo)
セレクター情報の取得(名前指定)
Declaration
public static bool GetSelectorInfoByName(ArgString name, out CriAtomEx.SelectorInfo info)
Parameters
Type | Name | Description |
---|---|---|
ArgString | name | セレクター名 |
CriAtomEx.SelectorInfo | info | セレクター情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: セレクター名からセレクター情報を取得します。 指定した名前のセレクターが存在しない場合、falseが返ります。
GetSelectorLabelInfo(in SelectorInfo, ushort, out SelectorLabelInfo)
セレクターラベル情報の取得
Declaration
public static bool GetSelectorLabelInfo(in CriAtomEx.SelectorInfo selectorInfo, ushort labelIndex, out CriAtomEx.SelectorLabelInfo labelInfo)
Parameters
Type | Name | Description |
---|---|---|
CriAtomEx.SelectorInfo | selectorInfo | セレクター情報 |
ushort | labelIndex | ラベルインデックス |
CriAtomEx.SelectorLabelInfo | labelInfo | セレクターラベル情報 |
Returns
Type | Description |
---|---|
bool | 情報が取得できたかどうか?(取得できた:true/取得できない:false) |
Remarks
説明: セレクター情報とセレクターラベルインデックスからセレクターラベル情報を取得します。 指定したインデックスのセレクターラベルが存在しない場合、falseが返ります。
SetGlobalLabelToSelectorByIndex(ushort, ushort)
セレクターに対するグローバル参照ラベルの設定
Declaration
public static void SetGlobalLabelToSelectorByIndex(ushort selsectorIndex, ushort labelIndex)
Parameters
Type | Name | Description |
---|---|---|
ushort | selsectorIndex | セレクターインデックス |
ushort | labelIndex | ラベルインデックス |
Remarks
説明: ACFファイル内に登録されているセレクターに対してグローバル参照されるラベルを設定します。
注意: 本関数を実行する前に、ACFファイルを登録しておく必要があります。
See Also
SetGlobalLabelToSelectorByName(ArgString, ArgString)
セレクターに対するグローバル参照ラベルの設定
Declaration
public static void SetGlobalLabelToSelectorByName(ArgString selsectorName, ArgString labelName)
Parameters
Type | Name | Description |
---|---|---|
ArgString | selsectorName | セレクター名 |
ArgString | labelName | ラベル名 |
Remarks
説明: ACFファイル内に登録されているセレクターに対してグローバル参照されるラベルを設定します。
注意: 本関数を実行する前に、ACFファイルを登録しておく必要があります。