Class CriAtomEx3dSourceList

3D音源オブジェクトリスト

Inheritance
object
CriAtomEx3dSourceList
Implements
Inherited Members
Namespace: CriWare
Assembly: CriWare.CriAtom.dll
Syntax
public class CriAtomEx3dSourceList : IDisposable
Remarks

説明: 3D音源オブジェクトを管理するリストオブジェクトです。 3Dポジショニング機能におけるマルチポジショニング再生に使用します。

Constructors

CriAtomEx3dSourceList(in Config, IntPtr, int)

3D音源オブジェクトリストの作成

Declaration
public CriAtomEx3dSourceList(in CriAtomEx3dSourceList.Config config, IntPtr work = default, int workSize = 0)
Parameters
Type Name Description
CriAtomEx3dSourceList.Config config

3D音源オブジェクトリスト作成用コンフィグ構造体へのポインタ
IntPtr work

3D音源オブジェクトリスト作成用ワーク領域へのポインタ
int workSize

3D音源オブジェクトリスト作成用ワークサイズ
Remarks

説明: 3D音源オブジェクトリスト作成用コンフィグに基づいて、3D音源オブジェクトリストを作成します。 作成に成功すると、3D音源オブジェクトリストを返します。 3D音源オブジェクトリストを作成する際には、ワーク領域としてメモリを渡す必要があります。 必要なメモリのサイズは、 CalculateWorkSize(in Config) 関数で計算します。 （SetUserAllocator(delegate* unmanaged[Cdecl]<IntPtr, uint, IntPtr>, delegate* unmanaged[Cdecl]<IntPtr, IntPtr, void>, IntPtr) メソッドを使用してアロケーターを登録済みの場合、 本関数にワーク領域を指定する必要はありません。）

注意: 本関数を実行する前に、ライブラリを初期化しておく必要があります。

See Also

CriAtomEx3dSourceList(IntPtr, int)

デフォルト設定でのインスタンス作成

Declaration
public CriAtomEx3dSourceList(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

Add(CriAtomEx3dSource)

3D音源オブジェクトリストへの3D音源オブジェクトの追加

Declaration
public void Add(CriAtomEx3dSource ex3dSource)
Parameters
Type Name Description
CriAtomEx3dSource ex3dSource

3D音源オブジェクト
Remarks

説明: 3D音源オブジェクトリストに3D音源オブジェクトを追加します。 追加したAtomExプレーヤーは3D音源オブジェクトリストと関連付けられ、 マルチポジショニング再生が可能となります。 追加した3D音源オブジェクトを3D音源オブジェクトリストから削除する場合は、 Remove(CriAtomEx3dSource) 関数または RemoveAll() 関数を呼び出してください。

備考: 以下の条件に当てはまる3D音源オブジェクトは3D音源オブジェクトリストに追加することはできません。 - 既にAtomExプレーヤーに設定されている - 既に他の3D音源オブジェクトリストに追加されている 本関数は再生中のAtomExプレーヤーに取り付けられている3D音源オブジェクトリストに対しても使用可能です。

注意: 注意: 本関数は完了復帰型の関数です。 本関数を実行すると、しばらくの間Atomライブラリのサーバー処理がブロックされます。 音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。

See Also

CalculateWorkSize(in Config)

3D音源オブジェクトリストの作成に必要なワーク領域サイズの計算

Declaration
public static int CalculateWorkSize(in CriAtomEx3dSourceList.Config config)
Parameters
Type Name Description
CriAtomEx3dSourceList.Config config

3D音源オブジェクトリスト作成用コンフィグ構造体へのポインタ
Returns
Type Description
int

3D音源オブジェクトリスト作成用ワークサイズ
Remarks

説明: 3D音源オブジェクトリストを作成するために必要なワーク領域のサイズを取得します。 アロケーターを登録せずに3D音源オブジェクトリストを作成する場合、 あらかじめ本関数で計算したワーク領域サイズ分のメモリを ワーク領域として CriAtomEx3dSourceList(in Config, IntPtr, int) 関数にセットする必要があります。 3D音源オブジェクトリストの作成に必要なワークメモリのサイズは、3D音源オブジェクトリスト作成用コンフィグ 構造体（ CriAtomEx3dSourceList.Config ）の内容によって変化します。 引数にnullを指定した場合、デフォルト設定 （ SetDefaultConfig(out Config) 適用時と同じパラメーター）で ワーク領域サイズを計算します。 ワーク領域サイズ計算時に失敗した場合、戻り値は -1 になります。 ワーク領域サイズの計算に失敗した理由については、エラーコールバックの メッセージで確認可能です。

備考: 引数 config の情報は、関数内でのみ参照されます。 関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。

See Also

Dispose()

3D音源オブジェクトリストの破棄

Declaration
public void Dispose()
Remarks

説明: 3D音源オブジェクトリストを破棄します。 本関数を実行した時点で、3D音源オブジェクトリスト作成時に確保されたリソースが全て解放されます。 また、引数に指定した3D音源オブジェクトリストも無効になります。 3D音源オブジェクトリストをセットしたAtomExプレーヤーで再生している音声がある場合、 本関数を実行する前に、それらの音声を停止するか、そのAtomExプレーヤーを破棄してください。

備考: 3D音源オブジェクトリストに3D音源オブジェクトが追加されている状態で本関数を実行した場合、 追加されていた3D音源オブジェクトは自動的に3D音源オブジェクトリストから削除されます。

See Also

Remove(CriAtomEx3dSource)

3D音源オブジェクトリストから3D音源オブジェクトの削除

Declaration
public void Remove(CriAtomEx3dSource ex3dSource)
Parameters
Type Name Description
CriAtomEx3dSource ex3dSource

3D音源オブジェクト
Remarks

説明: 3D音源オブジェクトリストから、指定した3D音源オブジェクトを削除します。 3D音源オブジェクトリストから全ての3D音源オブジェクトを削除したい場合は、 RemoveAll() 関数を 呼び出してください。 3D音源オブジェクトリストに3D音源オブジェクトを追加したい場合は、 Add(CriAtomEx3dSource) 関数を呼び出してください。

備考: 本関数は再生中のAtomExプレーヤーに取り付けられている3D音源オブジェクトリストに対しても使用可能です。

注意: 注意: 本関数は完了復帰型の関数です。 本関数を実行すると、しばらくの間Atomライブラリのサーバー処理がブロックされます。 音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。

See Also

RemoveAll()

3D音源オブジェクトリストから3D音源オブジェクトの全削除

Declaration
public void RemoveAll()
Remarks

説明: 3D音源オブジェクトリストから追加されている全ての3D音源オブジェクトを削除します。 3D音源オブジェクトリストから特定の3D音源オブジェクトを削除したい場合は、 Remove(CriAtomEx3dSource) 関数を 呼び出してください。 3D音源オブジェクトリストに3D音源オブジェクトを追加したい場合は、 Add(CriAtomEx3dSource) 関数を呼び出してください。

備考: 本関数は再生中のAtomExプレーヤーに取り付けられている3D音源オブジェクトリストに対しても使用可能です。

注意: 注意: 本関数は完了復帰型の関数です。 本関数を実行すると、しばらくの間Atomライブラリのサーバー処理がブロックされます。 音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。

See Also

SetDefaultConfig(out Config)

3D音源オブジェクトリスト作成用コンフィグ構造体にデフォルト値をセット

Declaration
public static void SetDefaultConfig(out CriAtomEx3dSourceList.Config pConfig)
Parameters
Type Name Description
CriAtomEx3dSourceList.Config pConfig

3D音源オブジェクトリスト作成用コンフィグ構造体へのポインタ
Remarks

説明: 3D音源オブジェクトリスト作成用コンフィグ構造体（ CriAtomEx3dSourceList.Config ）に、デフォルトの値をセットします。

See Also

Implements

See Also