Zencoder Encoding Settings: Syndication

Product(s)
Zencoder
Role(s)
API Developer
API(s)
Zencoder API

This topic contains details for encoding settings related to video syndication.

Overview

You can include syndication outputs that are sent directly to services like YouTube and Vimeo. Zencoder passes metadata when syndicating video to these services, or sharing videos through MRSS. Metadata is not written to the file.

Syndication services have their own requirements for metadata; check with the service or contact us with any questions on requirements.

When uploading to multiple syndication services metadata can be written at the job level, before the outputs are defined. Any options set at that level are applied to all outputs. Specifying metadata on an output will override that option for the given output.

The example below sets a title and description at the job level. The title is overwritten on both outputs, along with other metadata. The description is applied to each.

{
  "input": s3://zencodertesting/test.mov",
  "metadata":{
    "title":"Generic Title"
    "description":"A description for all syndication outputs."
  }
  "outputs": [
  {
    "url":"syndicate://you_tube",
    "syndication_id":"you_tube_production",
    "metadata":{
      "title":"YouTube Title",
      "category":"Film",
      "keywords":[
      "Zencoder"
      ]
    }
  },
  {
    "url":"syndicate://vimeo",
    "syndication_id":"vimeo_production",
    "metadata":{
      "title":"Vimeo Title"
    }
  }
  ]
}

The example above specifies a title and description for metadata at the job level of the request. This will be applied to all supported outputs (syndication only). Each output specifies its own metadata, which overrides anything from the job.

In this situation the title set at the job level is not applied to either output because it is overridden at the output level of the request, while the same description is set for each. Additionally, the output going to YouTube specifies a category and keywords for its metadata.

Syndication settings

The following sections provide details for the syndication settings.

syndication_id

syndication_id:String

API Versions: V2

Parent: outputs

Valid Values: A string (the syndication_id must be unique within the outputs for the job)

Compatible Job Types: VOD

Description:

An id to identify the output.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "url" : "syndicate://you_tube",
      "syndication_id": "you_tube",
      "metadata": {
        "title" : "My Video"
      }
    }
  ]
}

See Also: metadata, title, description, keywords, category, and schemas

metadata

metadata:Hash

API Versions: V2

Parent: outputs

Valid Values: Hash containing metadata for syndication.

Compatible Job Types: VOD

Description:

Title metadata for the syndication service. Applied to the service's metadata as supported. Required by some services.

Metadata is not written to the file, it is only passed along to syndication services that support it.

{
  "input": "s3://zencodertesting/test.mov",
  "outputs": [
    {
      "url" : "syndicate://you_tube",
      "syndication_id": "you_tube",
      "metadata": {
        "title" : "My Video"
      }
    }
  ]
}

See Also: title, description, keywords, category, and schemas

title

title:String

API Versions: V2

Parent: outputs / metadata

Valid Values: String naming the video

Compatible Job Types: VOD

Description:

Provides a title for the video to be used by the syndication destination.

  {
    "input": "s3://zencodertesting/test.mov",
    "outputs": [
      {
        "url" : "syndicate://you_tube",
        "syndication_id": "you_tube",
        "metadata": {
          "title" : "My Video"
        }
      }
    ]
  }

See Also: metadata, description, keywords, category, and syndication_id

description

description:String

API Versions: V2

Parent: outputs / metadata

Valid Values: String describing the video.

Compatible Job Types: VOD

Description:

Description metadata for the syndication service. Applied to the service's metadata as supported. Required by some services.

Metadata is not written to the file, it is only passed along to syndication services that support it.

  {
    "input": "s3://zencodertesting/test.mov",
    "outputs": [
      {
        "url" : "syndicate://you_tube",
        "syndication_id": "you_tube",
        "metadata": {
          "title" : "My Video",
          "description" : "A description of my video"
        }
      }
    ]
  }

See Also: metadata, title, keywords, category, and syndication_id

keywords

keywords:Array

API Versions: V2

Parent: outputs / metadata

Valid Values: Array of keyword strings.

Compatible Job Types: VOD

Description:

Keywords or tags for the syndication service. Applied to the service's metadata as supported. Required by some services.

Metadata is not written to the file, it is only passed along to syndication services that support it.

  {
    "input": "s3://zencodertesting/test.mov",
    "outputs": [
      {
        "url" : "syndicate://you_tube",
        "syndication_id": "you_tube",
        "metadata": {
          "title" : "My Video",
          "description" : "A description of my video",
          "keywords" : ["Zencoder", "Awesome"]
        }
      }
    ]
  }

See Also: metadata, title, description, category, and syndication_id

category

category:String

API Versions: V2

Parent: outputs / metadata

Valid Values: Array of keyword strings.

Compatible Job Types: VOD

Description:

Category metadata for the syndication service. Applied to the service's metadata as supported. Required by some services.

Services may have a predefined list of valid categories. Check with the service's documentation for a list or contact us with any questions.

Metadata is not written to the file, it is only passed along to syndication services that support it.

  {
    "input": "s3://zencodertesting/test.mov",
    "outputs": [
      {
        "url" : "syndicate://you_tube",
        "syndication_id": "you_tube",
        "metadata": {
          "title" : "My Video",
          "description" : "A description of my video",
          "keywords" : ["Zencoder", "Awesome"],
          "category" : "film"
        }
      }
    ]
  }

See Also: metadata, title, description, keywords, and syndication_id