#include <cri_le_xpt.h>

構成
struct	CriAtomExMonitorDataUpdateNotificationInfoTag
	データ更新情報 [詳細]

マクロ定義
#define	CRIATOMX_MONITOR_DEFAULT_NUM_PUREVIEW_OBJECTS (200)
	デフォルトプレビューオブジェクト
#define	CRIATOMX_MONITOR_DEFAULT_COMMUNICATION_BUFFER_SIZE (210241024)
	デフォルト通信バッファサイズ
#define	CRIATOMX_MONITOR_DEFAULT_PLAYBACK_POSITION_UPDATE_INTERVAL (8)
	デフォルト再生位置情報更新間隔
#define	CRIATOMEX_MONITOR_LOG_MODE_OFF (0)
	ログ取得モード

型定義
typedef enum CriAtomExMonitorDataUpdateTargetTag	CriAtomExMonitorDataUpdateTarget
	データ更新タイプ
typedef enum CriAtomExMonitorDataUpdateEventTag	CriAtomExMonitorDataUpdateEvent
	データ更新ステータス
typedef struct CriAtomExMonitorDataUpdateNotificationInfoTag	CriAtomExMonitorDataUpdateNotificationInfo
	データ更新情報
typedef void(CRIAPI *	CriAtomExMonitorDataUpdateNotificationCbFunc )(void obj, const CriAtomExMonitorDataUpdateNotificationInfo info)
	オーサリングツールによるデータ更新通知情報取得コールバック関数

列挙型
enum	CriAtomExMonitorDataUpdateTargetTag { CRIATOMEXMONITOR_DATA_UPDATE_TARGET_ACF = 0, CRIATOMEXMONITOR_DATA_UPDATE_TARGET_ACB = 1 }
	データ更新タイプ [詳細]
enum	CriAtomExMonitorDataUpdateEventTag { CRIATOMEXMONITOR_DATA_UPDATE_EVENT_BEGIN = 0, CRIATOMEXMONITOR_DATA_UPDATE_EVENT_END = 1 }
	データ更新ステータス [詳細]

関数
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)
	データ更新通知コールバック関数の登録

説明

マクロ定義

#define CRIATOMX_MONITOR_DEFAULT_NUM_PUREVIEW_OBJECTS (200)

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

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

参照:: criAtomExMonitor_SetDefaultConfig

#define CRIATOMX_MONITOR_DEFAULT_COMMUNICATION_BUFFER_SIZE (2*1024*1024)

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

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

参照:: criAtomExMonitor_SetDefaultConfig

#define CRIATOMX_MONITOR_DEFAULT_PLAYBACK_POSITION_UPDATE_INTERVAL (8)

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

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

参照:: criAtomExMonitor_SetDefaultConfig

#define CRIATOMEX_MONITOR_LOG_MODE_OFF (0)

ログ取得モード

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

参照:: criAtomExMonitor_SetLogMode

型定義

typedef enum CriAtomExMonitorDataUpdateTargetTag CriAtomExMonitorDataUpdateTarget

データ更新タイプ

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

参照:: CriAtomExMonitorDataUpdateNotificationInfo

typedef enum CriAtomExMonitorDataUpdateEventTag CriAtomExMonitorDataUpdateEvent

データ更新ステータス

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

参照:: CriAtomExMonitorDataUpdateNotificationInfo

typedef struct CriAtomExMonitorDataUpdateNotificationInfoTag CriAtomExMonitorDataUpdateNotificationInfo

データ更新情報

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

参照:: criAtomExMonitor_SetDataUpdateNotificationCallback

列挙型

enum CriAtomExMonitorDataUpdateTargetTag

データ更新タイプ

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

参照:: CriAtomExMonitorDataUpdateNotificationInfo

列挙型の値:

CRIATOMEXMONITOR_DATA_UPDATE_TARGET_ACF	ACF更新
CRIATOMEXMONITOR_DATA_UPDATE_TARGET_ACB	ACB更新

enum CriAtomExMonitorDataUpdateEventTag

データ更新ステータス

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

参照:: CriAtomExMonitorDataUpdateNotificationInfo

列挙型の値:

CRIATOMEXMONITOR_DATA_UPDATE_EVENT_BEGIN	開始イベント
CRIATOMEXMONITOR_DATA_UPDATE_EVENT_END	終了イベント

関数

CriSint32 CRIAPI criAtomExMonitor_CalculateWorkSize ( const CriAtomExMonitorConfig * config )

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

引数:

[in] config 初期化用コンフィグ構造体

戻り値:: CriSint32 ワーク領域サイズ

説明:: モニター機能を使用するために必要な、ワーク領域のサイズを取得します。

ワーク領域サイズの計算に失敗すると、本関数は -1 を返します。
ワーク領域サイズの計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。

備考:: モニター機能が必要とするワーク領域のサイズは、モニター機能初期化用コンフィグ構造体（ ::CriAtomExMonitorConfig ）の内容によって変化します。

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

参照:: criAtomExMonitor_SetDefaultConfig, criAtomExMonitor_Initialize, CriAtomExMonitorConfig

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

void CRIAPI criAtomExMonitor_Finalize ( void )

モニター機能の終了

説明:: モニター機能を終了します。

注意:: criAtomExMonitor_Initialize 関数実行前に本関数を実行することはできません。

参照:: criAtomExMonitor_Initialize

const CriChar8* CRIAPI criAtomExMonitor_GetServerIpString ( void )

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

説明:: サーバーIPアドレス文字列を取得します。

注意:: criAtomExMonitor_Initialize 関数実行前に本関数を実行することはできません。

参照:: criAtomExMonitor_Initialize, criAtomExMonitor_GetClientIpString

const CriChar8* CRIAPI criAtomExMonitor_GetClientIpString ( void )

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

説明:: クライアントIPアドレス文字列を取得します。

注意:: criAtomExMonitor_Initialize 関数実行前に本関数を実行することはできません。

参照:: criAtomExMonitor_Initialize, criAtomExMonitor_GetServerIpString

CriBool CRIAPI criAtomExMonitor_IsConnected ( void )

ツール接続状態の取得

戻り値:: CriBool 接続状態（CRI_TRUE:接続、CRI_FALSE:未接続）

説明:: ツール接続状態を取得します。

注意:: criAtomExMonitor_Initialize 関数実行前に本関数を実行することはできません。

参照:: criAtomExMonitor_Initialize

void CRIAPI criAtomExMonitor_SetLogCallback	(	CriAtomExMonitorLogCbFunc	cbf,
		void *	obj
	)

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

引数:

cbf	コールバック関数
obj	ユーザ指定オブジェクト

説明:: ログ取得用コールバック関数を登録します。
関数を登録するとログ取得を開始し、NULLを設定することでログ取得を停止します。
取得するログのモード切替は ::criAtomExMonito_SetLogMode 関数で設定指定ください。

注意:: criAtomExMonitor_Initialize 関数実行前に本関数を実行することはできません。

参照:: criAtomExMonitor_Initialize, criAtomExMonito_SetLogMode

void CRIAPI criAtomExMonitor_SetLogMode ( CriUint32 mode )

ログモードの設定

引数:

mode ログ出力モード

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

参照:: criAtomExMonitor_SetLogCallback

void CRIAPI criAtomExMonitor_OutputUserLog ( const CriChar8 * message )

ユーザログの出力

引数:

message ユーザログメッセージ

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

参照:: criAtomExMonitor_SetLogCallback

void CRIAPI criAtomExMonitor_SetDataUpdateNotificationCallback	(	CriAtomExMonitorDataUpdateNotificationCbFunc	func,
		void *	obj
	)

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

引数:

[in]	func	データ更新通知コールバック関数
[in]	obj	ユーザ指定オブジェクト

説明:: インゲームプレビュー時にオーサリングツールからのデータ更新処理が発生した場合に呼び出すコールバック関数を登録します。

注意:: コールバック関数内で、AtomライブラリのAPIを実行しないでください。
コールバック関数はAtomMonitorライブラリ内のサーバ処理からも実行されます。
そのため、サーバ処理への割り込みを考慮しないAPIを実行した場合、エラーが発生したり、デッドロックが発生する可能性があります。

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

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

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

参照:: CriAtomExMonitorDataUpdateNotificationCbFunc, CriAtomExMonitorDataUpdateNotificationInfo

構成

マクロ定義

型定義

列挙型

関数

説明

マクロ定義

型定義

列挙型

関数