CriAtomDbas API


構成

struct  CriAtomDbasConfigTag
 D-BAS作成パラメーター構造体 [詳細]

マクロ定義

#define CRIATOMDBAS_ILLEGAL_ID   (-1)
 Atom D-BAS ID
#define CRIATOMDBAS_DEFAULT_NUM_SECUREMENT_BUFFERS   (4)
 D-BAS作成用のデフォルトのバッファー保証数
#define CRIATOMDBAS_MINIMUM_NUM_SECUREMENT_BUFFERS   (2)
 D-BAS作成時に指定可能なバッファー保証数の下限値
#define criAtomDbas_SetDefaultConfig(p_config)
 CriAtomDbasConfig へのデフォルトパラメーターのセット

型定義

typedef CriSint32 CriAtomDbasId
 Atom D-BAS ID
typedef CriAtomDbasConfigTag CriAtomDbasConfig
 D-BAS作成パラメーター構造体

関数

CriSint32 CRIAPI criAtomDbas_CalculateWorkSize (const CriAtomDbasConfig *config)
 D-BAS作成用ワークサイズの計算
CriAtomDbasId CRIAPI criAtomDbas_Create (const CriAtomDbasConfig *config, void *work, CriSint32 work_size)
 D-BASの作成
void CRIAPI criAtomDbas_Destroy (CriAtomDbasId atom_dbas_id)
 D-BASの破棄
CriSint32 CRIAPI criAtomDbas_GetStreamingPlayerHandles (CriAtomDbasId dbas_id, CriAtomPlayerHn *players, CriSint32 length)
 ストリーム再生中のAtomプレーヤーハンドルを取得

マクロ定義

#define CRIATOMDBAS_ILLEGAL_ID   (-1)

Atom D-BAS ID

説明:
criAtomDbas_Create 関数に失敗した際に返る値です。
参照:
criAtomDbas_Create, criAtomDbas_Destroy

#define CRIATOMDBAS_DEFAULT_NUM_SECUREMENT_BUFFERS   (4)

D-BAS作成用のデフォルトのバッファー保証数

説明:
D-BAS作成用のデフォルトのバッファー保証数です。 ループ先頭、およびループ終端で極端にデータが少なくなる音声データであっても 途切れないようにストリーミング再生可能な安全な値を設定しています。
参照:
criAtomDbas_Create, criAtomDbas_CalculateWorkSize

#define CRIATOMDBAS_MINIMUM_NUM_SECUREMENT_BUFFERS   (2)

D-BAS作成時に指定可能なバッファー保証数の下限値

説明:
D-BAS作成時に指定可能なバッファー保証数の下限値です。 途切れずにストリーミング再生するためには、 最低でも2バッファー(ダブルバッファリング)必要なため、 2未満の値に設定する事はできません。
参照:
criAtomDbas_Create, criAtomDbas_CalculateWorkSize

#define criAtomDbas_SetDefaultConfig ( p_config   ) 

値:

{\
    (p_config)->identifier  = 0;\
    (p_config)->max_streams = CRIATOM_DEFAULT_DBAS_MAX_STREAMS;\
    (p_config)->max_bps     = CRIATOM_DEFAULT_DBAS_MAX_BPS;\
    (p_config)->max_mana_streams    = 0;\
    (p_config)->max_mana_bps        = 0;\
    (p_config)->num_securement_buffers = CRIATOMDBAS_DEFAULT_NUM_SECUREMENT_BUFFERS;\
}
CriAtomDbasConfig へのデフォルトパラメーターのセット

引数:
[out] p_config D-BAS作成用コンフィグ構造体へのポインタ
説明:
criAtomDbas_Create 関数に設定するコンフィグ構造体 ( CriAtomDbasConfig )に、デフォルトの値をセットします。
参照:
CriAtomDbasConfig, criAtomDbas_Create, criAtomDbas_CalculateWorkSize


型定義

typedef CriSint32 CriAtomDbasId

Atom D-BAS ID

説明:
CriAtomDbasId は、D-BAS管理用のIDです。
criAtomDbas_Create 関数でD-BASを作成すると取得できます。
アプリケーションがこのD-BAS IDを利用するのは、D-BASの破棄時のみです。
参照:
criAtomDbas_Create, criAtomDbas_Destroy

typedef struct CriAtomDbasConfigTag CriAtomDbasConfig

D-BAS作成パラメーター構造体

説明:
criAtomDbas_Create 関数の引数に指定する、D-BASの作成パラメーター構造体です。

注意:
将来的にメンバが増える可能性があるため、 criAtomDbas_SetDefaultConfig マクロを使用しない場合には、使用前に必ず構造体をゼロクリアしてください。
(構造体のメンバに不定値が入らないようご注意ください。)
参照:
criAtomDbas_Create, criAtomDbas_CalculateWorkSize, criAtomDbas_SetDefaultConfig


関数

CriSint32 CRIAPI criAtomDbas_CalculateWorkSize ( const CriAtomDbasConfig config  ) 

D-BAS作成用ワークサイズの計算

引数:
[in] config D-BAS作成用コンフィグ構造体へのポインタ
戻り値:
CriSint32 D-BAS作成用ワークサイズ
戻り値:
0以上 正常に処理が完了
-1 エラーが発生
説明:
D-BAS作成用パラメーターに基づいて、D-BASの作成に必要ワークサイズを計算します。

ワーク領域サイズの計算に失敗すると、本関数は -1 を返します。
ワーク領域サイズの計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。
注意:
本関数を実行する前に、ライブラリを初期化しておく必要があります。

設定によっては、D-BASが2GB以上のワークサイズを必要とする場合があり、
その際はエラーになり、 -1 を返します。
エラーが発生した場合は、max_streamsかmax_bpsの値を低く設定してください。
参照:
criAtomDbas_Create

CriAtomDbasId CRIAPI criAtomDbas_Create ( const CriAtomDbasConfig config,
void *  work,
CriSint32  work_size 
)

D-BASの作成

引数:
[in] config D-BAS作成用コンフィグ構造体へのポインタ
[in] work D-BAS作成用ワーク領域へのポインタ
[in] work_size D-BAS作成用ワークサイズ
戻り値:
CriAtomDbasId D-BAS管理用ID
説明:
D-BAS作成用パラメーターに基づいて、D-BASを作成します。
作成に成功すると、D-BASをライブラリに登録し、有効な管理用IDを返します。
D-BASの作成に失敗した場合、本関数は CRIATOMDBAS_ILLEGAL_ID を返します。
(エラーの原因はエラーコールバックに返されます。)

取得したIDはcriAtomDbas_Destroy 関数で使用します。
注意:
本関数を実行する前に、ライブラリを初期化しておく必要があります。
参照:
criAtomDbas_CalculateWorkSize, criAtomDbas_Destroy

void CRIAPI criAtomDbas_Destroy ( CriAtomDbasId  atom_dbas_id  ) 

D-BASの破棄

引数:
[in] atom_dbas_id D-BAS管理用ID
説明:
criAtomDbas_Create 関数で取得した管理用IDを指定して、D-BASを破棄します。
参照:
criAtomDbas_Create

CriSint32 CRIAPI criAtomDbas_GetStreamingPlayerHandles ( CriAtomDbasId  dbas_id,
CriAtomPlayerHn players,
CriSint32  length 
)

ストリーム再生中のAtomプレーヤーハンドルを取得

引数:
[in] dbas_id D-BAS管理用ID
[out] players プレーヤーハンドル受け取り用配列
[in] length プレーヤーハンドル受け取り用配列要素数
戻り値:
CriSint32 プレーヤー数
戻り値:
0以上 正常に処理が完了
-1 エラーが発生
説明:
ストリーム再生中のAtomプレーヤーハンドルを取得します。
プレーヤーハンドルの取得に成功すると、 第3引数(players配列)にプレーヤーハンドルのアドレスが保存され、 プレーヤーハンドル数が戻り値として返されます。
備考:
第3引数(players配列)にNULL、第4引数(length)に0を指定することで、 ストリーム再生中のプレーヤーの数だけを戻り値として取得可能です。
注意:
プレーヤー数を取得してからハンドルを取得する場合、 プレーヤー数取得とハンドル取得の間にサーバー処理が割り込まないよう、 criAtom_Lock 関数で排他制御を行う必要があります。
(サーバー処理のタイミングで、プレーヤー数が変わる可能性があります。)

配列要素数がストリーム再生中のプレーヤー数に満たない場合、 本関数はエラー値(-1)を返します。


CRI Middleware logo Copyright (c) 2006-2018 CRI Middleware Co., Ltd.