UC Create Proxy

Motivation

Usually hires material imported into the system can be quite resource demanding to work with. Therefor, creating a proxy version of the material is a good way to save on bandwidth, storage, cpu while working with the material and then let the backend take care of doing the transformation on the original file.

Example

An item can be transcoded either when it is imported or afterwards by using the item transcode resource. The difference between transcoding while and after importing is that the former can be done in parallel to any transfers that may be needed, while the latter is a serial task as the input files, the files from the original shape of the item, should already exist on a storage managed by Vidispine.

In both cases the type of format which we want to transcode to can be specified using the tag parameter.

Example of triggering a transcode to a proxy shape of format __mp4 during import:

POST /import?uri=file:///srv/incoming/media.mov&tag=__mp4

Response:

CODE

<JobDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <jobId>VX-169819</jobId>
  <user>admin</user>
  <started>2014-07-03T07:20:14.220Z</started>
  <status>READY</status>
  <type>PLACEHOLDER_IMPORT</type>
  <priority>MEDIUM</priority>
</JobDocument>

Example of triggering a transcode to a proxy shape of format __mp4 for an item in VidiCore:

POST /item/VX-191440/transcode?tag=__mp4

Response:

CODE

<JobDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <jobId>VX-169820</jobId>
  <user>admin</user>
  <started>2014-07-03T07:22:47.900Z</started>
  <status>READY</status>
  <type>TRANSCODE</type>
  <priority>MEDIUM</priority>
</JobDocument>

As the job has finished, we can ask the API for the shape of our proxy type:

GET /item/VX-191440/shape?tag=__mp4

Which would return the shapeId of the proxy shape(s)

Resources

Resources specific to this UC:

https://apidoc.vidispine.com/latest/ref/item/transcode.html#transcode-an-item

https://apidoc.vidispine.com/latest/ref/item/import.html#importing-an-item

Please see more information in:

Single-File Videos

How to

Please view the explanation in:

https://apidoc.vidispine.com/latest/item/shape.html#transcoding