ImageMagick
PROPERTIES
| Name | ImageMagick |
| System ID | IM |
| Connection String | http://ImageMagicHostIP:8081/imagemagick/services/ImageMagickWebService |
| Heartbeat Connection String | http://ImageMagicHostIP:8081/imagemagick/services/ImageMagickWebService |
SUPPORTED NODE
DEFINITIONS
* Indicates the message has been deprecated. Please use the replacement message(s) instead.
NODE DEFINITION
DETAILS
Message is used to convert an image to image of another format.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| outputImageFilePath | NO | File Path of the converted image. |
| inputImageFilePath | NO | File Path of the image to convert. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| error-message | Error message indicating the reason for failure to convert image. |
Message is used to crop an image.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| inputImageFilePath | NO | File Path of the image to crop. |
| cropHeight | NO | Height to crop to. |
| cropWidth | NO | Width to crop to. |
| outputImageFilePath | NO | File Path of the cropped image. |
| cropX | NO | X-coordinate for cropping. Example: +10. |
| cropY | NO | Y-coordinate for cropping. Example: +10. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| error-message | Error message indicating the reason for failure to crop image. |
message to execute any complex command line operation
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| profile | NO | Name of the profile(excluding extension) which is typically deployed under /opt/tandbergtv/cms/imagemagick/profile. |
| placeholder2 | NO | Value for placeholder defined in profile. |
| placeholder3 | NO | Value for placeholder defined in profile. |
| placeholder4 | NO | Value for placeholder defined in profile. |
| placeholder5 | NO | Value for placeholder defined in profile. |
| placeholder1 | NO | Value for placeholder defined in profile. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| error-message | Error message indicating the reason for failure to execute profile. |
Message is used to get image properties.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| inputImageFilePath | NO | Image full path. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| error-message | Error message indicating the reason for failure to get image properties. |
| imageChecksum | Image checksum. |
| imageFileFormat | Image file format. |
| imageHeight | Image height. |
| imageLastModifyTime | Image last modify time. |
| imageSize | Image size. |
| imageWidth | Image width. |
Message is used to get properties of multiple images.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| inputImageFilePaths | NO | A List string with XML format about images full path. e.g. <list><string>⁄imagefolder⁄img1.jpg<⁄string><string>⁄imagefolder⁄img2.jpg<⁄string><⁄list> |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| imagesProperties | A List string with XML format about images properties. For each image, it includes property inputImageFilePath, imageSize, imageWidth, imageHeight, imageChecksum, imageFileFormat and imageLastModifyTime. |
Message is used to merge/superimpose an image onto another image.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| inputImageFilePath | NO | File Path of the main image to merge into. |
| mergeGravity | NO | Gravity of merging image vis-à-vis the main image. |
| mergeImageFilePath | NO | File path of the image to merge or superimpose. |
| mergeOffSet | NO | Offset of the merging image from the boundary specified by the “MergeGravity” above, in the format +x+y. For example, if “MergeGravity” is “NorthEast” and “MergeOffset” is +10+10, the merging image would be superimposed upon the main image in the NorthEast corner of the main image with merging image’s top-right corner 10 pixels away from the main image’s top and right borders respectively |
| outputImageFilePath | NO | File Path of the merged image. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| error-message | Error message indicating the reason for failure to merge images. |
Message is used to process an image, e.g., convert an image to image of another format, size, etc.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| cropHeight | NO | Height to crop to. |
| cropWidth | NO | Width to crop to. |
| cropX | NO | X-coordinate for cropping. Example: +10. |
| cropY | NO | Y-coordinate for cropping. Example: +10. |
| inputImageFilePath | NO | File Path of the image to process. |
| outputImageFilePath | NO | File Path of the processed image. |
| resizeHeight | NO | Resize to the given height. |
| resizeWidth | NO | Resize to the given width. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| error-message | Error message indicating the reason for failure to process image. |
Message is used to resize an image. It is attempted to maintain original proportions of the image while resizing.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| forceResize | NO | Forces resize to given dimensions and ignore original image proportions. Allowed values: TRUE and FALSE. |
| inputImageFilePath | NO | File Path of the image to resize. |
| outputImageFilePath | NO | File Path of the resized image. |
| resizeHeight | NO | Resize to the given height. |
| resizeWidth | NO | Resize to the given width. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| error-message | Error message indicating the reason for failure to resize image. |
| imageLastModifyTime | Image last modify time. |
Message is used to resize multiple images.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| imagesToResize | NO | A List string with XML format about images to resize, including entry inputImageFilePath, outputImageFilePath, forceResize, resizeWidth and resizeHeight. e.g.<list><map><entry><string>inputImageFilePath<⁄string><string>⁄imgfolder⁄img.jpg<⁄string><⁄entry><entry><string>forceResize<⁄string><string>true<⁄string><⁄entry><entry><string>resizeWidth<⁄string><string>40<⁄string><⁄entry><entry><string>outputImageFilePath<⁄string><string>⁄outputfolder⁄output1.jpg<⁄string><⁄entry><entry><string>resizeHeight<⁄string><string>40<⁄string><⁄entry><⁄map><⁄list> |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| imagesLastModifyTime | A List string with XML format about images last modify time. |
message to watermark an image on top of an image. Additional watermark paramaters can be specfied in a profile properties file
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| inputImageFilePath | NO | Linux path of the input file. |
| imageFilePath | NO | Linux path of the image which needs to be watermarked. |
| outputImageFilePath | NO | Linux path of the output file. |
| profile | NO | Name of the profile(exluding extension) which is typically deployed under /opt/tandbergtv/cms/imagemagick/profile. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| error-message | Error message indicating the reason for failure to watermark images. |
message to watermark any text on top of an image. Additional watermark paramaters can be specfied in a profile properties file
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| inputImageFilePath | NO | Linux path of the input file. |
| outputImageFilePath | NO | Linux path of the output file. |
| profile | NO | Name of the profile(exluding extension) which is typically deployed under /opt/tandbergtv/cms/imagemagick/profile. |
| text | NO | Linux path of the image which needs to be watermarked. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| error-message | Error message indicating the reason for failure to watermark text. |
Message is used to combine/montage mutliple images into sprite images.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| fileFilter | NO | The name of images under the inputImageFolderPath matches the fileFilter(wildcard) would be input images to combine, e.g. thumbnail-* or *.jpg |
| geometry | NO | Dimension of the individual image in the combined images, e.g 320x180 |
| inputImageFolderPath | NO | Folder path of the input images, e.g. /content/data/ |
| qualityLevel | NO | The quality level of the combined images to generate. Users can specify one of the three quality levels: low, medium, and high. If users don't specify it, it would be high quality level by default. |
| gridSize | NO | Grid size of the combined images, {width}x{height}. Supported maximum product of width and height is 256, e.g 16x16. |
| outputImageFilePath | NO | File path of the combined image. e.g. /content/data/combined_image.jpg. The file name of output images would be combined_image0.jpg, combined_image1.jpg... |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Response to the asynchronous Combine Multiple Images call indicating completion of the operation
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| outputImageFileList | File path list of the generated combined images |
| error-message | Error message indicating the reason for failure to combine multiple images. |
Combine multiple images. The request is made and an asynchronous response is received on completion.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| inputImageFolderPath | NO | Folder path of the input images, e.g. /content/data/ |
| fileFilter | NO | The name of images under the inputImageFolderPath matches the fileFilter(wildcard) would be input images to combine, e.g. thumbnail-* or *.jpg |
| gridSize | NO | Grid size of the combined images, {width}x{height}. Supported maximum product of width and height is 256, e.g 16x16. |
| geometry | NO | Dimension of the individual image in the combined images, e.g 320x180 |
| qualityLevel | NO | The quality level of the combined images to generate. Users can specify one of the three quality levels: low, medium, and high. If users don't specify it, it would be high quality level by default. |
| outputImageFilePath | NO | File path of the combined image. e.g. /content/data/combined_image.jpg. The file name of output images would be combined_image0.jpg, combined_image1.jpg... |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| outputImageFileList | File path list of the generated combined images |
| error-message | Error message indicating the reason for failure to combine multiple images. |
| © 2002 - 2020 Ericsson Television Inc. |
| All Rights Reserved. |