Composition

input

Lists the containers used to render the composition. A composition consists of one or more segments that are presented sequentially. The containers within each segment are presented concurrently. By default a composition consists of a single default segment.

Property

Type

Description

reference

string

Identifies the reference container.

container

array

Lists the containers in the default segment (spanning the entire duration of the composition).

segment

array

Lists the segments in the composition (each representing a portion of the overall duration).

segment

Represents a portion of the composition timeline.

Property

Type

Description

name

string

Uniquely identifies the segment within the composition.

container

array

Lists each container in this segment.

For example the following composition presents the segments chapter1 and chapter2 sequentially. Each segment has 2 input containers providing the picture and sound streams respectively:

---
input:
  segment:
  - name: chapter1
    container:
    - name: picture1
      video:
      - name: v1
    - name: sound1
      audio:
      - name: a1
  - name: chapter2
    container:
    - name: picture2
      video:
      - name: v1
    - name: sound2
      audio:
      - name: a1
output:
  container:
  - name: output1
    type: 'mp4 '
    video:
    - route:
        name: v1
    audio:
    - route:
        name: a1
{
  "input": {
    "segment": [
      {
        "name": "chapter1",
        "container": [
          {
            "name": "picture1",
            "video": [
              {
                "name": "v1"
              }
            ]
          },
          {
            "name": "sound1",
            "audio": [
              {
                "name": "a1"
              }
            ]
          }
        ]
      },
      {
        "name": "chapter2",
        "container": [
          {
            "name": "picture2",
            "video": [
              {
                "name": "v1"
              }
            ]
          },
          {
            "name": "sound2",
            "audio": [
              {
                "name": "a1"
              }
            ]
          }
        ]
      }
    ]
  },
  "output": {
    "container": [
      {
        "name": "output1",
        "type": "mp4 ",
        "video": [
          {
            "route": {
              "name": "v1"
            }
          }
        ],
        "audio": [
          {
            "route": {
              "name": "a1"
            }
          }
        ]
      }
    ]
  }
}

output

Lists the containers produced by the composition.

Property

Type

Description

container

array

Lists each container produced by the composition.

package

array

Lists each package produced by the composition.


Did this page help you?