Item sequences

Sequence operations

List the available sequences

GET /item/(id)/sequence

Retrieves the sequences that have been stored for a specific item.

Status Codes:
  • 404 Not found – Could not find the item
Produces:
Role:

_sequence_read

Create/update a sequence

PUT /item/(id)/sequence/(format)

Creates or updates the sequence in the given format.

Query Parameters:
 
  • pauseFrame – When a rendering job is started, this parameter determines which frame the job will pause at. The job will resume when the sequence is updated.
Status Codes:
  • 404 Not found – Could not find the item
Accepts:
  • application/octet-stream – The sequence definition
Produces:
  • application/xml, application/jsonItemDocument with the id of the sequence
Role:

_sequence_write

Remove a sequence

DELETE /item/(id)/sequence/(format)

Removes a specific sequence from an item.

Status Codes:
  • 404 Not found – Could not find the item
  • 404 Not found – Could not find the sequence
Role:

_sequence_write

Rendering a sequence

A sequence can be rendered which creates a new shape that for example can be used as a preview of the sequence. The shape tag that is provided must have a transcode preset the specifies at least:

  • The container format.
  • The audio codec and bitrate (optional for PCM.)
  • The video codec and bitrate.

The transcoder can render a subset of the effects (both normal and key framed) and transitions that are available in Final Cut and Avid Media Composer. They are:

  • Effects
    • Crop
    • Position
    • Scale
    • Rotate
    • Opacity
  • Transitions
    • Dissolves
      • Cross dissolve
      • Dither dissolve
      • Fade in fade out dissolve
    • Wipes
      • Band wipe
      • Centre wipe
      • Checker wipe
      • Inset wipe
    • Iris wipes
      • Cross iris
      • Diamond iris
      • Oval iris
      • Rectangle iris
      • Star iris

Render a standalone sequence

POST /sequence/render

Creates a new job that renders the given sequence. A new item will be created containing a shape with the rendered result once the job is finished.

Query Parameters:
 
  • tag – The shape tag specifying the format of the rendered sequence.
  • sourceTag – The shape tag specifying the shapes to use as input.
  • notification – See Notifications . (Optional)
  • notificationData – See Notifications . (Optional)
  • priority – The priority to assign to the job. Default is MEDIUM .
  • jobmetadata – Additional information for the job task. See Special job metadata values
Status Codes:
  • 404 Not found – Could not find the item
Accepts:
Produces:
Role:

_job_write

Rendering a sequence on an item

New in version 4.1.1.

POST /item/(id)/sequence/render

Creates a new job that renders the sequence for the given item. The item will contain a new shape with the rendered result once the job is finished.

Query Parameters:
 
  • tag – The shape tag specifying the format of the rendered sequence.
  • sourceTag – The shape tag specifying the shapes to use as input.
  • notification – See Notifications . (Optional)
  • notificationData – See Notifications . (Optional)
  • priority – The priority to assign to the job. Default is MEDIUM .
  • jobmetadata – Additional information for the job task. See Special job metadata values
Status Codes:
  • 404 Not found – Could not find the item
Produces:
Role:

_sequence_read

Role:

_job_write

Example

POST /item/VX-8/sequence/render?tag=h264
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<JobDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <jobId>VX-13</jobId>
  <user>admin</user>
  <started>2011-10-26T20:23:11.897Z</started>
  <status>READY</status>
  <type>CONFORM</type>
  <priority>MEDIUM</priority>
</JobDocument>