Playlist item in JSON
Description of properties of Playout item as used in JSON
|
Id |
playout ID should be unique as reconcile key |
optional |
|
BSID |
item ID from scheduling system |
optional |
|
Index |
position (line) in playlist |
read-only |
|
Type |
see Enumeration PlayoutItemType below |
required |
|
State |
see Enumeration PlayoutItemState below |
read-only |
|
Path |
path to file or event command or note |
required |
|
TrimIn / TrimOut |
trimming of clip from beginning / end |
optional |
|
Notes |
item note |
optional |
|
Start |
actual start time of item |
read-only |
|
End |
actual end time of item |
read-only |
|
EstimatedStart |
estimated start time from scheduling system |
optional |
|
IsFixed |
if Start is set to be fixed |
optional |
|
OriginalDuration |
clip duration, whole, non trimmed |
recommended |
|
EstimatedDuration |
estimated duration for live events |
optional |
|
Duration |
calculated duration from original and trims |
read-only |
|
Color |
color of playlist line, can be hexadecimal or named |
optional |
|
Format |
format information |
optional |
|
Loop |
if item is set to be looped |
optional |
|
Metadata |
dictionary<string, string> of metadata with key and value pairs |
optional |
|
SecondaryEvents |
array of double and string pairs, defining time and event command |
optional |
Playlist item example:
{
"Id": 0,
"BSID": 0,
"Index": 0,
"Type": 0,
"State": 0,
"Path": "Path to file",
"TrimIn": 0.0,
"TrimOut": 0.0,
"Notes": null,
"Start": "0001-01-01T00:00:00",
"EstimatedStart": "0001-01-01T00:00:00",
"End": "0001-01-01T00:00:00",
"IsFixed": false,
"OriginalDuration": 0.0,
"EstimatedDuration": 0.0,
"Color": null,
"Duration": 900.0,
"Format": null,
"Loop": false,
"Metadata": null
}
enum PlayoutItemType
{
Video = 0,
Audio = 1,
Image = 2,
Event = 3,
Note = 4,
Live = 5,
Web = 6,
Stop = 7
}
enum PlayoutItemState // read only
{
Ready = 0,
Locked = 1,
Playing = 2,
Played = 3,
Missing = 4,
Unable = 5,
Next = 6,
}
Created with the Personal Edition of HelpNDoc: Ensure High-Quality Documentation with HelpNDoc's Hyperlink and Library Item Reports