AtomExサウンドオブジェクト [詳解]

CriDisposableを継承しています。

公開メンバ関数
	CriAtomExSoundObject (bool enableVoiceLimitScope, bool enableCategoryCueLimitScope)
	サウンドオブジェクトの作成 [詳解]

override void	Dispose ()
	サウンドオブジェクトの破棄 [詳解]

void	AddPlayer (CriAtomExPlayer player)
	AtomExプレーヤの追加 [詳解]

void	DeletePlayer (CriAtomExPlayer player)
	AtomExプレーヤの削除 [詳解]

void	DeleteAllPlayers ()
	すべてのAtomExプレーヤの削除 [詳解]

詳解

AtomExサウンドオブジェクト

説明:: サウンドオブジェクトクラスです。
アプリケーション内の「物体」や「空間」、「状況」等に関連付けて、登録されたプレーヤに対して一括での音声コントロールを行うことができます。

構築子と解体子

CriAtomExSoundObject	(	bool	enableVoiceLimitScope,
		bool	enableCategoryCueLimitScope
	)

inline

サウンドオブジェクトの作成

引数

enableVoiceLimitScope	ボイスリミットスコープを有効化するか
enableCategoryCueLimitScope	カテゴリキューリミットスコープを有効化するか

戻り値: サウンドオブジェクト

説明:: サウンドオブジェクトを作成します。
enableVoiceLimitScope に True を指定すると、このサウンドオブジェクトに関連付けられたExプレーヤから再生した音声の発音数について、このサウンドオブジェクト内でのみカウントし、ボイスリミットグループによる発音数制御を行います。
enableCategoryCueLimit に True を指定すると、このサウンドオブジェクトに関連付けられたExプレーヤから再生したキューのカテゴリ再生数について、このサウンドオブジェクト内でのみカウントし、再生数制御を行います。

参照: CriAtomExSoundObject::Dispose

関数詳解

override void Dispose ( )

inline

サウンドオブジェクトの破棄

説明:: サウンドオブジェクトを破棄します。
本関数を実行した時点で、サウンドオブジェクト作成時にDLL内で確保されたリソースが全て解放されます。

参照: CriAtomExSoundObject::CriAtomExSoundObject

void AddPlayer ( CriAtomExPlayer player )

inline

AtomExプレーヤの追加

引数

player AtomExプレーヤ

説明:

サウンドオブジェクトにAtomExプレーヤを追加します。
追加したAtomExプレーヤはサウンドオブジェクトと関連付けられ、サウンドオブジェクトによる以下の影響を受けるようになります。

発音数制限やイベント機能が影響する範囲（スコープ）の限定
再生コントロール（停止、ポーズ等）
パラメータコントロール
追加したAtomExプレーヤをサウンドオブジェクトから削除する場合は、 CriAtomExSoundObject::DeletePlayer 関数を呼び出してください。

注意:: 本関数の呼び出しは、追加しようとしているAtomExプレーヤで音声を再生していない状態で行ってください。
再生中のAtomExプレーヤが指定された場合、追加時に再生停止が行われます。

参照: CriAtomExSoundObject::DeletePlayer, CriAtomExSoundObject::DeleteAllPlayers, CriAtomExPlayer::nativeHandle

void DeletePlayer ( CriAtomExPlayer player )

inline

AtomExプレーヤの削除

引数

player AtomExプレーヤのネイティブハンドル

説明:: サウンドオブジェクトからAtomExプレーヤを削除します。
削除したAtomExプレーヤはサウンドオブジェクトとの関連付けが切られ、サウンドオブジェクトによる影響を受けなくなります。

注意:: 本関数の呼び出しは、削除しようとしているAtomExプレーヤで音声を再生していない状態で行ってください。
再生中のAtomExプレーヤが指定された場合、削除時に再生停止が行われます。

参照: CriAtomExSoundObject::AddPlayer, CriAtomExSoundObject::DeleteAllPlayers, CriAtomExPlayer::nativeHandle

void DeleteAllPlayers ( )

inline

すべてのAtomExプレーヤの削除

説明:: サウンドオブジェクトに関連付けられているすべてのAtomExプレーヤを削除します。
削除したAtomExプレーヤはサウンドオブジェクトとの関連付けが切られ、サウンドオブジェクトによる影響を受けなくなります。

注意:: 本関数の呼び出しは、削除しようとしているAtomExプレーヤで音声を再生していない状態で行ってください。
再生中のAtomExプレーヤが指定された場合、削除時に再生停止が行われます。

参照: CriAtomExSoundObject::AddPlayer, CriAtomExSoundObject::DeletePlayer

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

CriAtomExSoundObject.cs

公開メンバ関数

詳解

構築子と解体子

関数詳解