|
eGrabber Recorder Reference
24.04.0.8
|
Typedefs | |
| typedef int | RECORDER_STATUS |
| typedef struct Euresys::EGrabberRecorder::S_RECORDER_BUFFER_INFO | RECORDER_BUFFER_INFO |
| typedef void * | RECORDER_HANDLE |
| typedef unsigned int | RECORDER_PARAMETER |
| typedef unsigned int | RECORDER_OPEN_MODE |
| typedef unsigned int | RECORDER_CLOSE_MODE |
| typedef unsigned int | RECORDER_PROGRESS_STATE |
| typedef int(* | RECORDER_PROGRESS_CALLBACK) (void *context, RECORDER_PROGRESS_STATE state, size_t index, size_t count) |
| typedef int64_t | RECORDER_BAYER_DECODING_METHOD |
Functions | |
| RECORDER_API | RecorderInitLib () |
| Open the Recorder library. More... | |
| RECORDER_API | RecorderCloseLib () |
| Close the Recorder library. More... | |
| RECORDER_API | RecorderOpen (const char *path, RECORDER_OPEN_MODE mode, RECORDER_HANDLE *handle, uint32_t *fileVersion) |
| Open a recorder object. More... | |
| RECORDER_API | RecorderClose (RECORDER_HANDLE handle, RECORDER_CLOSE_MODE mode) |
| Close a recorder object. More... | |
| RECORDER_API | RecorderSetParameterString (RECORDER_HANDLE handle, RECORDER_PARAMETER parameter, const char *value) |
| Set a recorder object parameter string value. More... | |
| RECORDER_API | RecorderGetParameterString (RECORDER_HANDLE handle, RECORDER_PARAMETER parameter, char *value, size_t *size) |
| Get a recorder object parameter string value. More... | |
| RECORDER_API | RecorderSetParameterInteger (RECORDER_HANDLE handle, RECORDER_PARAMETER parameter, int64_t value) |
| Set a recorder object parameter integer value. More... | |
| RECORDER_API | RecorderGetParameterInteger (RECORDER_HANDLE handle, RECORDER_PARAMETER parameter, int64_t *value) |
| Get a recorder object parameter integer value. More... | |
| RECORDER_API | RecorderRead (RECORDER_HANDLE handle, RECORDER_BUFFER_INFO *info, void *buffer, size_t *bufferSize, void *reserved) |
| Read the record at the current index position from a recorder container opened in read mode. More... | |
| RECORDER_API | RecorderWrite (RECORDER_HANDLE handle, const RECORDER_BUFFER_INFO *info, const void *buffer, void *reserved1, void *reserved2, void *reserved3) |
| Write buffer info and data to a recorder container opened in write or append mode. More... | |
| RECORDER_API | RecorderExport (RECORDER_HANDLE handle, const char *path, size_t *count, uint32_t exportPixelFormat, unsigned int reserved, RECORDER_PROGRESS_CALLBACK progressCallback, void *progressContext) |
| Export a range of recorded images to files. More... | |
| RECORDER_API | RecorderStartChapter (RECORDER_HANDLE handle, const char *name, const char *info) |
| Start a new chapter. More... | |
| struct Euresys::EGrabberRecorder::S_RECORDER_BUFFER_INFO |
| typedef int RECORDER_STATUS |
| typedef void* RECORDER_HANDLE |
| typedef unsigned int RECORDER_PARAMETER |
| typedef unsigned int RECORDER_OPEN_MODE |
| typedef unsigned int RECORDER_CLOSE_MODE |
| typedef unsigned int RECORDER_PROGRESS_STATE |
| typedef int(* RECORDER_PROGRESS_CALLBACK) (void *context, RECORDER_PROGRESS_STATE state, size_t index, size_t count) |
| typedef int64_t RECORDER_BAYER_DECODING_METHOD |
| enum RECORDER_STATUS_LIST |
| Enumerator | |
|---|---|
| RECORDER_STATUS_OK | The operation completed successfully. |
| RECORDER_STATUS_NOT_INITIALIZED | The recorder library is not initialized. |
| RECORDER_STATUS_UNKNOWN_ERROR | An unknown error has occurred. |
| RECORDER_STATUS_UNKNOWN_PARAMETER | The recorder parameter is unknown. |
| RECORDER_STATUS_INVALID_PARAMETER_TYPE | The recorder parameter type is invalid. |
| RECORDER_STATUS_INVALID_PARAMETER_VALUE | The recorder parameter value is invalid. |
| RECORDER_STATUS_BUFFER_TOO_SMALL | The destination buffer is too small. |
| RECORDER_STATUS_PARAMETER_IS_READ_ONLY | The recorder parameter is read-only. |
| RECORDER_STATUS_SYSTEM_ERROR | A system error has occurred. |
| RECORDER_STATUS_INVALID_CONTAINER_PATH | The specified container path is invalid. |
| RECORDER_STATUS_DATA_FILE_FULL | The container data file is full. |
| RECORDER_STATUS_OPERATION_NOT_ALLOWED | The operation is not allowed by the recorder open mode. |
| RECORDER_STATUS_INDEX_OUT_OF_RANGE | The RECORDER_PARAMETER_RECORD_INDEX value is out of range. |
| RECORDER_STATUS_INVALID_INDEX_DATA | The internal meta-data of the current record is invalid (partial read) |
| RECORDER_STATUS_INVALID_INDEX_SIZE | The internal meta-data size of the container is invalid (partial read or invalid meta-data file size) |
| RECORDER_STATUS_UNSUPPORTED_DATABASE_VERSION | The given container is not supported by the recorder library. |
| RECORDER_STATUS_INVALID_INDEX_HEADER | The internal meta-data header of the container is invalid. |
| RECORDER_STATUS_INVALID_LENGTH_WRITTEN | Some data was not completely written to disk (partial write) |
| RECORDER_STATUS_INVALID_HANDLE | The record handle is invalid. |
| RECORDER_STATUS_RESOURCE_IN_USE | The resource is already in use. |
| RECORDER_STATUS_END_OF_DATA | There is no more record to read in the container. |
| RECORDER_STATUS_NO_CONTAINER | The path does not contain a container and read only access is required. |
| RECORDER_STATUS_INVALID_ARGUMENT | A given argument is invalid. |
| RECORDER_STATUS_LICENSE_MANAGER_ERROR | An error occurred in the licenser manager, please contact Euresys support. |
| RECORDER_STATUS_NO_LICENSE | There is no valid license for this library, please contact Euresys support. |
| RECORDER_STATUS_IMAGE_CONVERSION_ERROR | An image conversion error has occurred. |
| RECORDER_STATUS_UNSUPPORTED_IMAGE_FORMAT | The image format is not supported by the export file. |
| RECORDER_STATUS_ABORTED | The current operation has been aborted by the user. |
| RECORDER_STATUS_INVALID_DATA_SIZE | A read operation returned an invalid size (partial read or invalid data file size) |
| RECORDER_STATUS_INVALID_CHAPTER_CHARACTER | The chapter name has an invalid character. |
| RECORDER_STATUS_RESERVED_CHAPTER_NAME | The chapter name conflicts with a reserved name. |
| RECORDER_STATUS_CHAPTER_NAME_ALREADY_USED | The chapter name is already used. |
| RECORDER_STATUS_CHAPTER_NAME_TOO_LONG | The chapter name is too long. |