Skip to content

Playout setup

Use this page when you create or configure an individual playout and its output stream. For the complete path from VOD files to subscriber playback, follow Channel from VOD.

A playout runs schedule slots and sends the broadcast to a stream named playout_<id>. The schedule controls the content, while the stream settings control encoding and delivery.

Before you start

  • Operator access to Playout, VOD, and Streams.
  • Video with audio for the schedule. A video or JPEG image can serve as a filler.
  • For the general filler, access to the management API plus curl and jq.

Create a playout

  1. Open Playout.
  2. In New playout name, enter a name and click Create playout. The editor opens with an empty schedule.

Catena creates the playout_<id> stream and a programme guide source together with the playout. You do not need to create the stream or bind EPG separately. The full <id> appears in the editor address after #/playouts/.

A new playout receives this default source format:

  • 25 fps — the frame rate to which content is conformed.
  • 1920×1080 — the playout output frame size.
  • Mono, 48 kHz — the audio layout and sample rate.
  • 8-bit — the color depth.

Choose the viewer output

Playout outputs uncompressed YUV video and PCM audio. Configure the transcoder on the automatic stream for an ordinary HLS player:

  1. In the On air panel, click Open stream card.
  2. Open the Transcoder tab and select the Standard ladder 1080/720/360 + AAC preset.
  3. In Preview: input → output, check that three video qualities and AAC audio are configured, then click Save.

This preset encodes the broadcast as H.264 and AAC and creates three HLS qualities. Other delivery and archive settings also belong to the stream page, not the playout editor.

How source parameters affect the broadcast

Playout conforms every asset to one source format. It scales the picture to the configured size and converts the audio to the configured sample rate and layout. This does not replace the transcoder: after conforming, playout still outputs uncompressed frames and audio.

Check asset frame rates

If an asset's frame rate differs from the source rate, playout duplicates or drops frames. The slot duration does not change, but motion can become less smooth. Such a slot receives a warning; saving the schedule is not blocked. For smooth motion, use assets with the playout's frame rate.

Where the source format is configured

Source format properties are located on the stream card's Sources tab. The playout editor is for the name, filler, and schedule. To change the format, use Change the source format: the procedure requires disabling and re-enabling the stream.

Configure fillers

A filler covers schedule gaps and replaces content when an asset fails. The fallback order is:

  • Slot filler — applies only to the selected slot.
  • Channel filler — the general playout filler; it plays if a slot has no filler of its own or if there is no slot at the current time.
  • Emergency synthesis — color bars with silence when no suitable filler is configured or available.

Fillers use VOD assets: video or a static JPEG image. An image remains on screen with silence. A live stream cannot be a filler.

Set the general filler through the API

In the verified version, the console does not save Channel filler: the main Save button returns HTTP 422 with “missing field fps” and the setting is not applied. Do not use this path. Saving the schedule and slot filler works separately.

You can set the general filler through the management API. The PATCH must contain the complete config with only filler changed: sending config.filler alone makes the server reject the request. The commands below read the current document and preserve all its parameters, including the schedule and source format.

  1. Upload a video or JPEG as a separate VOD asset and wait for its file information. Copy the playout identifier from the editor address.
  2. Set the installation address, operator account, playout identifier, and asset key. Send the password only over HTTPS:

    set -euo pipefail
    BASE='https://catena.example.com'
    API_USER='operator'
    read -rsp 'Operator password: ' API_PASSWORD; echo
    PLAYOUT_ID='<playout id>'
    ASSET_KEY='slates/technical'
    
  3. Find the asset identifier by its key:

    ASSET_ID=$(curl -fsS -u "$API_USER:$API_PASSWORD" --get \
      --data-urlencode "name_prefix=$ASSET_KEY" \
      --data-urlencode 'limit=1000' \
      "$BASE/central/api-v4/vod/assets" |
      jq -er --arg key "$ASSET_KEY" '.assets[] | select(.key == $key) | .id')
    
  4. Check that the asset is placed on available storage with a readable journal. The command links storage_id from the asset placement to its storage record and fails if no suitable storage exists. In that case, wait until VOD is ready and repeat the check instead of proceeding to PATCH:

    curl -fsS -u "$API_USER:$API_PASSWORD" \
      -o filler-asset.json "$BASE/central/api-v4/vod/assets/$ASSET_ID"
    curl -fsS -u "$API_USER:$API_PASSWORD" \
      -o vod-storages.json "$BASE/central/api-v4/vod/storages"
    jq -e --slurpfile storages vod-storages.json \
      '.placements[]? as $placement |
       $storages[0].storages[]? |
       select(.id == $placement.storage_id and .status == "available" and .journal == "readable")' \
      filler-asset.json >/dev/null
    
  5. Read the playout, save its ETag, and prepare a request with the complete config:

    curl -fsS -u "$API_USER:$API_PASSWORD" \
      -D playout.headers -o playout.json \
      "$BASE/central/api-v4/playouts/$PLAYOUT_ID"
    
    ETAG=$(sed -n 's/^[Ee][Tt][Aa][Gg]:[[:space:]]*//p' playout.headers | tr -d '\r')
    if [[ -z "$ETAG" ]]; then
      echo 'ETag is missing; refusing to PATCH' >&2
      exit 1
    fi
    
    jq --arg filler "vod://$ASSET_ID" \
      '{config: (.config + {filler: $filler})}' playout.json > playout-filler.json
    
  6. Send the change with the ETag from the document you read:

    curl -fsS -u "$API_USER:$API_PASSWORD" \
      -X PATCH "$BASE/central/api-v4/playouts/$PLAYOUT_ID" \
      -H "If-Match: $ETAG" \
      -H 'Content-Type: application/merge-patch+json' \
      --data-binary @playout-filler.json |
      jq '.playout.config'
    

In the response, filler must contain vod://<asset id>, while fps, size, sample_rate, audio, and bit_depth retain their previous values. If the server returns HTTP 412, another session changed the document: read it again, review the new configuration, and only then prepare the request again. Do not resend the old ETag.

On a new playout without slots, the general filler should already be on air; check it over HLS as described below. On an existing playout with a current slot, the saved response confirms the setting, and the filler picture can be seen at the next schedule gap. Do not delete the current slot just to test it.

Set a slot filler in the console

  1. Create or open a slot in the editor.
  2. In Slot filler (optional), select a VOD asset. — same as the channel — keeps the general playout filler for this slot.
  3. Click Create slot or Save in the slot dialog, then the main Save button above the grid. Do not change Channel filler at the same time.

Reopen the slot and check the selected asset. The On air panel must show the current slot title from the saved schedule.

Check the stream

  1. In the On air panel, click Open stream card and open the Sources tab.
  2. Check the playout protocol and playout identifier. The link below the identifier returns to the editor.

The playout stream input and the link back to the editor

  1. Open the Egress tab. Under Playback, find Issue a play ticket and click Issue ticket.
  2. Copy the HLS / LL-HLS address into an HLS player. To inspect the manifest, open the address in a new browser tab.

The master manifest must contain quality variants, and a variant manifest must contain media segments. The player must show the current slot with sound; with an empty schedule, it must show the general filler or color bars. If the response contains only a playlist header, check the transcoder. If access fails, issue a new ticket.

Do not use the editor's JPEG preview as a mandatory check: with playback protection enabled, /playback/live-preview-jpeg/playout_<id> can return HTTP 403 even while HLS works.

Programme guide (EPG)

The EPG source is created with the playout and is already bound to the stream. For viewer-visible slot data, guide updates after edits, and result checks, see Playout programme guide.

Deletion

Deletion is irreversible. For the consequences for the stream and EPG, the procedure, and result checks, see Delete a playout.

What's next