Properties

Within a composition containers, packages, media streams and various stream operators are configured using a collection of properties. Configuration properties use a CamelCase naming convention to distinguish them from the composition schema.

This section describes properties available to produce different media formats and perform media processing such as audio normalization and color space conversion.

Format

Use the Format property to specify the compressed or uncompressed format of a media stream. For each format identifier the Transform service pre-processor will automatically select and configure the appropriate format converter or compressor component.

The following composition produces an MXF OP-1a output containing AVC-Intra Class 100 video and 24 bit PCM audio:

---
input:
  container:
  - name: input1
    video:
    - name: v1
    audio:
    - name: a1
output:
  container:
  - name: output1
    type: 'op1a'
    video:
    - route:
        name: v1
      properties:
        Format: avci_100_720p30
    audio:
    - route:
        name: a1
      properties:
        Format: pcm_24int_little

{
  "input": {
    "container": [
      {
        "name": "input1",
        "video": [
          {
            "name": "v1"
          }
        ],
        "audio": [
          {
            "name": "a1"
          }
        ]
      }
    ]
  },
  "output": {
    "container": [
      {
        "name": "output1",
        "type": "op1a",
        "video": [
          {
            "route": {
              "name": "v1"
            },
            "properties": {
              "Format": "avci_100_720p30"
            }
          }
        ],
        "audio": [
          {
            "route": {
              "name": "a1"
            },
            "properties": {
              "Format": "pcm_24int_little"
            }
          }
        ]
      }
    ]
  }
}

The previous example is equivalent to the following composition using the encode operator (video) and format property (audio) directly:

input:
  container:
  - name: input1
    video:
    - name: v1
    audio:
    - name: a1
output:
  container:
  - name: output1
    type: 'op1a'
    video:
    - name: v1
      width: 1280
      height: 720
      sample_rate:
        numerator: 30
        denominator: 1
      encode:
        type: 'mc64'
        properties:
         OutputFormat: 'ai1p'
    audio:
    - name: a1
      format: 'in24'

See the Video Formats topic for a complete list of the available video format identifiers.

See the Audio Formats topic for a complete list of the available audio format identifiers.

Kind

Use the Kind property to apply special processing to a container, media stream or stream operator.

Kind	Description
`image`	Indicates that an input container represents a still image. An image container has a single video stream.
`metadata`	Indicates that an input or output container represents a sidecar metadata file. A metadata container has single video stream.
`data`	Indicates that an input or output container represents a data file (e.g. LUT). Data containers do not have media streams.
`captions`	Indicates that an overlay stream contains "open" captions.
`subtitle`	Indicates that an input or output container represents a sidecar subtitle file. A subtitle container has a single subtitle stream. Indicates that an overlay stream contains "open" subtitles.