结构体
struct	CriAtomExMonitorConfigTag
	Configuration structure used to initialize the Monitor library 更多...

struct	CriAtomExMonitorDataUpdateNotificationInfoTag
	Date Update Info 更多...

宏定义
#define	CRIATOMX_MONITOR_DEFAULT_NUM_PUREVIEW_OBJECTS (200)
	Default number of preview objects 更多...

#define	CRIATOMX_MONITOR_DEFAULT_COMMUNICATION_BUFFER_SIZE (210241024)
	Default communication buffer size 更多...

#define	CRIATOMX_MONITOR_DEFAULT_PLAYBACK_POSITION_UPDATE_INTERVAL (8)
	Default playback position update interval 更多...

#define	CRIATOMEX_MONITOR_LOG_MODE_OFF (0)
	Different types of logs 更多...

#define	criAtomExMonitor_SetDefaultConfig(p_config)
	Assign the default values to the configuration structure of the Monitor library 更多...

类型定义
typedef struct CriAtomExMonitorConfigTag	CriAtomExMonitorConfig
	Configuration structure used to initialize the Monitor library 更多...

typedef enum CriAtomExMonitorDataUpdateTargetTag	CriAtomExMonitorDataUpdateTarget
	Date Update Type 更多...

typedef enum CriAtomExMonitorDataUpdateEventTag	CriAtomExMonitorDataUpdateEvent
	Date Update Status 更多...

typedef struct CriAtomExMonitorDataUpdateNotificationInfoTag	CriAtomExMonitorDataUpdateNotificationInfo
	Date Update Info 更多...

枚举
enum	CriAtomExMonitorDataUpdateTargetTag { CRIATOMEXMONITOR_DATA_UPDATE_TARGET_ACF = 0 , CRIATOMEXMONITOR_DATA_UPDATE_TARGET_ACB = 1 , CRIATOMEXMONITOR_DATA_UPDATE_TARGET_ENUM_SIZE_IS_4BYTES = 0x7FFFFFFF }
	Date Update Type 更多...

enum	CriAtomExMonitorDataUpdateEventTag { CRIATOMEXMONITOR_DATA_UPDATE_EVENT_BEGIN = 0 , CRIATOMEXMONITOR_DATA_UPDATE_EVENT_END = 1 , CRIATOMEXMONITOR_DATA_UPDATE_EVENT_ENUM_SIZE_IS_4BYTES = 0x7FFFFFFF }
	Date Update Status 更多...

函数
CriSint32	criAtomExMonitor_CalculateWorkSize (const CriAtomExMonitorConfig *config)
	Calculate the size of the work buffer required to initialize the monitoring feature 更多...

void	criAtomExMonitor_Initialize (const CriAtomExMonitorConfig config, void work, CriSint32 work_size)
	Initialize the monitoring feature 更多...

void	criAtomExMonitor_Finalize (void)
	Finalize the monitoring feature 更多...

const CriChar8 *	criAtomExMonitor_GetServerIpString (void)
	Get the server IP address string 更多...

const CriChar8 *	criAtomExMonitor_GetClientIpString (void)
	Get the client IP address string 更多...

CriBool	criAtomExMonitor_IsConnected (void)
	Get the tool connection status 更多...

void	criAtomExMonitor_SetLogCallback (CriAtomExMonitorLogCbFunc cbf, void *obj)
	Register the log retrieval callback function 更多...

void	criAtomExMonitor_SetLogMode (CriUint32 mode)
	Specify log mode 更多...

void	criAtomExMonitor_OutputUserLog (const CriChar8 *message)
	User log output 更多...

void	criAtomExMonitor_SetDataUpdateNotificationCallback (CriAtomExMonitorDataUpdateNotificationCbFunc func, void *obj)
	Set data update notification callback function 更多...

详细描述

宏定义说明

◆ CRIATOMX_MONITOR_DEFAULT_NUM_PUREVIEW_OBJECTS

#define CRIATOMX_MONITOR_DEFAULT_NUM_PUREVIEW_OBJECTS (200)

Default number of preview objects

Description:: Default number of preview objects.

参见: criAtomExMonitor_SetDefaultConfig

◆ CRIATOMX_MONITOR_DEFAULT_COMMUNICATION_BUFFER_SIZE

#define CRIATOMX_MONITOR_DEFAULT_COMMUNICATION_BUFFER_SIZE (2*1024*1024)

Default communication buffer size

Description:: Default communication buffer size.

参见: criAtomExMonitor_SetDefaultConfig

◆ CRIATOMX_MONITOR_DEFAULT_PLAYBACK_POSITION_UPDATE_INTERVAL

#define CRIATOMX_MONITOR_DEFAULT_PLAYBACK_POSITION_UPDATE_INTERVAL (8)

Default playback position update interval

Description:: Default playback position update interval.

参见: criAtomExMonitor_SetDefaultConfig

◆ CRIATOMEX_MONITOR_LOG_MODE_OFF

#define CRIATOMEX_MONITOR_LOG_MODE_OFF (0)

Different types of logs

Description:: Different types of logs available.

参见: 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;\
}

Assign the default values to the configuration structure of the Monitor library

Description:: Assign the default values to the configuration structure of the Monitor library.

参见: CriAtomExMonitorConfig

类型定义说明

◆ CriAtomExMonitorConfig

typedef struct CriAtomExMonitorConfigTag CriAtomExMonitorConfig

Configuration structure used to initialize the Monitor library

Description:: This structure is used to specify the behavior of the Monitor library.
It is passed as an argument to the criAtomExMonitor_Initialize function.

参见: criAtomExMonitor_Initialize, criAtomExMonitor_SetDefaultConfig

◆ CriAtomExMonitorDataUpdateTarget

typedef enum CriAtomExMonitorDataUpdateTargetTag CriAtomExMonitorDataUpdateTarget

Date Update Type

Description:: It is the target of data update by CRI Atom Craft (authoring tool) at in-game preview.

参见: CriAtomExMonitorDataUpdateNotificationInfo

◆ CriAtomExMonitorDataUpdateEvent

typedef enum CriAtomExMonitorDataUpdateEventTag CriAtomExMonitorDataUpdateEvent

Date Update Status

Description:: It is the state of data update by CRI Atom Craft (authoring tool) at in-game preview.

参见: CriAtomExMonitorDataUpdateNotificationInfo

◆ CriAtomExMonitorDataUpdateNotificationInfo

typedef struct CriAtomExMonitorDataUpdateNotificationInfoTag CriAtomExMonitorDataUpdateNotificationInfo

Date Update Info

Description:: It is the infomation of data update by CRI Atom Craft (authoring tool) at in-game preview.

参见: criAtomExMonitor_SetDataUpdateNotificationCallback

枚举类型说明

◆ CriAtomExMonitorDataUpdateTargetTag

enum CriAtomExMonitorDataUpdateTargetTag

Date Update Type

Description:: It is the target of data update by CRI Atom Craft (authoring tool) at in-game preview.

参见: CriAtomExMonitorDataUpdateNotificationInfo

枚举值
CRIATOMEXMONITOR_DATA_UPDATE_TARGET_ACF	ACF Update
CRIATOMEXMONITOR_DATA_UPDATE_TARGET_ACB	ACB Update

◆ CriAtomExMonitorDataUpdateEventTag

enum CriAtomExMonitorDataUpdateEventTag

Date Update Status

Description:: It is the state of data update by CRI Atom Craft (authoring tool) at in-game preview.

参见: CriAtomExMonitorDataUpdateNotificationInfo

枚举值
CRIATOMEXMONITOR_DATA_UPDATE_EVENT_BEGIN	Start Event
CRIATOMEXMONITOR_DATA_UPDATE_EVENT_END	End Event

函数说明

◆ criAtomExMonitor_CalculateWorkSize()

CriSint32 criAtomExMonitor_CalculateWorkSize ( const CriAtomExMonitorConfig * config )

Calculate the size of the work buffer required to initialize the monitoring feature

参数

[in] config configuration structure for initialization

返回: CriSint32 work buffer size

Description:: This function retrieves the size of the work buffer needed to use the monitoring feature.

If the calculation of the size of the work buffer fails, this function returns -1.
The reason why the calculation failed can be determined by checking the error callback message.

Remarks:: The work buffer size needed by the monitoring feature depends on the values of the parameters in the CriAtomExMonitorConfig structure.

If you specify NULL for the argument, the default settings (i.e., the same parameters than when criAtomExMonitor_SetDefaultConfig is used) are used for calculating the size of the work buffer.
The information passed in the config argument is only referenced within the function.
Therefore the memory it uses can be released after executing the function.

参见: criAtomExMonitor_SetDefaultConfig, criAtomExMonitor_Initialize, CriAtomExMonitorConfig

◆ criAtomExMonitor_Initialize()

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

Initialize the monitoring feature

参数

[in]	config	configuration structure for initialization
[in]	work	work buffer
[in]	work_size	work buffer size

Description:: This function initializes the monitoring feature.
Before using the monitoring feature, always execute this function.
(Once this function is executed, the monitoring feature will be available until the criAtomExMonitor_Finalize function is called.)
This function should be called after the criAtomEx_Initialize function and before the criAtomEx_Finalize function.

参见: criAtomExMonitor_Finalize, CriAtomExMonitorConfig

◆ criAtomExMonitor_Finalize()

void criAtomExMonitor_Finalize ( void )

Finalize the monitoring feature

Description:: This function finalizes the monitoring feature.

注意: This function cannot be called before executing the criAtomExMonitor_Initialize function.

参见: criAtomExMonitor_Initialize

◆ criAtomExMonitor_GetServerIpString()

const CriChar8* criAtomExMonitor_GetServerIpString ( void )

Get the server IP address string

Description:: Get the server IP address string.

注意: This function cannot be called before executing the criAtomExMonitor_Initialize function.

参见: criAtomExMonitor_Initialize, criAtomExMonitor_GetClientIpString

◆ criAtomExMonitor_GetClientIpString()

const CriChar8* criAtomExMonitor_GetClientIpString ( void )

Get the client IP address string

Description:: Get the client IP address string.

注意: This function cannot be called before executing the criAtomExMonitor_Initialize function.

参见: criAtomExMonitor_Initialize, criAtomExMonitor_GetServerIpString

◆ criAtomExMonitor_IsConnected()

CriBool criAtomExMonitor_IsConnected ( void )

Get the tool connection status

返回: CriBool connection status (CRI_TRUE: connected, CRI_FALSE: not connected)

Description:: Determines if the tool is connected or not.

注意: This function cannot be called before executing the criAtomExMonitor_Initialize function.

参见: criAtomExMonitor_Initialize

◆ criAtomExMonitor_SetLogCallback()

void criAtomExMonitor_SetLogCallback	(	CriAtomExMonitorLogCbFunc	cbf,
		void *	obj
	)

Register the log retrieval callback function

参数

cbf	callback function
obj	user specified object

Description:: Registers a callback function for getting log.
The log retrieval process is started by registering a callback function and stopped by setting it to NULL.
To change the log mode, call the criAtomExMonitor_SetLogMode function.

注意: This function cannot be called before executing the criAtomExMonitor_Initialize function.

参见: criAtomExMonitor_Initialize, criAtomExMonitor_SetLogMode

◆ criAtomExMonitor_SetLogMode()

void criAtomExMonitor_SetLogMode ( CriUint32 mode )

Specify log mode

参数

mode	Log output mode

Description:: Specify the log retrieval mode.
The log retrieval callback function (registered by the criAtomExMonitor_SetLogCallback function) will be called depending on the mode specified by this function.

参见: criAtomExMonitor_SetLogCallback

◆ criAtomExMonitor_OutputUserLog()

void criAtomExMonitor_OutputUserLog ( const CriChar8 * message )

User log output

参数

message User log message

Description:: Outputs the user log.
The log output can be obtained and displayed by using a log acquisition callback or profiler.

参见: criAtomExMonitor_SetLogCallback

◆ criAtomExMonitor_SetDataUpdateNotificationCallback()

void criAtomExMonitor_SetDataUpdateNotificationCallback	(	CriAtomExMonitorDataUpdateNotificationCbFunc	func,
		void *	obj
	)

Set data update notification callback function

参数

[in]	func	Data update notification callback function
[in]	obj	user specified object

Description:: Register a callback function to be called when data update processing from the authoring tool occurs during in-game preview.

注意: Please do not use the Atom API within the callback function.
The callback function is also executed from server processing in the AtomMonitor library.
Therefore, if you execute an API that does not consider interrupts to server processing, errors may occur or deadlock may occur.

If you block long processing within the callback function, problems such as out of sound will occur, so please be careful.

Only one callback function can be registered.
If you perform a registration operation more than once, the already registered callback function will be overwritten by the callback function registered later.

Registering registered functions can be canceled by specifying NULL for func.; This function can not be executed before the criAtomExMonitor_Initialize function is executed.

参见: CriAtomExMonitorDataUpdateNotificationCbFunc, CriAtomExMonitorDataUpdateNotificationInfo

结构体

宏定义

类型定义

枚举

函数

详细描述

宏定义说明

◆ CRIATOMX_MONITOR_DEFAULT_NUM_PUREVIEW_OBJECTS

◆ CRIATOMX_MONITOR_DEFAULT_COMMUNICATION_BUFFER_SIZE

◆ CRIATOMX_MONITOR_DEFAULT_PLAYBACK_POSITION_UPDATE_INTERVAL

◆ CRIATOMEX_MONITOR_LOG_MODE_OFF

◆ criAtomExMonitor_SetDefaultConfig

类型定义说明

◆ CriAtomExMonitorConfig

◆ CriAtomExMonitorDataUpdateTarget

◆ CriAtomExMonitorDataUpdateEvent

◆ CriAtomExMonitorDataUpdateNotificationInfo

枚举类型说明

◆ CriAtomExMonitorDataUpdateTargetTag

◆ CriAtomExMonitorDataUpdateEventTag

函数说明

◆ criAtomExMonitor_CalculateWorkSize()

◆ criAtomExMonitor_Initialize()

◆ criAtomExMonitor_Finalize()

◆ criAtomExMonitor_GetServerIpString()

◆ criAtomExMonitor_GetClientIpString()

◆ criAtomExMonitor_IsConnected()

◆ criAtomExMonitor_SetLogCallback()

◆ criAtomExMonitor_SetLogMode()

◆ criAtomExMonitor_OutputUserLog()

◆ criAtomExMonitor_SetDataUpdateNotificationCallback()