Skip to main content

Web review asset versions

It is possible to review files in a desktop player and the web interface using the built-in review tools in ftrack, such as client review or the web player.

tip

For most use-cases we recommend our examples of How to publish media for review using our API clients. This article

Make a component ready for review​

The primary way to make a component available for review is to set Metadata on the component.

{
    "parent_id": ...,
    "parent_type": "FileComponent",
    "key": "ftr_meta",
    "value": ...
}

The key should be ftr_meta and value an encoded JSON.

Video​

Here we define start frame, end frame, frame rate and the media resolution in width and height in pixels.

{
  "frameIn": 0,
  "frameOut": 150,
  "frameRate": 25,
  "height": 720,
  "width": 1280
}

You can also use pre-defined component names ftrackreview-mp4, ftrackreview-webm and ftrackreview-image.

Image​

Here we define media resolution in width and height in pixels.

{
  "format": "image",
  "height": 720,
  "width": 1280
}

You can also use pre-defined component names ftrackreview-image.

PDF​

{
  "format": "pdf"
}