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:

RequestResponse
 {
  "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:

RequestResponse
"[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.

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

RequestResponse
"[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.

Do you have some feedback for us?

If you have suggestions for improving this article,