Skip to main content

Convert Image

Converts an image from one format to another using the ImageMagick library.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • In Path - Path to the input image file.
  • Out Path - Path where the converted output image will be saved. The file extension determines the output format.

Options​

This node does not have any configurable options.

Output​

  • result - Boolean indicating success or failure of the conversion operation.

How It Works​

The Convert Image node uses ImageMagick library to convert images between different formats. When executed, the node:

  1. Validates input and output file paths
  2. Loads the specified input image
  3. Automatically detects the desired output format based on the file extension of the output path
  4. Converts the image to the target format
  5. Saves the converted image to the output path

Requirements​

  • Valid input image file at the specified path
  • Output path must be writable
  • Supported image format for both input and output

Error Handling​

The node will return specific errors in the following cases:

  • Empty or invalid input file path
  • Input file not found at the specified path
  • Empty or invalid output file path

Usage Notes​

  • The output format is determined by the file extension in the Out Path:
    • .jpg or .jpeg for JPEG format
    • .png for PNG format
    • .gif for GIF format
    • .bmp for BMP format
    • .tiff or .tif for TIFF format
    • And many other supported formats
  • ImageMagick supports over 100 major image formats
  • Quality settings for compressed formats (like JPEG) are automatically determined
  • Metadata may be preserved or stripped depending on the target format
  • Color profiles and other image properties are maintained during conversion when possible
  • Processing time depends on image size and complexity