CRI ADX2  Last Updated: 2021-04-27 11:06 p
CriAtomExMonitor API

データ構造

struct  CriAtomExMonitorConfigTag
 Atomモニターライブラリ初期化用コンフィグ構造体 [詳解]
 
struct  CriAtomExMonitorDataUpdateNotificationInfoTag
 データ更新情報 [詳解]
 

マクロ定義

#define CRIATOMX_MONITOR_DEFAULT_NUM_PUREVIEW_OBJECTS   (200)
 デフォルトプレビューオブジェクト [詳解]
 
#define CRIATOMX_MONITOR_DEFAULT_COMMUNICATION_BUFFER_SIZE   (2*1024*1024)
 デフォルト通信バッファサイズ [詳解]
 
#define CRIATOMX_MONITOR_DEFAULT_PLAYBACK_POSITION_UPDATE_INTERVAL   (8)
 デフォルト再生位置情報更新間隔 [詳解]
 
#define CRIATOMEX_MONITOR_LOG_MODE_OFF   (0)
 ログ取得モード [詳解]
 
#define criAtomExMonitor_SetDefaultConfig(p_config)
 Atomモニターライブラリ初期化コンフィグ構造体にデフォルト値をセット [詳解]
 

型定義

typedef struct CriAtomExMonitorConfigTag CriAtomExMonitorConfig
 Atomモニターライブラリ初期化用コンフィグ構造体 [詳解]
 
typedef enum CriAtomExMonitorDataUpdateTargetTag CriAtomExMonitorDataUpdateTarget
 データ更新タイプ [詳解]
 
typedef enum CriAtomExMonitorDataUpdateEventTag CriAtomExMonitorDataUpdateEvent
 データ更新ステータス [詳解]
 
typedef struct CriAtomExMonitorDataUpdateNotificationInfoTag CriAtomExMonitorDataUpdateNotificationInfo
 データ更新情報 [詳解]
 

列挙型

enum  CriAtomExMonitorDataUpdateTargetTag { CRIATOMEXMONITOR_DATA_UPDATE_TARGET_ACF = 0 , CRIATOMEXMONITOR_DATA_UPDATE_TARGET_ACB = 1 , CRIATOMEXMONITOR_DATA_UPDATE_TARGET_ENUM_SIZE_IS_4BYTES = 0x7FFFFFFF }
 データ更新タイプ [詳解]
 
enum  CriAtomExMonitorDataUpdateEventTag { CRIATOMEXMONITOR_DATA_UPDATE_EVENT_BEGIN = 0 , CRIATOMEXMONITOR_DATA_UPDATE_EVENT_END = 1 , CRIATOMEXMONITOR_DATA_UPDATE_EVENT_ENUM_SIZE_IS_4BYTES = 0x7FFFFFFF }
 データ更新ステータス [詳解]
 

関数

CriSint32 CRIAPI criAtomExMonitor_CalculateWorkSize (const CriAtomExMonitorConfig *config)
 モニター機能初期化用ワーク領域サイズの計算 [詳解]
 
void CRIAPI criAtomExMonitor_Initialize (const CriAtomExMonitorConfig *config, void *work, CriSint32 work_size)
 モニター機能の初期化 [詳解]
 
void CRIAPI criAtomExMonitor_Finalize (void)
 モニター機能の終了 [詳解]
 
const CriChar8 *CRIAPI criAtomExMonitor_GetServerIpString (void)
 サーバーIPアドレス文字列の取得 [詳解]
 
const CriChar8 *CRIAPI criAtomExMonitor_GetClientIpString (void)
 クライアントIPアドレス文字列の取得 [詳解]
 
CriBool CRIAPI criAtomExMonitor_IsConnected (void)
 ツール接続状態の取得 [詳解]
 
void CRIAPI criAtomExMonitor_SetLogCallback (CriAtomExMonitorLogCbFunc cbf, void *obj)
 ログ取得コールバックの登録 [詳解]
 
void CRIAPI criAtomExMonitor_SetLogMode (CriUint32 mode)
 ログモードの設定 [詳解]
 
void CRIAPI criAtomExMonitor_OutputUserLog (const CriChar8 *message)
 ユーザログの出力 [詳解]
 
void CRIAPI criAtomExMonitor_SetDataUpdateNotificationCallback (CriAtomExMonitorDataUpdateNotificationCbFunc func, void *obj)
 データ更新通知コールバック関数の登録 [詳解]
 

詳解

マクロ定義詳解

◆ CRIATOMX_MONITOR_DEFAULT_NUM_PUREVIEW_OBJECTS

#define CRIATOMX_MONITOR_DEFAULT_NUM_PUREVIEW_OBJECTS   (200)

デフォルトプレビューオブジェクト

説明:
デフォルトのプレビューオブジェクト数です。
参照
criAtomExMonitor_SetDefaultConfig

◆ CRIATOMX_MONITOR_DEFAULT_COMMUNICATION_BUFFER_SIZE

#define CRIATOMX_MONITOR_DEFAULT_COMMUNICATION_BUFFER_SIZE   (2*1024*1024)

デフォルト通信バッファサイズ

説明:
デフォルトの通信バッファサイズです。
参照
criAtomExMonitor_SetDefaultConfig

◆ CRIATOMX_MONITOR_DEFAULT_PLAYBACK_POSITION_UPDATE_INTERVAL

#define CRIATOMX_MONITOR_DEFAULT_PLAYBACK_POSITION_UPDATE_INTERVAL   (8)

デフォルト再生位置情報更新間隔

説明:
デフォルトの再生位置情報更新間隔です。
参照
criAtomExMonitor_SetDefaultConfig

◆ CRIATOMEX_MONITOR_LOG_MODE_OFF

#define CRIATOMEX_MONITOR_LOG_MODE_OFF   (0)

ログ取得モード

説明:
ログ取得のモードです。
参照
criAtomExMonitor_SetLogMode

◆ criAtomExMonitor_SetDefaultConfig

#define criAtomExMonitor_SetDefaultConfig (   p_config)
値:
{\
(p_config)->max_preivew_object = CRIATOMX_MONITOR_DEFAULT_NUM_PUREVIEW_OBJECTS;\
(p_config)->communication_buffer_size = CRIATOMX_MONITOR_DEFAULT_COMMUNICATION_BUFFER_SIZE;\
(p_config)->additional_buffer = 0;\
(p_config)->additional_buffer_size = 0;\
(p_config)->playback_position_update_interval = CRIATOMX_MONITOR_DEFAULT_PLAYBACK_POSITION_UPDATE_INTERVAL;\
}
#define CRIATOMX_MONITOR_DEFAULT_PLAYBACK_POSITION_UPDATE_INTERVAL
デフォルト再生位置情報更新間隔
Definition: cri_atom_ex_monitor.h:66
#define CRIATOMX_MONITOR_DEFAULT_COMMUNICATION_BUFFER_SIZE
デフォルト通信バッファサイズ
Definition: cri_atom_ex_monitor.h:58
#define CRIATOMX_MONITOR_DEFAULT_NUM_PUREVIEW_OBJECTS
デフォルトプレビューオブジェクト
Definition: cri_atom_ex_monitor.h:50

Atomモニターライブラリ初期化コンフィグ構造体にデフォルト値をセット

説明:
criAtomExMonitor_Initialize 関数に設定するコンフィグ構造体 ( CriAtomExMonitorConfig )に、デフォルト値をセットします。
参照
criAtomExMonitor_Initialize, CriAtomExMonitorConfig

型定義詳解

◆ CriAtomExMonitorConfig

Atomモニターライブラリ初期化用コンフィグ構造体

説明:
モニターライブラリの動作仕様を指定するための構造体です。
criAtomExMonitor_Initialize 関数の引数に指定します。

CRI AtomEx Monitorライブラリは、初期化時に本構造体で指定された設定に応じて、内部リソースを 必要なだけ確保します。
ライブラリが必要とするワーク領域のサイズは、本構造体で指定されたパラメーターに応じて 変化します。
備考:
デフォルト設定を使用する場合、 criAtomExMonitor_SetDefaultConfig マクロで構造体にデフォルト パラメーターをセットした後、 criAtomExMonitor_Initialize 関数に構造体を指定してください。
注意
将来的にメンバが増える可能性があるため、 criAtomExMonitor_SetDefaultConfig マクロを使用しない 場合には、使用前に必ず構造体をゼロクリアしてください。
(構造体のメンバに不定値が入らないようご注意ください。)
参照
criAtomExMonitor_Initialize, criAtomExMonitor_SetDefaultConfig

◆ CriAtomExMonitorDataUpdateTarget

データ更新タイプ

説明:
インゲームプレビュー時のAtomCraft(オーサリングツール)によるデータ更新のターゲットです。
参照
CriAtomExMonitorDataUpdateNotificationInfo

◆ CriAtomExMonitorDataUpdateEvent

データ更新ステータス

説明:
インゲームプレビュー時のAtomCraft(オーサリングツール)によるデータ更新の状態です。
参照
CriAtomExMonitorDataUpdateNotificationInfo

◆ CriAtomExMonitorDataUpdateNotificationInfo

データ更新情報

説明:
インゲームプレビュー時のAtomCraft(オーサリングツール)によるデータ更新情報です。
参照
criAtomExMonitor_SetDataUpdateNotificationCallback

列挙型詳解

◆ CriAtomExMonitorDataUpdateTargetTag

データ更新タイプ

説明:
インゲームプレビュー時のAtomCraft(オーサリングツール)によるデータ更新のターゲットです。
参照
CriAtomExMonitorDataUpdateNotificationInfo
列挙値
CRIATOMEXMONITOR_DATA_UPDATE_TARGET_ACF 

ACF更新

CRIATOMEXMONITOR_DATA_UPDATE_TARGET_ACB 

ACB更新

◆ CriAtomExMonitorDataUpdateEventTag

データ更新ステータス

説明:
インゲームプレビュー時のAtomCraft(オーサリングツール)によるデータ更新の状態です。
参照
CriAtomExMonitorDataUpdateNotificationInfo
列挙値
CRIATOMEXMONITOR_DATA_UPDATE_EVENT_BEGIN 

開始イベント

CRIATOMEXMONITOR_DATA_UPDATE_EVENT_END 

終了イベント

関数詳解

◆ criAtomExMonitor_CalculateWorkSize()

CriSint32 CRIAPI criAtomExMonitor_CalculateWorkSize ( const CriAtomExMonitorConfig config)

モニター機能初期化用ワーク領域サイズの計算

引数
[in]config初期化用コンフィグ構造体
戻り値
CriSint32 ワーク領域サイズ
説明:
モニター機能を使用するために必要な、ワーク領域のサイズを取得します。

ワーク領域サイズの計算に失敗すると、本関数は -1 を返します。
ワーク領域サイズの計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。
備考:
モニター機能が必要とするワーク領域のサイズは、モニター機能初期化用コンフィグ 構造体( CriAtomExMonitorConfig )の内容によって変化します。

引数にNULLを指定した場合、デフォルト設定 ( criAtomExMonitor_SetDefaultConfig 適用時と同じパラメータ)で ワーク領域サイズを計算します。
引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。
参照
criAtomExMonitor_SetDefaultConfig, criAtomExMonitor_Initialize, CriAtomExMonitorConfig

◆ criAtomExMonitor_Initialize()

void CRIAPI criAtomExMonitor_Initialize ( const CriAtomExMonitorConfig config,
void *  work,
CriSint32  work_size 
)

モニター機能の初期化

引数
[in]config初期化用コンフィグ構造体
[in]workワーク領域
[in]work_sizeワーク領域サイズ
説明:
モニター機能を初期化します。
モニター機能を利用するには、必ずこの関数を実行する必要があります。
(モニター機能は、本関数を実行後、 criAtomExMonitor_Finalize 関数を実行するまでの間、 利用可能です。)
本関数の呼び出しは、criAtomEx_Initialize 関数実行後 criAtomEx_Finalize 関数を実行するまでの間に 行うようにしてください。
参照
criAtomExMonitor_Finalize, CriAtomExMonitorConfig

◆ criAtomExMonitor_Finalize()

void CRIAPI criAtomExMonitor_Finalize ( void  )

モニター機能の終了

説明:
モニター機能を終了します。
注意
criAtomExMonitor_Initialize 関数実行前に本関数を実行することはできません。
参照
criAtomExMonitor_Initialize

◆ criAtomExMonitor_GetServerIpString()

const CriChar8* CRIAPI criAtomExMonitor_GetServerIpString ( void  )

サーバーIPアドレス文字列の取得

説明:
サーバーIPアドレス文字列を取得します。
注意
criAtomExMonitor_Initialize 関数実行前に本関数を実行することはできません。
参照
criAtomExMonitor_Initialize, criAtomExMonitor_GetClientIpString

◆ criAtomExMonitor_GetClientIpString()

const CriChar8* CRIAPI criAtomExMonitor_GetClientIpString ( void  )

クライアントIPアドレス文字列の取得

説明:
クライアントIPアドレス文字列を取得します。
注意
criAtomExMonitor_Initialize 関数実行前に本関数を実行することはできません。
参照
criAtomExMonitor_Initialize, criAtomExMonitor_GetServerIpString

◆ criAtomExMonitor_IsConnected()

CriBool CRIAPI criAtomExMonitor_IsConnected ( void  )

ツール接続状態の取得

戻り値
CriBool 接続状態(CRI_TRUE:接続、CRI_FALSE:未接続)
説明:
ツール接続状態を取得します。
注意
criAtomExMonitor_Initialize 関数実行前に本関数を実行することはできません。
参照
criAtomExMonitor_Initialize

◆ criAtomExMonitor_SetLogCallback()

void CRIAPI criAtomExMonitor_SetLogCallback ( CriAtomExMonitorLogCbFunc  cbf,
void *  obj 
)

ログ取得コールバックの登録

引数
cbfコールバック関数
objユーザ指定オブジェクト
説明:
ログ取得用コールバック関数を登録します。
関数を登録するとログ取得を開始し、NULLを設定することでログ取得を停止します。
取得するログのモード切替は criAtomExMonitor_SetLogMode 関数で設定指定ください。
注意
criAtomExMonitor_Initialize 関数実行前に本関数を実行することはできません。
参照
criAtomExMonitor_Initialize, criAtomExMonitor_SetLogMode

◆ criAtomExMonitor_SetLogMode()

void CRIAPI criAtomExMonitor_SetLogMode ( CriUint32  mode)

ログモードの設定

引数
modeログ出力モード
説明:
ログ取得のモードを設定します。
本関数で設定したモードにしたがって criAtomExMonitor_SetLogCallback 関数で 登録したログ取得用コールバック関数が呼び出されます。
参照
criAtomExMonitor_SetLogCallback

◆ criAtomExMonitor_OutputUserLog()

void CRIAPI criAtomExMonitor_OutputUserLog ( const CriChar8 *  message)

ユーザログの出力

引数
messageユーザログメッセージ
説明:
ユーザログを出力します。
本関数によって出力したログはログ取得コールバックやプロファイラで取得、確認が行えます。
参照
criAtomExMonitor_SetLogCallback

◆ criAtomExMonitor_SetDataUpdateNotificationCallback()

void CRIAPI criAtomExMonitor_SetDataUpdateNotificationCallback ( CriAtomExMonitorDataUpdateNotificationCbFunc  func,
void *  obj 
)

データ更新通知コールバック関数の登録

引数
[in]funcデータ更新通知コールバック関数
[in]objユーザ指定オブジェクト
説明:
インゲームプレビュー時にオーサリングツールからのデータ更新処理が発生した場合に呼び出すコールバック関数を登録します。
注意
コールバック関数内で、AtomライブラリのAPIを実行しないでください。
コールバック関数はAtomMonitorライブラリ内のサーバ処理からも実行されます。
そのため、サーバ処理への割り込みを考慮しないAPIを実行した場合、 エラーが発生したり、デッドロックが発生する可能性があります。

コールバック関数内で長時間処理をブロックすると、音切れ等の問題 が発生しますので、ご注意ください。

コールバック関数は1つしか登録できません。
登録操作を複数回行った場合、既に登録済みのコールバック関数が、 後から登録したコールバック関数により上書きされてしまいます。

funcにNULLを指定するとことで登録済み関数の登録解除が行えます。
criAtomExMonitor_Initialize 関数実行前に本関数を実行することはできません。
参照
CriAtomExMonitorDataUpdateNotificationCbFunc, CriAtomExMonitorDataUpdateNotificationInfo