Conversion matrix structure

The media matrix is a JSON array composed of a JSON configuration for each of its processing flows. Each flow has the following structure:

 {
  "name": "FlowName",
  "priority": 100,
  "extensions": [
   "extension_1",
   "extension_2"
  ],
  "flow": {
   "tasks": {
     ...
    }
  },
  "output": {
   "location": "local",
   "renditions": {
    ...
   }
  }
 }

The following table describes the parameters of this JSON:

Parameter	Type	Description
`name`	String	Processing flow name.
`priority`	Integer	Priority of the processing flow.
`extensions`	Array of strings	Array of file types to which the flow applies.
`flow`	List	List of tasks.
`tasks`	List	List of JSON-formatted processing tasks.
`output`	List	Configuration parameters of the output file.
`location`	String	Location for the output.
`renditions`	List	List of JSON-formatted rendition links.

Processing task parameters

The tasks parameter contained in flow is a list of task objects, each following the structure:

"[task_name]": {
 "property_1": value_1,
 "property_2": value_2,
 ...
}

where [task_name] is the name of the processing task and the valid properties, listed on the following tabs, depend on the task type.

Store file

Parameter	Type	Description
`contentdisposition`	String	Defines whether the file is an attachment or provided inline.
`contenttype`	String	ContentType/MimeType for the output file.
`input`	String	Name of the property where the source file key is found.
`output`	String	Name of the property to which the output file key is saved.
`outputfileprovider`	String	The name of the file provider where the output file is saved.
`type`	String	Task type.

Convert image

Parameter	Type	Description
`clippingpath`	String	Name of an embedded clipping path from an 8BIM image profile when more than one path is available. This applies the conversion to the selected pixels under the specified path only. If a clipping path is set, the extra conversion parameters are ignored.
`colorprofile`	String	Color profile applied to the output image.
`colorspace`	String	Color space applied to the output image.
`contentdisposition`	String	Defines whether the file is an attachment or provided inline.
`contenttype`	String	ContentType/MimeType for the output file.
`conversionparameterorder`	List	Order in which the ImageMagick parameters occur.
`conversionparameters`	String	Additional ImageMagick parameters to use in a command.
`cropping`	String	Linked to `imageresizeoptions` parameter.
`density`	Integer	DPI used for the output image. Parameter required with ImageMagick.
`embeddedpreviewpriorities`	String	An 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.
`height`	Integer	Height of the output image when resizing.
`imagemagickexecutabletimeout`	Integer	Period, in seconds, after which ImageMagick times out. The maximum permitted time-out for ImageMagick is 120 seconds.
`imagemagickidentifyexecutabletimeout`	Integer	Period, in seconds, after which the Identify application within ImageMagick times out.
`imageresizeoption`	String	Method use to resize images.
`input`	String	Name of the property where the source file key is found.
`jpegcompression`	Integer	Quality level of conversion when the output is a JPEG file.
`keepbackgroundtransparency`	Boolean	Determines whether existing transparency should be kept or when converting PDF to PNG.
`multipage`	Boolean	Defines whether only the first page or multiple pages of the file should have its renditions created.
`output`	String	Name of the property to which the output file key is saved.
`outputfileprovider`	String	The name of the file provider where the output file is saved.
`resizealgorithm`	String	Algorithm use for cropping.
`resizeforcropbehavior`	String	Linked to `imageresizeoptions` parameter. Defines whether the image needs cropping or simple scaling.
`resizelogoscalefactor`	Double	Linked to `imageresizeoptions` parameter.
`targetextension`	String	Extension of the output file.
`type`	String	Task type.
`width`	Integer	Width of the output image when resizing.

Convert video

Parameter	Type	Description
`bitratepercentage`	Integer	Defines the quality of the rendition based on the original file.
`contentdisposition`	String	Defines whether the file is an attachment or provided inline.
`contenttype`	String	ContentType/MimeType for the output file.
`conversionparameters`	String	Additional ImageMagick parameters to use in a command.
`height`	Integer	Height of the output video when resizing.
`input`	String	Name of the property where the source file key is found.
`length`	Integer	Duration of the output file, in seconds.
`output`	String	Name of the property to which the output file key is saved.
`outputfileprovider`	String	The name of the file provider where the output file is saved.
`numberofpreviewframes`	Integer	The maximum number of frames from the video to use in the preview.
`seek`	Timecode	The time point in the video from which the rendition starts. For example, with a value of 5 the output file starts at the fifth second of the original file.
`targetextension`	String	Extension of the output file.
`trimend`	Timecode	Specific end point of a video you wish to extract (used for clipping feature).
`trimstart`	Timecode	Specific start point in a video you wish to extract (used for clipping feature).
`type`	String	Task type.
`width`	Integer	Width of the output video when resizing.

Convert document

Parameter	Type	Description
`contentdisposition`	String	Defines whether the file is an attachment or provided inline.
`contenttype`	String	ContentType/MimeType for the output file.
`extractcontent`	Boolean	Determines whether to use text from the document for full-text searches.
`input`	String	Name of the property where the source file key is found.
`lowres`	Boolean	Defines whether the output file uses compression methods to reduce the file size.
`output`	String	Name of the property to which the output file key is saved.
`outputfileprovider`	String	The name of the file provider where the output file is saved.
`multipage`	Boolean	Defines whether only the first page or multiple pages of the file should have its renditions created.
`type`	String	Task type.

Convert HTML

Parameter	Type	Description
`contenttype`	String	ContentType/MimeType for the output file.
`contentdisposition`	String	Defines whether the file is an attachment or provided inline.
`input`	String	Name of the property where the source file key is found.
`output`	String	Name of the property to which the output file key is saved.
`outputfileprovider`	String	The name of the file provider where the output file is saved.
`type`	String	Task type.

Create storyboard

Parameter	Type	Description
`colorspace`	String	Color space applied to the output image.
`contenttype`	String	ContentType/MimeType for the output file.
`contentdisposition`	String	Defines whether the file is an attachment or provided inline.
`density`	Integer	DPI use for the output image. Parameter required with ImageMagick.
`input`	String	Name of the property where the source file key is found.
`output`	String	Name of the property to which the output file key is saved.
`outputfileprovider`	String	The name of the file provider where the output file is saved.
`seekthumb_width`	Integer	Width of the thumbnail when seeking in a video.
`seekthumb_height`	Integer	Height of the thumbnail when seeking in a video.
`seekthumb_amount`	Integer	Number of frames used for seeking in a video.
`storythumb_width`	Integer	Width of the thumbnail for the storyboard rendition.
`storythumb_height`	Integer	Height of the thumbnail for the storyboard rendition.
`storythumb_amount`	Integer	Number of frames used for the storyboard rendition.
`targetextension`	String	Extension of the output file.
`type`	String	Task type.

Extracting clipping paths

Parameter	Type	Description
`input`	String	Name of the property where the source file key is found.
`output`	String	Name of the property to which the output file key is saved.
`outputfileprovider`	String	The name of the file provider where the output file is saved.
`type`	String	Task type.

Extract metadata

Parameter	Type	Description
`contenttype`	String	ContentType/MimeType for the output file.
`contentdisposition`	String	Defines whether the file is an attachment or provided inline.
`input`	String	Name of the property where the source file key is found.
`output`	String	Name of the property to which the output file key is saved.
`outputfileprovider`	String	The name of the file provider where the output file is saved.
`type`	String	Task type.

Extract vision data

Parameter	Type	Description
`contentdisposition`	String	Defines whether the file is an attachment or provided inline.
`contenttype`	String	ContentType/MimeType for the output file.
`details`	String	Types of content to analyze.
`endpoint`	String	Send a request to either the OCR endpoint for text recognition both to the Analyze endpoint for image features recognition.
`features`	List	Features to extract.
`detectorientation`	Boolean	Determines whether the OCR feature detects the orientation of text.
`input`	String	Name of the property where the source file key is found.
`output`	String	Name of the property to which the output file key is saved.
`outputfileprovider`	String	The name of the file provider where the output file is saved.
`minimumconfidence`	Double	The minimum accuracy level for analysis.
`type`	String	Task type.

Extract video indexer data

Parameter	Type	Description
`batchsize`	Integer	Determines the number of key frames in a single rendition.
`contentdisposition`	String	Defines whether the file is an attachment or provided inline.
`contenttype`	String	ContentType/MimeType for the output file.
`imageformat`	String	Output format for the storyboard and face renditions.
`input`	String	Name of the property where the source file key is found.
`output`	String	Name of the property to which the output file key is saved.
`outputfileprovider`	String	The name of the file provider where the output file is saved.
`facethumbnailheight`	Integer	Height for the face thumbnail renditions.
`facethumbnailwidth`	Integer	Width for the face thumbnail renditions.
`keyframeheight`	Integer	Height for the key frame renditions.
`keyframewidth`	Integer	Width for the key frame renditions.
`quality`	Integer	Output quality as a percentage of the source file.
`type`	String	Task type.

Run external web task

Parameter	Type	Description
`contentdisposition`	String	Defines whether the file is an attachment or provided inline.
`contenttype`	String	ContentType/MimeType for the output file.
`url`	String	URL of the external task.
`headers`	String	JSON containing web request headers.
`input`	String	Name of the property where the source file key is found.
`output`	String	Name of the property to which the output file key is saved.
`outputfileprovider`	String	The name of the file provider where the output file is saved.
`parameters`	JSON	JSON containing web request parameters.
`longevity`	Integer	The number of days in which the file is publicly available.
`type`	String	Task type.

Rendition links parameters

The renditions parameter, contained in output, is a series of rendition link objects, objects, each with the following structure:

"[name]": {
 "initial": {
  "status": "pending"
 },
 "file": "massive",
 "properties": [
  "width",
  "height"
 ]
}

The following table describes the parameters of this JSON:

Parameter	Type	Description
`[name]`	String	Name of the output.
`initial`	List	List of initial parameters.
`status`	String	Statuses of the output.
`file`	String	Name of the output file.
`properties`	Array	Array of properties to store with the output file.

If you have suggestions for improving this article, let us know!