Item Subclip

The subclip resource exposes a simple way to create a subclip of an existing item (trim).

Subclip

Create subclip of an item

New in version 25.2.

POST /item/(item-id)/subclip

Starts a new job that creates a subclip of an item.

Query Parameters:
  • sourceTag (string) – Comma-separated list of shape tags. The first valid shape is selected as the source of the job. If non of the tags are valid, the original shape will be used.
  • tag (string) – Comma-separated list of shape tags specifying the desired output formats. Currently, only a single tag can be specified for a sequence item. Must not be set in TrimWithOrigin mode.
  • 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.
  • destinationItem (string) – An item id, to which the new shape will be associated (mandatory).
  • storageId (string) – Identifier of storage where essence file is to be stored.
  • mode (string) –
    Rendermode of the transcoder (mandatory).
    • Rendering - New encoding of the complete subclip.
    • TrimWithOrigin - Trim MXF videos without re-enconding by copying over the original frames from the source video to the subclip. In case of long-GOP formats complete GOPs are copied. The MXF origin then is used to mask out excess frames at the beginning of a GOP. The duration of the MXF tracks may be shorter than the stored essence to mask out excess frames at the end of the video. This mode is only available for MXF videos.
  • start (string) – Start frame in the source of the subclip (timecode format e.g. 10@PAL)
  • duration (string) – duration of the subclip (timecode format e.g. 10@PAL)
  • startTimeCode (string) – Start timecode of the new clip (timecode format e.g. 10@PAL)
  • resourceId (string) – The transcoder resource to use to execute the job.
  • resourceTag (string) –

    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).

  • 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.
Produces:
Role:

_sequence_read
Role:

_job_write