Stitching is done using the functions "Timeline API" and "Item conform" in Vidispine.


What is "Timeline API"?

Timeline API is used to store and retrieve timelines in the system. A timeline is represented in the system as a combination of:

  • The timeline itself (in the native format, but can be converted to other formats)
  • The rendered result as a new item.
  • The timeline with its constituent parts as a collection.

More information on API Timeline;

http://apidoc.vidispine.com/latest/ref/item/timeline.html


What is "Item conform"?

The conform resource exposes a simple way to combine media from one or more items into a new item. It is also possible to select specific parts from the input by specifying an input interval. There are two different types of conforming;

  • Start a confirm job = Starts a new CONFORM job that creates a new item and one or more shapes that contains media according to the conform timeline.The rendered result as a new item.
  • Start a conform job for an existing item = Starts a new CONFORM job that creates one or more shapes that contains media according to the conform timeline.

More information on Item conform and different query parameters;

http://apidoc.vidispine.com/latest/ref/item/conform.html


In the example guide below we will be using "Start a conform job for an existing item".


Example guide;

It's only for the item that the resulting shape should belong to that needs a conform job as a timeline. For example, given three items VX-1, VX-2 and VX-3 with original shapes with media. To concatenate these into a new shape for item VX-100 one would do:

PUT API/item/VX-100/timeline/vidispine

<ConformDocument xmlns="http://xml.vidispine.com/schema/vidispine">
    <timeBase>
    <numerator>1</numerator>
        <denominator>25</denominator>
    </timeBase>
    <timeline>
    <segment>
      <source>
        <id>VX-1</id>
      </source>
    </segment>
    <segment>
      <source>
        <id>VX-2</id>
      </source>
    </segment>
    <segment>
      <source>
        <id>VX-3</id>
      </source>
    </segment>
  </timeline>
</ConformDocument>

Then start the conform job using:

POST /API/item/VX-100/timeline/vidispine/conform?sourceTag=original&tag=house


This would then create a shape on VX-100 tagged with house containing the media from those three files. Note that the source items (VX-1, VX-2 and VX-3) do not need a timeline on them.