FormatCallback

Overview

Related Modules:

Format

Description:

Defines listener callbacks for the format.

Summary

Data Fields

Variable Name

Description

privateDataHandle

CALLBACK_HANDLE 

OnError )(CALLBACK_HANDLEprivateDataHandle, int32_t errorType, int32_t errorCode)

int32_t( 

Called when a format error occurs during capturing. This callback is used to report the errors.

OnInfo )(CALLBACK_HANDLEprivateDataHandle, int32_t type, int32_t extra)

int32_t( 

Called when an information event occurs during capturing. This callback is used to report capturing information.

Details

Field Documentation

OnError

  1. int32_t(*FormatCallback::OnError)([CALLBACK_HANDLE]($api-api-SmartVision-Devices-Format.md#gab928f39c359734527bda3fd160f89331) [privateDataHandle]($api-api-SmartVision-Devices-FormatCallback.md#a4e4c7c6789cbf8bfc1aa0444dcd106b5), int32_t errorType, int32_t errorCode)

Description:

Called when a format error occurs during capturing. This callback is used to report the errors.

Parameters:

Name

Description

privateDataHandleIndicates the private data handle.
errorTypeIndicates the error type. For details, see FormatErrorType.
errorCodeIndicates the error code.

Returns:

Returns 0 if the operation is successful; returns a non-zero value otherwise.

OnInfo

  1. int32_t(*FormatCallback::OnInfo)([CALLBACK_HANDLE]($api-api-SmartVision-Devices-Format.md#gab928f39c359734527bda3fd160f89331) [privateDataHandle]($api-api-SmartVision-Devices-FormatCallback.md#a4e4c7c6789cbf8bfc1aa0444dcd106b5), int32_t type, int32_t extra)

Description:

Called when an information event occurs during capturing. This callback is used to report capturing information.

Parameters:

Name

Description

privateDataHandleIndicates the private data handle.
typeIndicates the information type. For details, see FormatInfoType.
extraIndicates other information, for example, the start time position of the captured file.

Returns:

Returns 0 if the operation is successful; returns a non-zero value otherwise.

privateDataHandle

  1. [CALLBACK_HANDLE]($api-api-SmartVision-Devices-Format.md#gab928f39c359734527bda3fd160f89331) FormatCallback::privateDataHandle

Description:

Private data handle