Class CriAtomExSoundObject
サウンドオブジェクトオブジェクト
Implements
Inherited Members
Namespace: CriWare
Assembly: CriWare.CriAtom.dll
Syntax
public class CriAtomExSoundObject : IDisposableRemarks
説明: CriAtomExSoundObject は、サウンドオブジェクトを操作するためのオブジェクトです。 CriAtomExSoundObject(in Config, IntPtr, int) 関数でサウンドオブジェクトを作成すると、 関数はサウンドオブジェクト操作用に、この"サウンドオブジェクトオブジェクト"を返します。 サウンドオブジェクトに対して行う操作は、全てサウンドオブジェクトオブジェクトを介して実行されます。
備考: サウンドオブジェクトとは、複数の音が鳴る「物体」や「空間」、「状況」等を抽象 化した概念です。 サウンドオブジェクトをアプリケーション内の「物体」や「空間」、「状況」等に関連付けることにより、 より自然に音声のコントロールを行うことができます。 例えば、あるキャラクタが存在するとき、そのキャラクタ用のサウンドオブジェクトを作成することで、 キャラクタ毎に発音数制限を行ったり、キャラクタ消滅とともにまとめて再生停止を行う、 というようなことが簡単にできるようになります。 サウンドオブジェクト自身は、発音のための機能を持ちません。 発音や個別のコントロールは、サウンドオブジェクトに関連付けられたAtomExプレーヤーで行います。
Constructors
CriAtomExSoundObject(in Config, IntPtr, int)
サウンドオブジェクトの作成
Declaration
public CriAtomExSoundObject(in CriAtomExSoundObject.Config config, IntPtr work = default, int workSize = 0)Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomExSoundObject.Config | config | サウンドオブジェクト作成用コンフィグ構造体 |
| IntPtr | work | ワーク領域 |
| int | workSize | ワーク領域サイズ |
Remarks
説明: サウンドオブジェクトを作成します。
See Also
CriAtomExSoundObject(IntPtr, int)
デフォルト設定でのインスタンス作成
Declaration
public CriAtomExSoundObject(IntPtr work = default, int workSize = 0)Parameters
| Type | Name | Description |
|---|---|---|
| IntPtr | work | |
| int | workSize |
Properties
NativeHandle
ネイティブハンドル
Declaration
public NativeHandleIntPtr NativeHandle { get; }Property Value
| Type | Description |
|---|---|
| NativeHandleIntPtr |
Methods
AddPlayer(CriAtomExPlayer)
AtomExプレーヤーの追加
Declaration
public void AddPlayer(CriAtomExPlayer player)Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomExPlayer | player | AtomExプレーヤー |
Remarks
説明: サウンドオブジェクトにAtomExプレーヤーを追加します。 追加したAtomExプレーヤーはサウンドオブジェクトと関連付けられ、 サウンドオブジェクトによる以下の影響を受けるようになります。 - 発音数制限やイベント機能が影響する範囲（スコープ）の限定 - 再生コントロール（停止、ポーズ等） - パラメーターコントロール 追加したAtomExプレーヤーをサウンドオブジェクトから削除する場合は、 DeletePlayer(CriAtomExPlayer) 関数を呼び出してください。 対象のAtomExプレーヤーが既にサウンドオブジェクトに追加済みの場合は、何も起こりません。
注意: 本関数の呼び出しは、追加しようとしているAtomExプレーヤーで音声を再生していない状態で行ってください。 ステータスが Stop ではないAtomExプレーヤーが指定された場合、 追加時に StopWithoutReleaseTime() 関数にて再生停止が行われます。
See Also
CalculateWorkSize(in Config)
サウンドオブジェクト用ワーク領域サイズの計算
Declaration
public static int CalculateWorkSize(in CriAtomExSoundObject.Config config)Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomExSoundObject.Config | config | サウンドオブジェクト作成用コンフィグ構造体 |
Returns
| Type | Description |
|---|---|
| int | ワーク領域サイズ |
Remarks
説明: サウンドオブジェクトを作成するために必要な、ワーク領域のサイズを取得します。 アロケーターを登録せずにサウンドオブジェクトを作成する場合、 あらかじめ本関数で計算したワーク領域サイズ分のメモリを ワーク領域として CriAtomExSoundObject(in Config, IntPtr, int) 関数にセットする必要があります。 プレーヤーの作成に必要なワークメモリのサイズは、プレーヤー作成用コンフィグ 構造体（ CriAtomExSoundObject.Config ）の内容によって変化します。 引数にnullを指定した場合、デフォルト設定 （ SetDefaultConfig(out Config) 適用時と同じパラメーター）で ワーク領域サイズを計算します。 ワーク領域サイズ計算時に失敗した場合、戻り値は -1 になります。 ワーク領域サイズの計算に失敗した理由については、エラーコールバックの メッセージで確認可能です。
備考: 引数 config の情報は、関数内でのみ参照されます。 関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。
注意: 本関数を実行する前に、ライブラリを初期化しておく必要があります。
See Also
DeleteAllPlayers()
全てのAtomExプレーヤーの削除
Declaration
public void DeleteAllPlayers()Remarks
説明: サウンドオブジェクトに関連付けられている全てのAtomExプレーヤーを削除します。 削除したAtomExプレーヤーはサウンドオブジェクトとの関連付けが切られ、 サウンドオブジェクトによる影響を受けなくなります。
注意: 本関数の呼び出しは、削除しようとしているAtomExプレーヤーで音声を再生していない状態で行ってください。 ステータスが Stop ではないAtomExプレーヤーが含まれていた場合、 削除時に StopWithoutReleaseTime() 関数にて再生停止が行われます。
See Also
DeletePlayer(CriAtomExPlayer)
AtomExプレーヤーの削除
Declaration
public void DeletePlayer(CriAtomExPlayer player)Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomExPlayer | player | AtomExプレーヤー |
Remarks
説明: サウンドオブジェクトからAtomExプレーヤーを削除します。 削除したAtomExプレーヤーはサウンドオブジェクトとの関連付けが切られ、 サウンドオブジェクトによる影響を受けなくなります。
注意: 本関数の呼び出しは、削除しようとしているAtomExプレーヤーで音声を再生していない状態で行ってください。 ステータスが Stop ではないAtomExプレーヤーが指定された場合、 削除時に StopWithoutReleaseTime() 関数にて再生停止が行われます。
See Also
Dispose()
サウンドオブジェクトの破棄
Declaration
public void Dispose()Remarks
説明: サウンドオブジェクトを破棄します。 本関数を実行した時点で、サウンドオブジェクト作成時に確保されたリソースが全て解放されます。 また、引数に指定したサウンドオブジェクトオブジェクトも無効になります。
See Also
SetDefaultConfig(out Config)
サウンドオブジェクト作成用コンフィグ構造体にデフォルト値をセット
Declaration
public static void SetDefaultConfig(out CriAtomExSoundObject.Config pConfig)Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomExSoundObject.Config | pConfig | サウンドオブジェクト作成用コンフィグ構造体へのポインタ |
Remarks
説明: CriAtomExSoundObject(in Config, IntPtr, int) 関数に設定するコンフィグ構造体 （ CriAtomExSoundObject.Config ）に、デフォルトの値をセットします。