Back to Aurora Vision Library Lite website
You are here: Start » Image » Image IO » SaveImageToJpeg_Asynchronous
SaveImageToJpeg_Asynchronous
Header: | AVL.h |
---|---|
Namespace: | avl |
Saves an image to a JPEG file in the background thread.
Syntax
void avl::SaveImageToJpeg_Asynchronous ( SaveImageState& ioState, int inThreadQueueSize, const avl::Image& inImage, const atl::File& inFile, atl::Optional<int> inQuality, bool inIgnoreErrors )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
ioState | SaveImageState& | Object used to maintain state of the function. | |||
inThreadQueueSize | int | 1 - | 3 | Number of incoming frames that can be buffered before the thread is able to process them | |
inImage | const Image& | An image to be saved | |||
inFile | const File& | Path to a file | |||
inQuality | Optional<int> | 0 - 100 | NIL | Quality | |
inIgnoreErrors | bool | If false the error will be reported as soon as the filter instance is again executed |
Requirements
For input inImage only pixel formats are supported: uint8, uint16.
Read more about pixel formats in Image documentation.
Remarks
This filter is executed in the background thread. Execution errors may be reported with a delay or ignored. Stopping of the program may be delayed, because of waiting for background work to complete.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Not supported inImage pixel format in SaveImageToJpeg_Asynchronous. Supported formats: UInt8, UInt16. |