Rundown Player Filter Specification

The Rundown Player filter can only be used as the first filter of an input graph. It is specifically designed to play a rundown defined in the Broadcast System, and is controlled by the RundownBroker service.

JSON Structure

JS

{
    "name": "Rundown Player",
    "format": {
        "sampleRate": ...,
        "numberOfChannels": ...
    },
    "rundown": [
    {
        "fileId": "...",
        "fileSource": "<path>",
        "title": "..."
        "startTime": "<absolute time (UTC)>",
        "startOffset": "<relative time>",
        "stopOffset": "<relative time>",
        "fadePoints": [
        {
            "time": "<relative time>",
            "gain": ...
        },
        { ... }
        ]
   },
   { ... }
   ]
}

Field

Description

format

Describes the audio format, which is delivered by the filter.

sampleRate: Sampling rate in Hz. It is recommended to use the same sampling rate that is configured for the job’s output graph.
numberOfChannels: The field is optional, with a default value of 2.

rundown

This is the optional initial rundown for the filter, and can also be empty. Usually, the rundown will be updated during the job’s runtime.

If specified, the rundown must be an array of file playout specifiers, q.v. below.

Note: The normal use case for the Rundown Player Filter is the use in jobs which play a BCS rundown (controlled by the RundownBroker). In this case, the whole “rundown” array can be omitted.

Fields of File Playout Specifier

Field	Description
fileId	A unique (for this job) ID of the file.
fileSource	The full path to the audio file.
title	The title of the file, displayed in some log messages. The parameter is optional.
startTime	The absolute time (in UTC), when the playout of this file starts. Format is “YYYY-MM-DDThh:mm:ss.sss” or “hh:mm:ss.sss” (using the current date, when the job is running). The millisecond part can be omitted.
startOffset	An offset into the file, which defines the beginning of the part of the file, which is played back. Format is “hh:mm:ss.sss”. The parameter is optional - if not specified, the file is played from the beginning.
stopOffset	An offset into the file, which defines the end of the part of the file, which is played back. Format is “hh:mm:ss.sss”. The parameter is optional - if not specified, the file is played until its end.
fadePoints	An array of points with time stamps (relative to the start offset) and gain values (between 0.0 and 1.0) to define a fading of the playback.