1. Media processing

Create a processing task

A processing task is a step within a processing flow. You can configure the output of a processing task to be an entity rendition. To do this, enable the Store output feature for a task and create rendition links.

To create a processing task:

  1. On the menu bar, click Manage .
  2. On the Manage page, click Media processing.
  3. On the Media processing page, select a processing set, then click the flow where you want to add a task.
  4. On the visual canvas, on the node of the flow you want to add the task to, click .
  5. In the right-hand pane, select a task type.
  6. On the Parameters tab, fill out the task parameters.
  7. Click Save task.

Task parameters

You can use the following task parameters.

Store file

ParameterDescriptionMandatory
NameName of the task.No
Content typeContentType/MimeType for the output file.No
Content dispositionDefines whether the file is an attachment or provided inline.Yes

Convert image

Note

You cannot upscale or enlarge images. This is to minimize unnecessary processing and to ensure there is not a reduction in image quality, such as blurriness or stretching.

ParameterDescriptionMandatory
NameName of the task. This must match the output name on the Outputs tab.No
Content typeContentType/MimeType for the output file.No
Content dispositionDefines whether the file is an attachment or provided inline.Yes
Resize optionMethod used to resize images.Yes
Target extensionFile extension of resulting output.No
Width (px)Width of the output image.No. Parameter not available if Resize option is None.
Height (px)Height of the output image.No. Parameter not available if Resize option is None.
Resize algorithmAlgorithm used for cropping. The available algorithms are:

  • Four corners (default) - examines the color of the pixel in each corner of the image. If all corner pixels are the same color, the image is identified as a logo.
  • Histogram - builds a histogram of all the pixel colors in the image. Based on criteria such as sharp peaks, dominant peaks, or color omission, the image might be identified as a logo.
  • Smart - uses the entropy cropping of the NetVips library. It tries to automatically find the point-of-interest of the image.
  • Center - crops the image according to the Height and Width parameters, and uses the middle of the image as its focus point.
Note

If an image is identified as a logo, the contents of the image are reduced to 75% of their original size, while the overall size of the image remains the same. This results in an empty border around the original image, which is then filled with the color detected at all four corners of the original.

Yes. Parameter only available if Resize option is Resize for crop.
Color profileColor profile applied on the output image.Yes
Color spaceColor space applied on the output image.Yes. Parameter only available if Color profile is None.
DensityDPI used for the output image.Yes
Multi-pageDetermines whether renditions should be created for all pages of the file, or only the first.No
Clipping pathName of the clipping path you want to crop the image to.No
Embedded preview prioritiesAn ordered, comma-separated list of previews. The processing agent checks for availability of these previews in the RAW file metadata. If a preview is available, the agent applies default image conversion to it to generate the target image. If none of the listed previews are available, the agent applies default image conversion to the original image instead.No

The following is an example of RAW file metadata extracted with the Exiftool command exiftool -preview:all image:


exiftool -preview:all RAW_CANON_EOS_5DMARK3.CR2
Preview Image          : (Binary data 3192436 bytes, use -b option to extract)
Thumbnail Image         : (Binary data 18733 bytes, use -b option to extract)

To add these previews to the Embedded preview priorities field, remove the spaces in the names. For example write PreviewImage or ThumbnailImage.

Convert video

ParameterDescriptionMandatory
NameName of the task.No
Content typeContentType/MimeType for the output file.No
Content dispositionDefines whether the file is an attachment or provided inline.Yes
SeekThe time point in a video from which the rendition starts. For example, with a value of 5, the output file starts at the fifth second of original file.No
LengthDuration of the output file in seconds.No
Number of preview framesMaximum number of frames extracted from the video for preview creation.No
Target extensionFile extension of resulting output.No
Width (px)Width of the output image.No
Height (px)Height of the output image.No
Bitrate (% from original)Defines the quality of the rendition based on the original file.

Behavior of the Bitrate (% from original) parameter:

  • The value of this parameter can range from 1 to 100. If an invalid value is used, this parameter will default to 30.
  • The default value, based on YouTube's 360p recommended minimum (1 Mbps videostream, 96khz audiostream) serves as minimum quality parameters. If the calculated target bitrate is lower, the default bitrate is used.
  • To prevent upscaling, if the calculated target bitrate is higher than the original, that original bitrate is applied instead.

Convert document

Note

You cannot convert documents to images directly. You must first convert the document to a PDF and then convert the PDF to an image.

ParameterDescriptionMandatory
NameName of the task.No
Content typeContentType/MimeType for the output file.No
Content dispositionDefines whether the file is an attachment or provided inline.Yes
Multi-pageDetermines whether renditions should be created for all pages of the file, or only the first.No
Low resolutionDefines whether the output file uses compression methods to reduce the file size.No
Extract contentDetermines whether text content is extracted from supported files and added to the search index, making document content searchable. Enable this option only if document content needs to be indexed and searchable, as content extraction can increase the amount of indexed data.

There is no file size or page limit for PDF or Word document extraction. Extracted content, however, must not exceed 5 million characters or 800-1000 pages of standard text (depending on the document format and structure).
Note

As content approaches the defined limits, performance might be impacted because search indexing processes the full text. This can result in longer indexing times and slower search queries, depending on the environment and usage. The impact on storage from extracted content, however, is minimal.

No

Convert HTML

ParameterDescriptionMandatory
NameName of the task.No
Content typeContentType/MimeType for the output file.No
Content dispositionDefines whether the file is an attachment or provided inline.Yes

The HTML media processor only renders the text without applying layouts on it. It also does not render images referenced in the HTML or use the CSS to style the HTML. Thus, the preview you see on the asset details page might differ from how you see the HTML asset in a web browser.

Create storyboard

ParameterDescriptionMandatory
NameName of the task.No
Content typeContentType/MimeType for the output file.No
Content dispositionDefines whether the file is an attachment or provided inline.Yes
Target extensionFile extension of resulting output.No
Seekbar thumbnail - WidthWidth of the thumbnail when seeking in a video.Yes
Seekbar thumbnail - HeightHeight of the thumbnail when seeking in a video.Yes
Seekbar thumbnail - AmountAmount of frames used for seeking in a video.Yes
Story thumbnail - WidthWidth of the thumbnail for the storyboard rendition.Yes
Story thumbnail - HeightHeight of the thumbnail for the storyboard rendition.Yes
Story thumbnail - AmountAmount of frames used for the storyboard rendition.Yes

Extract clipping paths

ParameterDescriptionMandatory
NameName of the task.No

Extract image embeddings

ParameterDescriptionMandatory
NameName of the task.No

This task is automatically added to the Media processing flow when you enable visual search. It generates embeddings renditions that are used by the AI-assisted visual search feature to find visually similar images. This task has no configurable parameters and is required for visual search to work properly.

Extract metadata

ParameterDescriptionMandatory
NameName of the task.No
Content dispositionDefines whether the file is an attachment or provided inline.Yes

Extract vision data

ParameterDescriptionMandatory
NameName of the task.
Warning

We recommend you do not change the name of the task. Use the default vision task name analysis.

No
Content typeContentType/MimeType for the output file.No
Content dispositionDefines whether the file is an attachment or provided inline.Yes
EndpointSend a request to either the OCR endpoint for text recognition both to the Analyze endpoint for image features recognition.Yes
Detect orientationDefines whether the OCR feature detect the orientation of text.No
Minimum confidenceDetermines the minimum accuracy level of the analysis (default value: 0.5).
Note

Changing the minimum confidence level only affects analysis performed after the change; it has no effect on previous analysis.

Yes
FeaturesFeatures to extract.No
DetailsTypes of content to analyze.No

Extract video indexer data

ParameterDescriptionMandatory
NameName of the task.No
Content typeContentType/MimeType for the output file.No
Content dispositionDefines whether the file is an attachment or provided inline.Yes
Image formatOutput format for the storyboard and face renditions.No
Thumbnail heightHeight for the face thumbnail renditions.Yes
Thumbnail widthWidth for the face thumbnail renditions.Yes
Key frame heightHeight for the key frame renditions.Yes
Key frame widthWidth for the key frame renditions.Yes

Run external web task

ParameterDescriptionMandatory
NameName of the task.No
Content typeContentType/MimeType for the output file.No
Content dispositionDefines whether the file is an attachment or provided inline.Yes
URLURL of the external task.No
HeadersJSON containing web request headers.No
ParametersJSON containing web request parameters.No
If you have suggestions for improving this article, let us know!