Struct CriAtomExCategory

カテゴリID

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: CriWare

Assembly: CriWare.CriAtom.dll

Syntax

public struct CriAtomExCategory

Remarks

説明: カテゴリIDは、ユーザがオーサリングツール上でカテゴリに対して割り当てた一意のIDです。 カテゴリIDをプログラム中で保持する際には、本変数型を用いて値を取り扱う必要があります。

Fields

MaxCategoriesPerPlayback

最大再生毎カテゴリ参照数

Declaration

public const int MaxCategoriesPerPlayback = 16

Field Value

Type	Description
int

See Also

CriAtomEx.CueInfo

Properties

NativeHandle

ネイティブハンドル

Declaration

public readonly uint NativeHandle { get; }

Property Value

Type	Description
uint

Methods

AttachAisacById(ArgString)

ID指定でカテゴリにAISACを取り付ける

Declaration

public void AttachAisacById(ArgString globalAisacName)

Parameters

Type	Name	Description
ArgString	globalAisacName	取り付けるグローバルAISAC名

Remarks

説明: カテゴリにAISACをアタッチ（取り付け）します。 AISACをアタッチすることにより、キューやトラックにAISACを設定していなくても、AISACの効果を得ることができます。 AISACのアタッチに失敗した場合、関数内でエラーコールバックが発生します。 AISACのアタッチに失敗した理由については、エラーコールバックのメッセージを確認してください。

備考: 全体設定（ACFファイル）に含まれるグローバルAISACのみ、アタッチ可能です。 AISACの効果を得るには、キューやトラックに設定されているAISACと同様に、該当するAISACコントロール値を設定する必要があります。

注意: キューやトラックに「AISACコントロール値を変更するAISAC」が設定されていたとしても、 その適用結果のAISACコントロール値は、カテゴリにアタッチしたAISACには影響しません。 カテゴリにアタッチしたAISACについては、常にカテゴリに設定したAISACコントロール値のみ、参照されます。 現在、「オートモジュレーション」や「ランダム」といったコントロールタイプのAISACのアタッチには対応しておりません。 現在、カテゴリにアタッチできるAISACの最大数は、8個固定です。

See Also

DetachAisacById(ArgString)

AttachAisacByName(ArgString, ArgString)

名前指定でカテゴリにAISACを取り付ける

Declaration

public static void AttachAisacByName(ArgString name, ArgString globalAisacName)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名
ArgString	globalAisacName	取り付けるグローバルAISAC名

Remarks

説明: カテゴリにAISACをアタッチ（取り付け）します。 カテゴリを名前で指定する以外は、AttachAisacById(ArgString) 関数と仕様は同じです。

See Also

AttachAisacById(ArgString)

DetachAisacByName(ArgString, ArgString)

DetachAisacAllById()

ID指定でカテゴリから全てのAISACを取り外す

Declaration

public void DetachAisacAllById()

Remarks

説明: カテゴリから全てのAISACをデタッチ（取り外し）します。

DetachAisacAllByName(ArgString)

名前指定でカテゴリから全てのAISACを取り外す

Declaration

public static void DetachAisacAllByName(ArgString name)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名

Remarks

説明: カテゴリから全てのAISACをデタッチ（取り外し）します。

DetachAisacById(ArgString)

ID指定でカテゴリからAISACを取り外す

Declaration

public void DetachAisacById(ArgString globalAisacName)

Parameters

Type	Name	Description
ArgString	globalAisacName	取り外すグローバルAISAC名

Remarks

説明: カテゴリからAISACをデタッチ（取り外し）します。 AISACのデタッチに失敗した場合、関数内でエラーコールバックが発生します。 AISACのデタッチに失敗した理由については、エラーコールバックのメッセージを確認してください。

See Also

AttachAisacById(ArgString)

DetachAisacByName(ArgString, ArgString)

名前指定でカテゴリからAISACを取り外す

Declaration

public static void DetachAisacByName(ArgString name, ArgString globalAisacName)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名
ArgString	globalAisacName	取り外すグローバルAISAC名

Remarks

説明: カテゴリからAISACをデタッチ（取り外し）します。 カテゴリを名前で指定する以外は、DetachAisacById(ArgString) 関数と仕様は同じです。

See Also

DetachAisacById(ArgString)

AttachAisacByName(ArgString, ArgString)

GetAttachedAisacInfoById(int, out AisacInfo)

ID指定でカテゴリにアタッチされているAISACの情報を取得する

Declaration

public bool GetAttachedAisacInfoById(int aisacAttachedIndex, out CriAtomEx.AisacInfo aisacInfo)

Parameters

Type	Name	Description
int	aisacAttachedIndex	アタッチされているAISACのインデックス
CriAtomEx.AisacInfo	aisacInfo	AISAC情報

Returns

Type	Description
bool	= 情報が取得できた

Remarks

説明: カテゴリにアタッチされているAISACの情報を取得します。 存在しないカテゴリを指定した場合や、無効なインデックスを指定した場合、falseが返ります。

See Also

GetNumAttachedAisacsById()

GetAttachedAisacInfoByName(ArgString, int, out AisacInfo)

名前指定でカテゴリにアタッチされているAISACの情報を取得する

Declaration

public static bool GetAttachedAisacInfoByName(ArgString name, int aisacAttachedIndex, out CriAtomEx.AisacInfo aisacInfo)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名
int	aisacAttachedIndex	アタッチされているAISACのインデックス
CriAtomEx.AisacInfo	aisacInfo	AISAC情報

Returns

Type	Description
bool	= 情報が取得できた

Remarks

説明: カテゴリにアタッチされているAISACの情報を取得します。 存在しないカテゴリを指定した場合や、無効なインデックスを指定した場合、falseが返ります。

See Also

GetNumAttachedAisacsByName(ArgString)

GetCurrentAisacControlValueById(uint, out float)

ID指定でカテゴリにアタッチされているAISACコントロールの現在値を取得する

Declaration

public bool GetCurrentAisacControlValueById(uint aisacControlId, out float controlValue)

Parameters

Type	Name	Description
uint	aisacControlId	AISACコントロールID
float	controlValue	AISACコントロールの現在値

Returns

Type	Description
bool	= 情報が取得できた

Remarks

説明: カテゴリにアタッチされているAISACコントロールの現在値を取得します。 存在しないカテゴリやAISACコントロールを指定した場合、falseが返ります。

See Also

GetNumAttachedAisacsById()

GetCurrentAisacControlValueByName(ArgString, ArgString, out float)

名前指定でカテゴリにアタッチされているAISACコントロールの現在値を取得する

Declaration

public static bool GetCurrentAisacControlValueByName(ArgString categoryName, ArgString aisacControlName, out float controlValue)

Parameters

Type	Name	Description
ArgString	categoryName	カテゴリ名
ArgString	aisacControlName	AISACコントロール名
float	controlValue	AISACコントロールの現在値

Returns

Type	Description
bool	= 情報が取得できた

Remarks

説明: カテゴリにアタッチされているAISACコントロールの現在値を取得します。 存在しないカテゴリを指定した場合や、無効なインデックスを指定した場合、falseが返ります。

See Also

GetNumAttachedAisacsById()

GetNumAttachedAisacsById()

ID指定でカテゴリにアタッチされているAISAC数を取得する

Declaration

public int GetNumAttachedAisacsById()

Returns

Type	Description
int

Remarks

説明: カテゴリにアタッチされているAISAC数を取得します。 存在しないカテゴリを指定した場合、負値が返ります。

GetNumAttachedAisacsByName(ArgString)

名前指定でカテゴリにアタッチされているAISAC数を取得する

Declaration

public static int GetNumAttachedAisacsByName(ArgString name)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名

Returns

Type	Description
int

Remarks

説明: カテゴリにアタッチされているAISAC数を取得します。 存在しないカテゴリを指定した場合、負値が返ります。

GetNumCuePlayingCountById()

ID指定でカテゴリに所属する発音中のキュー数を取得する

Declaration

public int GetNumCuePlayingCountById()

Returns

Type	Description
int

Remarks

説明: カテゴリに所属する発音中のキュー数を取得します。 存在しないカテゴリを指定した場合、負値が返ります。

GetNumCuePlayingCountByName(ArgString)

名前指定でカテゴリに所属する発音中のキュー数を取得する

Declaration

public static int GetNumCuePlayingCountByName(ArgString name)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名

Returns

Type	Description
int

Remarks

説明: カテゴリに所属する発音中のキュー数を取得します。 存在しないカテゴリを指定した場合、負値が返ります。

GetReactParameter(ArgString, out ReactParameter)

REACT駆動パラメーターの取得

Declaration

public static bool GetReactParameter(ArgString reactName, out CriAtomEx.ReactParameter reactParameter)

Parameters

Type	Name	Description
ArgString	reactName	REACT名
CriAtomEx.ReactParameter	reactParameter	REACT駆動パラメーター構造体

Returns

Type	Description
bool	= 情報が取得できた

Remarks

説明: REACTを駆動させるパラメーターの現在値を取得します。 存在しないREACT名を指定した場合は、エラーコールバックが発生しfalseが返ります。

See Also

SetReactParameter(ArgString, in ReactParameter)

GetReactStatus(ArgString)

REACT動作ステータスの取得

Declaration

public static CriAtomEx.ReactStatus GetReactStatus(ArgString reactName)

Parameters

Type	Name	Description
ArgString	reactName	REACT名

Returns

Type	Description
CriAtomEx.ReactStatus	REACT動作ステータス

Remarks

説明: REACTの動作ステータスを取得します。 存在しないREACT名を指定した場合は、エラーコールバックが発生し Error が返ります。

GetTotalVolumeById()

ID指定による最終カテゴリボリューム取得

Declaration

public float GetTotalVolumeById()

Returns

Type	Description
float

Remarks

説明: ID指定でREACT、AISACなどの影響を受けた最終的なカテゴリのボリューム値を取得します。

備考: 最終的なカテゴリのボリューム値を取得するためにパラメーターの計算処理を行うので、 負荷が大きい関数です。

GetTotalVolumeByName(ArgString)

名前指定による最終カテゴリボリューム取得

Declaration

public static float GetTotalVolumeByName(ArgString name)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名 return CriFloat32 カテゴリボリューム

Returns

Type	Description
float

Remarks

説明: 名前指定でREACT、AISACなどの影響を受けた最終的なカテゴリのボリューム値を取得します。

備考: 最終的なカテゴリのボリューム値を取得するためにパラメーターの計算処理を行うので、 負荷が大きい関数です。

GetVolumeById()

ID指定によるカテゴリボリューム取得

Declaration

public float GetVolumeById()

Returns

Type	Description
float

Remarks

説明: ID指定でカテゴリのボリュームを取得します。

GetVolumeByName(ArgString)

名前指定によるカテゴリボリューム取得

Declaration

public static float GetVolumeByName(ArgString name)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名 return CriFloat32 カテゴリボリューム

Returns

Type	Description
float

Remarks

説明: 名前指定でカテゴリのボリュームを取得します。

IsMutedById()

ID指定によるカテゴリミュート状態取得

Declaration

public bool IsMutedById()

Returns

Type	Description
bool

Remarks

説明: ID指定でカテゴリのミュート状態を取得します。

IsMutedByName(ArgString)

名前指定によるカテゴリミュート状態取得

Declaration

public static bool IsMutedByName(ArgString name)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名 return CriBool ミュート状態（true = ミュート中、false = ミュートされていない）

Returns

Type	Description
bool

Remarks

説明: 名前指定でカテゴリのミュート状態を取得します。

IsPausedById()

ID指定によるカテゴリのポーズ状態取得

Declaration

public bool IsPausedById()

Returns

Type	Description
bool

Remarks

説明: ID指定でカテゴリのポーズ状態を取得します。

IsPausedByName(ArgString)

名前指定によるカテゴリのポーズ状態取得

Declaration

public static bool IsPausedByName(ArgString name)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名 return CriBool ポーズ状態

Returns

Type	Description
bool

Remarks

説明: 名前指定でカテゴリのポーズ状態を取得します。

IsSoloedById()

ID指定によるカテゴリソロ状態取得

Declaration

public bool IsSoloedById()

Returns

Type	Description
bool

Remarks

説明: ID指定でカテゴリのソロ状態を取得します。

IsSoloedByName(ArgString)

名前指定によるカテゴリソロ状態取得

Declaration

public static bool IsSoloedByName(ArgString name)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名 return CriBool ソロ状態（true = ソロ中、false = ソロではない）

Returns

Type	Description
bool

Remarks

説明: 名前指定でカテゴリのソロ状態を取得します。

MuteById(NativeBool)

ID指定によるカテゴリミュート状態設定

Declaration

public void MuteById(NativeBool mute)

Parameters

Type	Name	Description
NativeBool	mute	ミュート状態（true = ミュート、false = ミュート解除）

Remarks

説明: ID指定でカテゴリのミュート状態を設定します。

MuteByName(ArgString, NativeBool)

名前指定によるカテゴリミュート状態設定

Declaration

public static void MuteByName(ArgString name, NativeBool mute)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名
NativeBool	mute	ミュート状態（true = ミュート、false = ミュート解除）

Remarks

説明: 名前指定でカテゴリのミュート状態を設定します。

PauseById(NativeBool)

ID指定によるカテゴリのポーズ／ポーズ解除

Declaration

public void PauseById(NativeBool sw)

Parameters

Type	Name	Description
NativeBool	sw	スイッチ（false = ポーズ解除、true = ポーズ）

Remarks

説明: ID指定でカテゴリのポーズ／ポーズ解除を行います。 SetFadeOutTimeById(ushort) 関数やSetFadeOutTimeByName(ArgString, ushort) 関数でフェードアウト時間が設定されている場合にポーズを行うと、設定された時間でフェードアウトした後に実際にポーズします。 SetFadeInTimeById(ushort) 関数やSetFadeInTimeByName(ArgString, ushort) 関数でフェードイン時間が設定されている場合にポーズ解除を行うと、ポーズ解除後、設定された時間でフェードインします。

備考: カテゴリのポーズは、AtomExプレーヤー／再生音のポーズ （Pause(NativeBool) 関数やPause(NativeBool) 関数でのポーズ）とは独立して扱われ、 音声の最終的なポーズ状態は、それぞれのポーズ状態を考慮して決まります。 すなわち、どちらかがポーズ状態ならポーズ、どちらもポーズ解除状態ならポーズ解除、となります。

PauseByName(ArgString, NativeBool)

名前指定によるカテゴリのポーズ／ポーズ解除

Declaration

public static void PauseByName(ArgString name, NativeBool sw)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名
NativeBool	sw	スイッチ（false = ポーズ解除、true = ポーズ）

Remarks

説明: 名前指定でカテゴリのポーズ／ポーズ解除を行います。 カテゴリを名前で指定する以外は、PauseById(NativeBool) 関数と仕様は同じです。

See Also

PauseById(NativeBool)

ResetAllAisacControlById()

ID指定でカテゴリにアタッチされている全てのAISACコントロール値をデフォルト値に設定する

Declaration

public bool ResetAllAisacControlById()

Returns

Type	Description
bool	= 成功

Remarks

説明: カテゴリにアタッチされている全てのAISACコントロール値をデフォルト値に設定します。 存在しないカテゴリを指定した場合、falseが返ります。

See Also

GetNumAttachedAisacsById()

ResetAllAisacControlByName(ArgString)

名前指定でカテゴリにアタッチされている全てのAISACコントロール値をデフォルト値に設定する

Declaration

public static bool ResetAllAisacControlByName(ArgString categoryName)

Parameters

Type	Name	Description
ArgString	categoryName	カテゴリ名

Returns

Type	Description
bool	= 成功

Remarks

説明: カテゴリにアタッチされている全てのAISACコントロール値をデフォルト値に設定します。 存在しないカテゴリを指定した場合、falseが返ります。

See Also

GetNumAttachedAisacsById()

SetAisacControlById(uint, float)

ID指定によるカテゴリに対するAISACコントロール値設定

Declaration

public void SetAisacControlById(uint controlId, float controlValue)

Parameters

Type	Name	Description
uint	controlId	AISACコントロールID
float	controlValue	AISACコントロール値

Remarks

説明: ID指定でカテゴリに対してAISACコントロール値を設定します。

備考: カテゴリをIDで、AISACコントロールを名前で指定したい場合、GetAisacControlIdByName(ArgString) 関数にて変換を行ってください。

注意: キューやトラックに設定されているAISACに関しては、プレーヤーでのAISACコントロール値設定よりも、カテゴリのAISACコントロール値を優先して参照します。 カテゴリにアタッチしたAISACについては、常にカテゴリに設定したAISACコントロール値のみ、参照されます。

See Also

SetAisacControlByName(ArgString, ArgString, float)

AttachAisacById(ArgString)

AttachAisacByName(ArgString, ArgString)

SetAisacControlByName(ArgString, ArgString, float)

名前指定によるカテゴリに対するAISACコントロール値設定

Declaration

public static void SetAisacControlByName(ArgString name, ArgString controlName, float controlValue)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名
ArgString	controlName	AISACコントロール名
float	controlValue	AISACコントロール値

Remarks

説明: 名前指定でカテゴリに対してAISACコントロール値を設定します。 カテゴリおよびAISACコントロールを名前で指定する以外は、SetAisacControlById(uint, float) 関数と仕様は同じです。

備考: カテゴリを名前、AISACコントロールをIDで指定したい場合、GetAisacControlNameById(uint) 関数にて変換を行ってください。

See Also

SetAisacControlById(uint, float)

AttachAisacById(ArgString)

AttachAisacByName(ArgString, ArgString)

SetFadeInTimeById(ushort)

フェードイン時間の設定（カテゴリID指定）

Declaration

public void SetFadeInTimeById(ushort ms)

Parameters

Type	Name	Description
ushort	ms	フェードイン時間（ミリ秒単位）

Remarks

説明: カテゴリにフェードイン時間を設定します。 フェードイン時間はポーズ解除を行った際に利用されます。

SetFadeInTimeByName(ArgString, ushort)

フェードイン時間の設定（カテゴリ名指定）

Declaration

public static void SetFadeInTimeByName(ArgString name, ushort ms)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名
ushort	ms	フェードイン時間（ミリ秒単位）

Remarks

説明: カテゴリにフェードイン時間を設定します。 フェードイン時間はポーズ解除を行った際に利用されます。

SetFadeOutTimeById(ushort)

フェードアウト時間の設定（カテゴリID指定）

Declaration

public void SetFadeOutTimeById(ushort ms)

Parameters

Type	Name	Description
ushort	ms	フェードアウト時間（ミリ秒単位）

Remarks

説明: カテゴリにフェードアウト時間を設定します。 フェードアウト時間はポーズを行った際に利用されます。

SetFadeOutTimeByName(ArgString, ushort)

フェードアウト時間の設定（カテゴリ名指定）

Declaration

public static void SetFadeOutTimeByName(ArgString name, ushort ms)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名
ushort	ms	フェードアウト時間（ミリ秒単位）

Remarks

説明: カテゴリにフェードアウト時間を設定します。 フェードアウト時間はポーズを行った際に利用されます。

SetReactParameter(ArgString, in ReactParameter)

REACT駆動パラメーターの設定

Declaration

public static void SetReactParameter(ArgString reactName, in CriAtomEx.ReactParameter reactParameter)

Parameters

Type	Name	Description
ArgString	reactName	REACT名
CriAtomEx.ReactParameter	reactParameter	REACT駆動パラメーター構造体

Remarks

説明: REACTを駆動させるパラメーターを設定します。 REACTが動作している間はパラメーターを設定することはできません（警告が発生します）。 存在しないREACT名を指定した場合は、エラーコールバックが返ります。

See Also

GetReactParameter(ArgString, out ReactParameter)

SetVolumeById(float)

ID指定によるカテゴリに対するボリューム設定

Declaration

public void SetVolumeById(float volume)

Parameters

Type	Name	Description
float	volume	ボリューム値

Remarks

説明: ID指定でカテゴリに対してボリュームを設定します。

注意: 本関数による設定値はACFによって設定されているカテゴリボリュームを上書き変更します。 本関数による設定値とACF設定値との乗算適用は行われないことに注意してください。

SetVolumeByName(ArgString, float)

名前指定によるカテゴリに対するボリューム設定

Declaration

public static void SetVolumeByName(ArgString name, float volume)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名
float	volume	ボリューム値

Remarks

説明: 名前指定でカテゴリに対してボリュームを設定します。

注意: 本関数による設定値はACFによって設定されているカテゴリボリュームを上書き変更します。 本関数による設定値とACF設定値との乗算適用は行われないことに注意してください。

SoloById(NativeBool, float)

ID指定によるカテゴリソロ状態設定

Declaration

public void SoloById(NativeBool solo, float muteVolume)

Parameters

Type	Name	Description
NativeBool	solo	ソロ状態（true = ソロ、false = ソロ解除）
float	muteVolume	他のカテゴリに適用するミュートボリューム値

Remarks

説明: ID指定でカテゴリのソロ状態を設定します。 mute_volumeで指定したボリュームは同一カテゴリグループに所属する カテゴリに対して適用されます。

SoloByName(ArgString, NativeBool, float)

名前指定によるカテゴリソロ状態設定

Declaration

public static void SoloByName(ArgString name, NativeBool solo, float muteVolume)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名
NativeBool	solo	ソロ状態（true = ソロ、false = ソロ解除）
float	muteVolume	他のカテゴリに適用するミュートボリューム値

Remarks

説明: 名前指定でカテゴリのソロ状態を設定します。 mute_volumeで指定したボリュームは同一カテゴリグループに所属する カテゴリに対して適用されます。

StopById()

ID指定でカテゴリに所属する発音中のキューを停止する

Declaration

public void StopById()

Remarks

説明: 指定したカテゴリに所属する発音中のキューを停止します。

StopByName(ArgString)

名前指定でカテゴリに所属する発音中のキューを停止する

Declaration

public static void StopByName(ArgString name)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名

Remarks

説明: 指定したカテゴリに所属する発音中のキューを停止します。

StopWithoutReleaseTimeById()

ID指定でカテゴリに所属する発音中のキューを即時停止する

Declaration

public void StopWithoutReleaseTimeById()

Remarks

説明: 指定したカテゴリに所属する発音中のキューを即時停止します。

StopWithoutReleaseTimeByName(ArgString)

名前指定でカテゴリに所属する発音中のキューを即時停止する

Declaration

public static void StopWithoutReleaseTimeByName(ArgString name)

Parameters

Type	Name	Description
ArgString	name	カテゴリ名

Remarks

説明: 指定したカテゴリに所属する発音中のキューを即時停止します。

See Also

SetVolumeById(float)

MuteById(NativeBool)

SoloById(NativeBool, float)