Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » Image » Image IO » SaveImageToJpeg_Asynchronous

SaveImageToJpeg_Asynchronous


Module: FoundationLite

Saves an image to a JPEG file in the background thread.

Name Type Range Description
inThreadQueueSize Integer 1 - Number of incoming frames that can be buffered before the thread is able to process them
inImage Image An image to be saved
inFile File Path to a file
inQuality Integer* 0 - 100 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

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Not supported inImage pixel format in SaveImageToJpeg_Asynchronous.

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of SaveImage filter group.

See Also

  • LoadImage – Loads a single image from a file.