Class CriAtomExDbas
AtomEx D-BAS ID
Implements
Inherited Members
Namespace: CriWare
Assembly: CriWare.CriAtom.dll
Syntax
public class CriAtomExDbas : IDisposableRemarks
説明: CriAtomExDbas は、D-BAS管理用のIDです。 CriAtomExDbas(in Config, IntPtr, int) 関数でD-BASを作成すると取得できます。 アプリケーションがこのD-BAS IDを利用するのは、D-BASの破棄時のみです。
Constructors
CriAtomExDbas(in Config, IntPtr, int)
D-BASの作成
Declaration
public CriAtomExDbas(in CriAtomExDbas.Config config, IntPtr work = default, int workSize = 0)Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomExDbas.Config | config | D-BAS作成用コンフィグ構造体へのポインタ |
| IntPtr | work | D-BAS作成用ワーク領域へのポインタ |
| int | workSize | D-BAS作成用ワークサイズ |
Remarks
説明: D-BAS作成用パラメーターに基づいて、D-BASを作成します。 作成に成功すると、D-BASをライブラリに登録し、有効な管理用IDを返します。 D-BASの作成に失敗した場合、本関数は IllegalId を返します。 （エラーの原因はエラーコールバックに返されます。） 取得したIDはDispose() 関数で使用します。
注意: 本関数を実行する前に、ライブラリを初期化しておく必要があります。
See Also
CriAtomExDbas(IntPtr, int)
デフォルト設定でのインスタンス作成
Declaration
public CriAtomExDbas(IntPtr work = default, int workSize = 0)Parameters
| Type | Name | Description |
|---|---|---|
| IntPtr | work | |
| int | workSize |
Fields
IllegalId
AtomEx D-BAS ID
Declaration
public const int IllegalId = -1Field Value
| Type | Description |
|---|---|
| int |
Remarks
説明: CriAtomExDbas(in Config, IntPtr, int) 関数に失敗した際に返る値です。
See Also
Properties
NativeHandle
ネイティブハンドル
Declaration
public int NativeHandle { get; }Property Value
| Type | Description |
|---|---|
| int |
Methods
CalculateWorkSize(in Config)
D-BAS作成用ワークサイズの計算
Declaration
public static int CalculateWorkSize(in CriAtomExDbas.Config config)Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomExDbas.Config | config | D-BAS作成用コンフィグ構造体へのポインタ |
Returns
| Type | Description |
|---|---|
| int | D-BAS作成用ワークサイズ |
Remarks
説明: D-BAS作成用パラメーターに基づいて、D-BASの作成に必要ワークサイズを計算します。 ワーク領域サイズの計算に失敗すると、本関数は -1 を返します。 ワーク領域サイズの計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。
注意: ワーク領域のサイズはライブラリ初期化時（ Initialize(in Config, IntPtr, int) 関数実行時） に指定したパラメーターによって変化します。 そのため、本関数を実行する前に、ライブラリを初期化しておく必要があります。
See Also
Dispose()
D-BASの破棄
Declaration
public void Dispose()Remarks
説明: CriAtomExDbas(in Config, IntPtr, int) 関数で取得した管理用IDを指定して、D-BASを破棄します。
See Also
GetStreamingPlayerHandles(IntPtr[], int)
ストリーム再生中のAtomプレーヤーオブジェクトを取得
Declaration
public int GetStreamingPlayerHandles(IntPtr[] players, int length)Parameters
| Type | Name | Description |
|---|---|---|
| IntPtr[] | players | プレーヤーオブジェクト受け取り用配列 |
| int | length | プレーヤーオブジェクト受け取り用配列要素数 |
Returns
| Type | Description |
|---|---|
| int | プレーヤー数 |
Remarks
説明: ストリーム再生中のAtomプレーヤーオブジェクトを取得します。 プレーヤーオブジェクトの取得に成功すると、 第3引数（players配列）にプレーヤーオブジェクトのアドレスが保存され、 プレーヤーオブジェクト数が戻り値として返されます。
備考: 第3引数（players配列）にnull、第4引数（length）に0を指定することで、 ストリーム再生中のプレーヤーの数だけを戻り値として取得可能です。
注意: プレーヤー数を取得してからオブジェクトを取得する場合、 プレーヤー数取得とオブジェクト取得の間にサーバー処理が割り込まないよう、 Lock() 関数で排他制御を行う必要があります。 （サーバー処理のタイミングで、プレーヤー数が変わる可能性があります。） 配列要素数がストリーム再生中のプレーヤー数に満たない場合、 本関数はエラー値（-1）を返します。
SetDefaultConfig(out Config)
CriAtomExDbas.Config へのデフォルトパラメーターのセット
Declaration
public static void SetDefaultConfig(out CriAtomExDbas.Config pConfig)Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomExDbas.Config | pConfig | D-BAS作成用コンフィグ構造体へのポインタ |
Remarks
説明: CriAtomExDbas(in Config, IntPtr, int) 関数に設定するコンフィグ構造体 （ CriAtomExDbas.Config ）に、デフォルトの値をセットします。