Item sequences [VC 21.3.1 GEN]

A sequence is an assembly of audio and video from other items. An item may have multiple sequences, but they will all be considered equivalent by Vidispine, that is, that they represent the same logical sequence.

Sequences can be imported and exported to and from common NLE formats.

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

Sequence operations

List all 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:	application/xml, application/json – SequenceListDocument
Role:	_sequence_read

Update or create a sequence

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

Creates or updates the sequence in the given format.

Query Parameters:	pauseFrame (integer) – 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/json – ItemDocument with the id of the sequence
Role:	_sequence_write

Retrieve a sequence

GET /item/(id)/sequence/(format)

Retrieves the definition of the sequence in the given format.

Status Codes:	404 Not found – Could not find the item
Produces:	*/* – Media type based on the format.
Role:	_sequence_read

Delete 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

Conform metadata

POST /item/(id)/sequence/conform-metadata

Updates the item metadata with the metadata from the items listed in the sequence. The metadata will be selected based on the intervals.

Role:

_metadata_write

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 (string[]) – The shape tag specifying the format of the rendered sequence. sourceTag (string[]) – The shape tag specifying the shapes to use as input. 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 new shape will be associated. resourceId (string) – The transcoder resource to use to execute the transcode. New in version 4.16. 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.
Status Codes:	404 Not found – Could not find the item
Accepts:	application/xml, application/json – SequenceRenderRequestDocument
Produces:	application/xml, application/json – JobDocument
Role:	_job_write

Render a sequence

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 (string[]) – The shape tag specifying the format of the rendered sequence. sourceTag (string[]) – The shape tag specifying the shapes to use as input. subtitleLanguage (string) – The language code specifying the subtitle language to use. 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 new shape will be associated. resourceId (string) – The transcoder resource to use to execute the transcode. New in version 4.16. 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.
Status Codes:	404 Not found – Could not find the item
Produces:	application/xml, application/json – JobDocument
Role:	_sequence_read
Role:	_job_write

Example

NONE

POST /item/VX-8/sequence/render?tag=h264

HTML/XML

<?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>