Transcoding

Transcoding

Transcode an item

POST /item/(item-id)/transcode

Starts a new job that transcode an item to a number of shapes according to the given shape tags.

Query Parameters:
  • tag (string) – Comma-separated list of shape tags, that specify the desired output.
  • createThumbnails (boolean) –
    • true (default) - Creates thumbnails according to default transcoder rules.
    • false - No thumbnails will be created.
  • createPosters (string) – A list of time codes to use for creating posters.
  • thumbnailService (string) – Identifies which thumbnail resource that should be used.
  • destinationItem (string) – An item id, to which the new shape will be associated.
  • original (string) – If specified, should be one of the tags specified in the tag parameter. Specifies that the original shape tag will be reset to the shape created to this tag.
  • resourceId (string) – The transcoder resource to use to execute the job.
  • storageId (string) –

    Identifier of storage where essence file is to be stored.

    New in version 4.16.

  • overrideFastStart (boolean) –
    • true (default) - Use transcoder’s estimate of the duration for allocating header space in MOV files and similar files.
    • false - Do not use the transcoder’s estimate of the duration.
  • requireFastStart (boolean) –
    • true (default) - Try to put the index tables (header) in front of the file.
    • false - Put header at end of file.
  • fastStartLength (string) – Estimated duration of the clip in seconds.
  • notification (string) – The placeholder job notification to use for this job.
  • notificationData (string) – Any additional data to include for notifications on this job.
  • priority (string) – The priority to assign to the job. Default is MEDIUM .
  • jobmetadata (string[]) – Additional information for the job task.
  • holdJob (boolean) – If set to true, the job will be created in a HOLD state. Default is false.
  • resourceTag (string) –

    New in version 22.4.

    The resource tag criteria used to select transcoders for the job.

    Boolean operators - AND, OR, NOT - are supported.

    Examples: resourceTag=location:stockholm,

    resourceTag=location:stockhom OR location:berlin,

    resourceTag=(location:stockhom OR location:berlin) AND (type:blue OR NOT type:red).
Produces:
Role:

_job_write

Transcode a specific shape

POST /item/(item-id)/shape/(shape-id)/transcode

Starts a new job that transcode a specific shape on an item to a number of shapes according to the given shape tags.

Query Parameters:
  • tag (string) – Comma-separated list of shape tags, that specify the desired output.
  • createThumbnails (boolean) –
    • true (default) - Creates thumbnails according to default transcoder rules.
    • false - No thumbnails will be created.
  • createPosters (string) – A list of time codes to use for creating posters.
  • thumbnailService (string) – Identifies which thumbnail resource that should be used.
  • destinationItem (string) – An item id, to which the new shape will be associated.
  • original (string) – If specified, should be one of the tags specified in the tag parameter. Specifies that the original shape tag will be reset to the shape created to this tag.
  • resourceId (string) – The transcoder resource to use to execute the job.
  • storageId (string) –

    Identifier of storage where essence file is to be stored.

    New in version 4.16.

  • overrideFastStart (boolean) –
    • true (default) - Use transcoder’s estimate of the duration for allocating header space in MOV files and similar files.
    • false - Do not use the transcoder’s estimate of the duration.
  • requireFastStart (boolean) –
    • true (default) - Try to put the index tables (header) in front of the file.
    • false - Put header at end of file.
  • fastStartLength (string) – Estimated duration of the clip in seconds.
  • notification (string) – The placeholder job notification to use for this job.
  • notificationData (string) – Any additional data to include for notifications on this job.
  • priority (string) – The priority to assign to the job. Default is MEDIUM .
  • jobmetadata (string[]) – Additional information for the job task.
  • holdJob (boolean) – If set to true, the job will be created in a HOLD state. Default is false.
  • resourceTag (string) –

    New in version 25.2.

    The resource tag criteria used to select transcoders for the job.

    Boolean operators - AND, OR, NOT - are supported.

    Examples: resourceTag=location:stockholm,

    resourceTag=location:stockhom OR location:berlin,

    resourceTag=(location:stockhom OR location:berlin) AND (type:blue OR NOT type:red).
Produces:
Role:

_job_write