Skip to main content

Vantage Transcode

Updated

Go to README

What does this plugin do?

The plugin integrates Telestream Vantage with Cantemo, enabling users to initiate automated transcoding workflows directly within the Cantemo interface. It supports metadata mapping and custom presets for converting media into multiple formats while preserving quality and metadata.

How to trigger :

There are two main ways to trigger a workflow using the Vantage Transcoder plugin:

The simplest, most straightforward way is to:

    1. Select one or more items.

    2. Click the Gear icon.

    3. Type transcode in the filter.

    4. Select Transcode.

00.png

That will pop up a window for the user to select which format they want to transcode a new shape with, which could be configured to show Vantage Transcoder workflows. These are Transcode Profiles set up in Cantemo and then added in the CineSys Vantage Transcoder plugin.

01.png

02.png

03.png

Another, more complex way, of triggering the Vantage Transcoder plugin is to:

    1. Select an item or items.

    2. Click the Gear.

    3. Type execute in the filter.

    4. Select Execute Workflow.

04.png

05.png

That will pop up the Execute Workflow window where you can select a workflow that has been configured to trigger the Vantage Transcoder plugin to send the item(s) to a Vantage workflow.

06.png

User Experience:

In either scenario, when triggering a transcode or workflow on an item(s), the user would be able to see and check the status of the job in the CineSys Job Viewer. Through the Vantage Transcoder plugin, we are able to track the status of the transcode job in Vantage and update the status in the Job Viewer.

README

What It Adds

  • A new version of the Vantage Transcoder plugin with enhanced support for sending more options to Vantage workflows.

Portal Permissions

  • Uses Cantemo's built-in permissions for reading/writing transcode profiles.

Elastic  

Each configured profile includes the following error-checking booleans:

Key Type Description
cs_vantage_length_error_<profile> (boolean) Is the Vantage path too long?
cs_vantage_character_error_<profile> (boolean) Does the path contain illegal characters?
cs_vantage_path_error_<profile> (boolean) Is the Vantage path inaccessible?

Configuration

{
  "vantage_host": "23.126.104.106:8676",
  "max_path_length": 260,
  "illegal_characters": [":"],
  "storage_mappings": {
    "VX-1": "S:\\\\example\\\\"
  },
  "profiles": {
    "profile_a": {
      "workflow": "API Test S3",
      "inputs": {
        "CS Out Point": "_marker/default:out",
        "CS In Point": "_marker/default:in",
        "CS Current Date": "_date",
        "CS Series Name": "portal_mf808696"
      },
      "replace_existing_shapes": false,
      "shape_outputs": ["h264", "ProResLT"]
    },
    "profile_b": {
      "workflow": "API Test S3",
      "inputs": {
        "CS Out Point": "_job:cs_subclip_out",
        "CS In Point": "_job:cs_subclip_in",
        "CS Title": "_job:cs_subclip_title",
        "CS Current Date": "_date",
        "CS Series Name": "_value:Test"
      },
      "optional_inputs": ["CS Series Name"],
      "item_outputs": ["h264", "ProResLT"],
      "source_shape": "lowres"
    }
  }
}

Profile Settings

Each profile must be created in the Cantemo Transcode Framework and can include the following settings:

Key Required Example Description
workflow required   Name of the vantage workflow
inputs optional   The key is what will be passed to vantage. The value can be any of the following:
    _marker/default:in The cs_player_markers default type marker in point.
    _marker/default:out The cs_player_markers default type marker out point.
    _date:d mmmm yyyy The current date, formatted. (Options)
    _value:Constant A constant value Constant
    portal_mf808696 some metadata field
    Group Name/portal_mf808696 some metadata field in a sub group
    _job:cs_subclip_in In point for a subclip transcode
    _job:cs_subclip_out Out point for a subclip transcode
    _job:cs_subclip_title Subclip title for a subclip transcode
optional_inputs optional   A list of inputs keys to mark as optional.
replace_existing_shapes optional   Whether to replace existing output shapes instead of creating new ones.
shape_outputs optional   Output these vantage outputs as shapes on the main item.
item_outputs optional   Output these vantage outputs as a new item, where the first entry in the list will be the original.
source_shape optional   Defaults to original. What shape to use as the source. Can also be an array, and will search for the first shape in the list that exists on the item.

Other Options

Key Required Description
storage_mappings required Map storage ids to a windows mount point. Note that backslashes should be used and must be escaped (\\).
max_path_length optional The maximum windows path length allowed
illegal_characters optional Characters not allowed in the windows path