[Description("The 'key' for the content that should be added")]
[Description("The 'key' for the content that should be added")]
publicstringContent{get;set;}
publicrequiredstringContent{get;set;}
[Description("The amount of time to add using the referenced content")]
[Description("The amount of time to add using the referenced content")]
publicstringDuration{get;set;}
publicrequiredstringDuration{get;set;}
[Description(
[Description(
"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.")]
"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.")]
publicstringFallback{get;set;}
publicstring?Fallback{get;set;}
[Description("Controls whether content will be trimmed to exactly fit the specified duration")]
[Description("Controls whether content will be trimmed to exactly fit the specified duration")]
publicboolTrim{get;set;}
publicboolTrim{get;set;}
@ -29,10 +29,10 @@ public record PlayoutDuration
publicboolOfflineTail{get;set;}
publicboolOfflineTail{get;set;}
[Description("Flags this content as filler, which influences EPG grouping")]
[Description("Flags this content as filler, which influences EPG grouping")]
publicstringFillerKind{get;set;}
publicstring?FillerKind{get;set;}
[Description("Overrides the title used in the EPG")]
[Description("Overrides the title used in the EPG")]
[Description("The 'key' for the content that should be added")]
[Description("The 'key' for the content that should be added")]
publicstringContent{get;set;}
publicrequiredstringContent{get;set;}
[Description("The minutes interval")]
[Description("The minutes interval")]
publicintMinutes{get;set;}
publicrequiredintMinutes{get;set;}
[Description(
[Description(
"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.")]
"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.")]
publicstringFallback{get;set;}
publicstring?Fallback{get;set;}
[Description("Controls whether content will be trimmed to exactly fit the specified interval")]
[Description("Controls whether content will be trimmed to exactly fit the specified interval")]
publicboolTrim{get;set;}
publicboolTrim{get;set;}
@ -29,10 +29,10 @@ public record PlayoutPadToNext
publicboolOfflineTail{get;set;}=true;
publicboolOfflineTail{get;set;}=true;
[Description("Flags this content as filler, which influences EPG grouping")]
[Description("Flags this content as filler, which influences EPG grouping")]
publicstringFillerKind{get;set;}
publicstring?FillerKind{get;set;}
[Description("Overrides the title used in the EPG")]
[Description("Overrides the title used in the EPG")]
[Description("The 'key' for the content that should be added")]
[Description("The 'key' for the content that should be added")]
publicstringContent{get;set;}
publicrequiredstringContent{get;set;}
[Description("The time of day that content should be added until")]
[Description("The time of day that content should be added until")]
publicstringWhen{get;set;}
publicrequiredstringWhen{get;set;}
[Description(
[Description(
"Only used when the current playout time is already after the specified pad until time. When true, content will be scheduled until the specified time of day (the next day). When false, no content will be scheduled by this request.")]
"Only used when the current playout time is already after the specified pad until time. When true, content will be scheduled until the specified time of day (the next day). When false, no content will be scheduled by this request.")]
@ -16,7 +16,7 @@ public record PlayoutPadUntil
[Description(
[Description(
"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.")]
"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.")]
publicstringFallback{get;set;}
publicstring?Fallback{get;set;}
[Description("Controls whether content will be trimmed to exactly fit until the specified time")]
[Description("Controls whether content will be trimmed to exactly fit until the specified time")]
publicboolTrim{get;set;}
publicboolTrim{get;set;}
@ -34,10 +34,10 @@ public record PlayoutPadUntil
publicboolOfflineTail{get;set;}
publicboolOfflineTail{get;set;}
[Description("Flags this content as filler, which influences EPG grouping")]
[Description("Flags this content as filler, which influences EPG grouping")]
publicstringFillerKind{get;set;}
publicstring?FillerKind{get;set;}
[Description("Overrides the title used in the EPG")]
[Description("Overrides the title used in the EPG")]
[Description("The 'key' for the content that should be added")]
[Description("The 'key' for the content that should be added")]
publicstringContent{get;set;}
publicrequiredstringContent{get;set;}
[Description("The time content should be added until")]
[Description("The time content should be added until")]
publicDateTimeOffsetWhen{get;set;}
publicrequiredDateTimeOffsetWhen{get;set;}
[Description(
[Description(
"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.")]
"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.")]
publicstringFallback{get;set;}
publicstring?Fallback{get;set;}
[Description("Controls whether content will be trimmed to exactly fit until the specified time")]
[Description("Controls whether content will be trimmed to exactly fit until the specified time")]
publicboolTrim{get;set;}
publicboolTrim{get;set;}
@ -30,10 +30,10 @@ public record PlayoutPadUntilExact
publicboolOfflineTail{get;set;}
publicboolOfflineTail{get;set;}
[Description("Flags this content as filler, which influences EPG grouping")]
[Description("Flags this content as filler, which influences EPG grouping")]
publicstringFillerKind{get;set;}
publicstring?FillerKind{get;set;}
[Description("Overrides the title used in the EPG")]
[Description("Overrides the title used in the EPG")]
"description":"The 'key' for the content that should be added",
"description":"The 'key' for the content that should be added"
"nullable":true
},
},
"fillerKind":{
"fillerKind":{
"type":"string",
"type":[
"description":"Flags this content as filler, which influences EPG grouping",
"null",
"nullable":true
"string"
],
"description":"Flags this content as filler, which influences EPG grouping"
},
},
"customTitle":{
"customTitle":{
"type":"string",
"type":[
"description":"Overrides the title used in the EPG",
"null",
"nullable":true
"string"
],
"description":"Overrides the title used in the EPG"
},
},
"disableWatermarks":{
"disableWatermarks":{
"type":"boolean"
"type":"boolean"
@ -1510,60 +1516,64 @@
}
}
},
},
"ContentCollection":{
"ContentCollection":{
"required":[
"key",
"collection"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"description":"Unique name used to reference this content throughout the scripted schedule",
"description":"Unique name used to reference this content throughout the scripted schedule"
"nullable":true
},
},
"collection":{
"collection":{
"type":"string",
"type":"string",
"description":"The name of the existing manual collection",
"description":"The name of the existing manual collection"
"nullable":true
},
},
"order":{
"order":{
"type":"string",
"type":"string",
"description":"The playback order; only chronological and shuffle are currently supported",
"description":"The playback order; only chronological and shuffle are currently supported"
"nullable":true
}
}
}
}
},
},
"ContentCreatePlaylist":{
"ContentCreatePlaylist":{
"required":[
"key",
"items"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"description":"Unique name used to reference this content throughout the scripted schedule",
"description":"Unique name used to reference this content throughout the scripted schedule"
"nullable":true
},
},
"items":{
"items":{
"type":"array",
"type":"array",
"items":{
"items":{
"$ref":"#/components/schemas/PlaylistItem"
"$ref":"#/components/schemas/PlaylistItem"
},
},
"description":"List of playlist items",
"description":"List of playlist items"
"nullable":true
}
}
}
}
},
},
"ContentMarathon":{
"ContentMarathon":{
"required":[
"key",
"groupBy"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"description":"Unique name used to reference this content throughout the scripted schedule",
"description":"Unique name used to reference this content throughout the scripted schedule"
"nullable":true
},
},
"groupBy":{
"groupBy":{
"type":"string",
"type":"string",
"description":"Tells the scheduler how to group the combined content (returned from all guids and searches). Valid values are show, season, artist and album.",
"description":"Tells the scheduler how to group the combined content (returned from all guids and searches). Valid values are show, season, artist and album."
"nullable":true
},
},
"itemOrder":{
"itemOrder":{
"type":"string",
"type":"string",
"description":"Playback order within each group; only chronological and shuffle are currently supported",
"description":"Playback order within each group; only chronological and shuffle are currently supported"
"nullable":true
},
},
"guids":{
"guids":{
"type":"object",
"type":"object",
@ -1573,16 +1583,14 @@
"type":"string"
"type":"string"
}
}
},
},
"description":"List of external content identifiers",
"description":"List of external content identifiers"
"nullable":true
},
},
"searches":{
"searches":{
"type":"array",
"type":"array",
"items":{
"items":{
"type":"string"
"type":"string"
},
},
"description":"List of search queries",
"description":"List of search queries"
"nullable":true
},
},
"playAllItems":{
"playAllItems":{
"type":"boolean",
"type":"boolean",
@ -1595,102 +1603,111 @@
}
}
},
},
"ContentMultiCollection":{
"ContentMultiCollection":{
"required":[
"key",
"multiCollection"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"description":"Unique name used to reference this content throughout the scripted schedule",
"description":"Unique name used to reference this content throughout the scripted schedule"
"nullable":true
},
},
"multiCollection":{
"multiCollection":{
"type":"string",
"type":"string",
"description":"The name of the existing multi-collection",
"description":"The name of the existing multi-collection"
"nullable":true
},
},
"order":{
"order":{
"type":"string",
"type":"string",
"description":"The playback order; only chronological and shuffle are currently supported",
"description":"The playback order; only chronological and shuffle are currently supported"
"nullable":true
}
}
}
}
},
},
"ContentPlaylist":{
"ContentPlaylist":{
"required":[
"key",
"playlist",
"playlistGroup"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"description":"Unique name used to reference this content throughout the scripted schedule",
"description":"Unique name used to reference this content throughout the scripted schedule"
"nullable":true
},
},
"playlist":{
"playlist":{
"type":"string",
"type":"string",
"description":"The name of the existing playlist",
"description":"The name of the existing playlist"
"nullable":true
},
},
"playlistGroup":{
"playlistGroup":{
"type":"string",
"type":"string",
"description":"The name of the existing playlist group that contains the named playlist",
"description":"The name of the existing playlist group that contains the named playlist"
"nullable":true
}
}
}
}
},
},
"ContentSearch":{
"ContentSearch":{
"required":[
"key",
"query"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"nullable":true
"description":"Unique name used to reference this content throughout the scripted schedule"
},
},
"query":{
"query":{
"type":"string",
"type":"string",
"nullable":true
"description":"The search query"
},
},
"order":{
"order":{
"type":"string",
"type":"string",
"nullable":true
"description":"The playback order; only chronological and shuffle are currently supported"
}
}
}
}
},
},
"ContentShow":{
"ContentShow":{
"required":[
"key",
"guids"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"description":"Unique name used to reference this content throughout the scripted schedule",
"description":"Unique name used to reference this content throughout the scripted schedule"
"nullable":true
},
},
"guids":{
"guids":{
"type":"object",
"type":"object",
"additionalProperties":{
"additionalProperties":{
"type":"string"
"type":"string"
},
},
"description":"List of show identifiers",
"description":"List of show identifiers"
"nullable":true
},
},
"order":{
"order":{
"type":"string",
"type":"string",
"description":"The playback order; only chronological and shuffle are currently supported",
"description":"The playback order; only chronological and shuffle are currently supported"
"nullable":true
}
}
}
}
},
},
"ContentSmartCollection":{
"ContentSmartCollection":{
"required":[
"key",
"smartCollection"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"description":"Unique name used to reference this content throughout the scripted schedule",
"description":"Unique name used to reference this content throughout the scripted schedule"
"nullable":true
},
},
"smartCollection":{
"smartCollection":{
"type":"string",
"type":"string",
"description":"The name of the existing smart collection",
"description":"The name of the existing smart collection"
"nullable":true
},
},
"order":{
"order":{
"type":"string",
"type":"string",
"description":"The playback order; only chronological and shuffle are currently supported",
"description":"The playback order; only chronological and shuffle are currently supported"
"nullable":true
}
}
}
}
},
},
@ -1702,12 +1719,14 @@
"items":{
"items":{
"type":"string"
"type":"string"
},
},
"description":"A list of graphics elements to turn off. All graphics elements will be turned off if this list is null or empty",
"description":"A list of graphics elements to turn off. All graphics elements will be turned off if this list is null or empty"
"nullable":true
}
}
}
}
},
},
"ControlGraphicsOn":{
"ControlGraphicsOn":{
"required":[
"graphics"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"graphics":{
"graphics":{
@ -1715,35 +1734,38 @@
"items":{
"items":{
"type":"string"
"type":"string"
},
},
"description":"A list of graphics elements to turn on.",
"description":"A list of graphics elements to turn on."
"nullable":true
},
},
"variables":{
"variables":{
"type":"object",
"type":"object",
"additionalProperties":{
"additionalProperties":{
"type":"string"
"type":"string"
},
}
"nullable":true
}
}
}
}
},
},
"ControlPreRollOn":{
"ControlPreRollOn":{
"required":[
"playlist"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"playlist":{
"playlist":{
"type":"string",
"type":"string",
"description":"The 'key' for the scripted playlist",
"description":"The 'key' for the scripted playlist"
"nullable":true
}
}
}
}
},
},
"ControlSkipItems":{
"ControlSkipItems":{
"required":[
"content",
"count"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content",
"description":"The 'key' for the content"
"nullable":true
},
},
"count":{
"count":{
"type":"integer",
"type":"integer",
@ -1753,12 +1775,16 @@
}
}
},
},
"ControlSkipToItem":{
"ControlSkipToItem":{
"required":[
"content",
"season",
"episode"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content",
"description":"The 'key' for the content"
"nullable":true
},
},
"season":{
"season":{
"type":"integer",
"type":"integer",
@ -1780,19 +1806,23 @@
"description":"When true, will make a new EPG group. When false, will continue the existing EPG group."
"description":"When true, will make a new EPG group. When false, will continue the existing EPG group."
},
},
"customTitle":{
"customTitle":{
"type":"string",
"type":[
"description":"Custom title to apply to all items in the EPG group.",
"null",
"nullable":true
"string"
],
"description":"Custom title to apply to all items in the EPG group."
}
}
}
}
},
},
"ControlWaitUntil":{
"ControlWaitUntil":{
"required":[
"when"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"when":{
"when":{
"type":"string",
"type":"string",
"description":"The time of day to wait (insert unscheduled time) until",
"description":"The time of day to wait (insert unscheduled time) until"
"nullable":true
},
},
"tomorrow":{
"tomorrow":{
"type":"boolean",
"type":"boolean",
@ -1805,6 +1835,9 @@
}
}
},
},
"ControlWaitUntilExact":{
"ControlWaitUntilExact":{
"required":[
"when"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"when":{
"when":{
@ -1826,12 +1859,14 @@
"items":{
"items":{
"type":"string"
"type":"string"
},
},
"description":"A list of existing watermark names to turn off. All (scripted) watermarks will be turned off if this list is null or empty.",
"description":"A list of existing watermark names to turn off. All (scripted) watermarks will be turned off if this list is null or empty."
"nullable":true
}
}
}
}
},
},
"ControlWatermarkOn":{
"ControlWatermarkOn":{
"required":[
"watermark"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"watermark":{
"watermark":{
@ -1839,17 +1874,19 @@
"items":{
"items":{
"type":"string"
"type":"string"
},
},
"description":"A list of existing watermark names to turn on",
"description":"A list of existing watermark names to turn on"
"nullable":true
}
}
}
}
},
},
"PeekItemDuration":{
"PeekItemDuration":{
"required":[
"content",
"milliseconds"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string"
"nullable":true
},
},
"milliseconds":{
"milliseconds":{
"type":"integer",
"type":"integer",
@ -1859,12 +1896,15 @@
}
}
},
},
"PlaylistItem":{
"PlaylistItem":{
"required":[
"content",
"count"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content",
"description":"The 'key' for the content"
"nullable":true
},
},
"count":{
"count":{
"type":"integer",
"type":"integer",
@ -1873,6 +1913,12 @@
}
}
},
},
"PlayoutContext":{
"PlayoutContext":{
"required":[
"currentTime",
"startTime",
"finishTime",
"isDone"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"currentTime":{
"currentTime":{
@ -1897,26 +1943,33 @@
}
}
},
},
"PlayoutCount":{
"PlayoutCount":{
"required":[
"content",
"count"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content that should be added",
"description":"The 'key' for the content that should be added"
"nullable":true
},
},
"count":{
"count":{
"type":"integer",
"type":"integer",
"format":"int32"
"format":"int32"
},
},
"fillerKind":{
"fillerKind":{
"type":"string",
"type":[
"description":"Flags this content as filler, which influences EPG grouping",
"null",
"nullable":true
"string"
],
"description":"Flags this content as filler, which influences EPG grouping"
},
},
"customTitle":{
"customTitle":{
"type":"string",
"type":[
"description":"Overrides the title used in the EPG",
"null",
"nullable":true
"string"
],
"description":"Overrides the title used in the EPG"
},
},
"disableWatermarks":{
"disableWatermarks":{
"type":"boolean"
"type":"boolean"
@ -1924,22 +1977,26 @@
}
}
},
},
"PlayoutDuration":{
"PlayoutDuration":{
"required":[
"content",
"duration"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content that should be added",
"description":"The 'key' for the content that should be added"
"nullable":true
},
},
"duration":{
"duration":{
"type":"string",
"type":"string",
"description":"The amount of time to add using the referenced content",
"description":"The amount of time to add using the referenced content"
"nullable":true
},
},
"fallback":{
"fallback":{
"type":"string",
"type":[
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.",
"null",
"nullable":true
"string"
],
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit."
},
},
"trim":{
"trim":{
"type":"boolean",
"type":"boolean",
@ -1959,14 +2016,18 @@
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified duration will be unscheduled (offline)"
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified duration will be unscheduled (offline)"
},
},
"fillerKind":{
"fillerKind":{
"type":"string",
"type":[
"description":"Flags this content as filler, which influences EPG grouping",
"null",
"nullable":true
"string"
],
"description":"Flags this content as filler, which influences EPG grouping"
},
},
"customTitle":{
"customTitle":{
"type":"string",
"type":[
"description":"Overrides the title used in the EPG",
"null",
"nullable":true
"string"
],
"description":"Overrides the title used in the EPG"
},
},
"disableWatermarks":{
"disableWatermarks":{
"type":"boolean"
"type":"boolean"
@ -1974,12 +2035,15 @@
}
}
},
},
"PlayoutPadToNext":{
"PlayoutPadToNext":{
"required":[
"content",
"minutes"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content that should be added",
"description":"The 'key' for the content that should be added"
"nullable":true
},
},
"minutes":{
"minutes":{
"type":"integer",
"type":"integer",
@ -1987,9 +2051,11 @@
"format":"int32"
"format":"int32"
},
},
"fallback":{
"fallback":{
"type":"string",
"type":[
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.",
"null",
"nullable":true
"string"
],
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit."
},
},
"trim":{
"trim":{
"type":"boolean",
"type":"boolean",
@ -2009,14 +2075,18 @@
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified interval will be unscheduled (offline)"
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified interval will be unscheduled (offline)"
},
},
"fillerKind":{
"fillerKind":{
"type":"string",
"type":[
"description":"Flags this content as filler, which influences EPG grouping",
"null",
"nullable":true
"string"
],
"description":"Flags this content as filler, which influences EPG grouping"
},
},
"customTitle":{
"customTitle":{
"type":"string",
"type":[
"description":"Overrides the title used in the EPG",
"null",
"nullable":true
"string"
],
"description":"Overrides the title used in the EPG"
},
},
"disableWatermarks":{
"disableWatermarks":{
"type":"boolean"
"type":"boolean"
@ -2024,26 +2094,30 @@
}
}
},
},
"PlayoutPadUntil":{
"PlayoutPadUntil":{
"required":[
"content",
"when"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content that should be added",
"description":"The 'key' for the content that should be added"
"nullable":true
},
},
"when":{
"when":{
"type":"string",
"type":"string",
"description":"The time of day that content should be added until",
"description":"The time of day that content should be added until"
"nullable":true
},
},
"tomorrow":{
"tomorrow":{
"type":"boolean",
"type":"boolean",
"description":"Only used when the current playout time is already after the specified pad until time. When true, content will be scheduled until the specified time of day (the next day). When false, no content will be scheduled by this request."
"description":"Only used when the current playout time is already after the specified pad until time. When true, content will be scheduled until the specified time of day (the next day). When false, no content will be scheduled by this request."
},
},
"fallback":{
"fallback":{
"type":"string",
"type":[
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.",
"null",
"nullable":true
"string"
],
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit."
},
},
"trim":{
"trim":{
"type":"boolean",
"type":"boolean",
@ -2063,14 +2137,18 @@
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified interval will be unscheduled (offline)"
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified interval will be unscheduled (offline)"
},
},
"fillerKind":{
"fillerKind":{
"type":"string",
"type":[
"description":"Flags this content as filler, which influences EPG grouping",
"null",
"nullable":true
"string"
],
"description":"Flags this content as filler, which influences EPG grouping"
},
},
"customTitle":{
"customTitle":{
"type":"string",
"type":[
"description":"Overrides the title used in the EPG",
"null",
"nullable":true
"string"
],
"description":"Overrides the title used in the EPG"
},
},
"disableWatermarks":{
"disableWatermarks":{
"type":"boolean"
"type":"boolean"
@ -2078,12 +2156,15 @@
}
}
},
},
"PlayoutPadUntilExact":{
"PlayoutPadUntilExact":{
"required":[
"content",
"when"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content that should be added",
"description":"The 'key' for the content that should be added"
"nullable":true
},
},
"when":{
"when":{
"type":"string",
"type":"string",
@ -2091,9 +2172,11 @@
"format":"date-time"
"format":"date-time"
},
},
"fallback":{
"fallback":{
"type":"string",
"type":[
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.",
"null",
"nullable":true
"string"
],
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit."
},
},
"trim":{
"trim":{
"type":"boolean",
"type":"boolean",
@ -2113,14 +2196,18 @@
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified interval will be unscheduled (offline)"
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified interval will be unscheduled (offline)"
},
},
"fillerKind":{
"fillerKind":{
"type":"string",
"type":[
"description":"Flags this content as filler, which influences EPG grouping",
"null",
"nullable":true
"string"
],
"description":"Flags this content as filler, which influences EPG grouping"
},
},
"customTitle":{
"customTitle":{
"type":"string",
"type":[
"description":"Overrides the title used in the EPG",
"null",
"nullable":true
"string"
],
"description":"Overrides the title used in the EPG"
"description":"The 'key' for the content that should be added",
"description":"The 'key' for the content that should be added"
"nullable":true
},
},
"fillerKind":{
"fillerKind":{
"type":"string",
"type":[
"description":"Flags this content as filler, which influences EPG grouping",
"null",
"nullable":true
"string"
],
"description":"Flags this content as filler, which influences EPG grouping"
},
},
"customTitle":{
"customTitle":{
"type":"string",
"type":[
"description":"Overrides the title used in the EPG",
"null",
"nullable":true
"string"
],
"description":"Overrides the title used in the EPG"
},
},
"disableWatermarks":{
"disableWatermarks":{
"type":"boolean"
"type":"boolean"
@ -1510,60 +1516,64 @@
}
}
},
},
"ContentCollection":{
"ContentCollection":{
"required":[
"key",
"collection"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"description":"Unique name used to reference this content throughout the scripted schedule",
"description":"Unique name used to reference this content throughout the scripted schedule"
"nullable":true
},
},
"collection":{
"collection":{
"type":"string",
"type":"string",
"description":"The name of the existing manual collection",
"description":"The name of the existing manual collection"
"nullable":true
},
},
"order":{
"order":{
"type":"string",
"type":"string",
"description":"The playback order; only chronological and shuffle are currently supported",
"description":"The playback order; only chronological and shuffle are currently supported"
"nullable":true
}
}
}
}
},
},
"ContentCreatePlaylist":{
"ContentCreatePlaylist":{
"required":[
"key",
"items"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"description":"Unique name used to reference this content throughout the scripted schedule",
"description":"Unique name used to reference this content throughout the scripted schedule"
"nullable":true
},
},
"items":{
"items":{
"type":"array",
"type":"array",
"items":{
"items":{
"$ref":"#/components/schemas/PlaylistItem"
"$ref":"#/components/schemas/PlaylistItem"
},
},
"description":"List of playlist items",
"description":"List of playlist items"
"nullable":true
}
}
}
}
},
},
"ContentMarathon":{
"ContentMarathon":{
"required":[
"key",
"groupBy"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"description":"Unique name used to reference this content throughout the scripted schedule",
"description":"Unique name used to reference this content throughout the scripted schedule"
"nullable":true
},
},
"groupBy":{
"groupBy":{
"type":"string",
"type":"string",
"description":"Tells the scheduler how to group the combined content (returned from all guids and searches). Valid values are show, season, artist and album.",
"description":"Tells the scheduler how to group the combined content (returned from all guids and searches). Valid values are show, season, artist and album."
"nullable":true
},
},
"itemOrder":{
"itemOrder":{
"type":"string",
"type":"string",
"description":"Playback order within each group; only chronological and shuffle are currently supported",
"description":"Playback order within each group; only chronological and shuffle are currently supported"
"nullable":true
},
},
"guids":{
"guids":{
"type":"object",
"type":"object",
@ -1573,16 +1583,14 @@
"type":"string"
"type":"string"
}
}
},
},
"description":"List of external content identifiers",
"description":"List of external content identifiers"
"nullable":true
},
},
"searches":{
"searches":{
"type":"array",
"type":"array",
"items":{
"items":{
"type":"string"
"type":"string"
},
},
"description":"List of search queries",
"description":"List of search queries"
"nullable":true
},
},
"playAllItems":{
"playAllItems":{
"type":"boolean",
"type":"boolean",
@ -1595,102 +1603,111 @@
}
}
},
},
"ContentMultiCollection":{
"ContentMultiCollection":{
"required":[
"key",
"multiCollection"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"description":"Unique name used to reference this content throughout the scripted schedule",
"description":"Unique name used to reference this content throughout the scripted schedule"
"nullable":true
},
},
"multiCollection":{
"multiCollection":{
"type":"string",
"type":"string",
"description":"The name of the existing multi-collection",
"description":"The name of the existing multi-collection"
"nullable":true
},
},
"order":{
"order":{
"type":"string",
"type":"string",
"description":"The playback order; only chronological and shuffle are currently supported",
"description":"The playback order; only chronological and shuffle are currently supported"
"nullable":true
}
}
}
}
},
},
"ContentPlaylist":{
"ContentPlaylist":{
"required":[
"key",
"playlist",
"playlistGroup"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"description":"Unique name used to reference this content throughout the scripted schedule",
"description":"Unique name used to reference this content throughout the scripted schedule"
"nullable":true
},
},
"playlist":{
"playlist":{
"type":"string",
"type":"string",
"description":"The name of the existing playlist",
"description":"The name of the existing playlist"
"nullable":true
},
},
"playlistGroup":{
"playlistGroup":{
"type":"string",
"type":"string",
"description":"The name of the existing playlist group that contains the named playlist",
"description":"The name of the existing playlist group that contains the named playlist"
"nullable":true
}
}
}
}
},
},
"ContentSearch":{
"ContentSearch":{
"required":[
"key",
"query"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"nullable":true
"description":"Unique name used to reference this content throughout the scripted schedule"
},
},
"query":{
"query":{
"type":"string",
"type":"string",
"nullable":true
"description":"The search query"
},
},
"order":{
"order":{
"type":"string",
"type":"string",
"nullable":true
"description":"The playback order; only chronological and shuffle are currently supported"
}
}
}
}
},
},
"ContentShow":{
"ContentShow":{
"required":[
"key",
"guids"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"description":"Unique name used to reference this content throughout the scripted schedule",
"description":"Unique name used to reference this content throughout the scripted schedule"
"nullable":true
},
},
"guids":{
"guids":{
"type":"object",
"type":"object",
"additionalProperties":{
"additionalProperties":{
"type":"string"
"type":"string"
},
},
"description":"List of show identifiers",
"description":"List of show identifiers"
"nullable":true
},
},
"order":{
"order":{
"type":"string",
"type":"string",
"description":"The playback order; only chronological and shuffle are currently supported",
"description":"The playback order; only chronological and shuffle are currently supported"
"nullable":true
}
}
}
}
},
},
"ContentSmartCollection":{
"ContentSmartCollection":{
"required":[
"key",
"smartCollection"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"key":{
"key":{
"type":"string",
"type":"string",
"description":"Unique name used to reference this content throughout the scripted schedule",
"description":"Unique name used to reference this content throughout the scripted schedule"
"nullable":true
},
},
"smartCollection":{
"smartCollection":{
"type":"string",
"type":"string",
"description":"The name of the existing smart collection",
"description":"The name of the existing smart collection"
"nullable":true
},
},
"order":{
"order":{
"type":"string",
"type":"string",
"description":"The playback order; only chronological and shuffle are currently supported",
"description":"The playback order; only chronological and shuffle are currently supported"
"nullable":true
}
}
}
}
},
},
@ -1702,12 +1719,14 @@
"items":{
"items":{
"type":"string"
"type":"string"
},
},
"description":"A list of graphics elements to turn off. All graphics elements will be turned off if this list is null or empty",
"description":"A list of graphics elements to turn off. All graphics elements will be turned off if this list is null or empty"
"nullable":true
}
}
}
}
},
},
"ControlGraphicsOn":{
"ControlGraphicsOn":{
"required":[
"graphics"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"graphics":{
"graphics":{
@ -1715,35 +1734,38 @@
"items":{
"items":{
"type":"string"
"type":"string"
},
},
"description":"A list of graphics elements to turn on.",
"description":"A list of graphics elements to turn on."
"nullable":true
},
},
"variables":{
"variables":{
"type":"object",
"type":"object",
"additionalProperties":{
"additionalProperties":{
"type":"string"
"type":"string"
},
}
"nullable":true
}
}
}
}
},
},
"ControlPreRollOn":{
"ControlPreRollOn":{
"required":[
"playlist"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"playlist":{
"playlist":{
"type":"string",
"type":"string",
"description":"The 'key' for the scripted playlist",
"description":"The 'key' for the scripted playlist"
"nullable":true
}
}
}
}
},
},
"ControlSkipItems":{
"ControlSkipItems":{
"required":[
"content",
"count"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content",
"description":"The 'key' for the content"
"nullable":true
},
},
"count":{
"count":{
"type":"integer",
"type":"integer",
@ -1753,12 +1775,16 @@
}
}
},
},
"ControlSkipToItem":{
"ControlSkipToItem":{
"required":[
"content",
"season",
"episode"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content",
"description":"The 'key' for the content"
"nullable":true
},
},
"season":{
"season":{
"type":"integer",
"type":"integer",
@ -1780,19 +1806,23 @@
"description":"When true, will make a new EPG group. When false, will continue the existing EPG group."
"description":"When true, will make a new EPG group. When false, will continue the existing EPG group."
},
},
"customTitle":{
"customTitle":{
"type":"string",
"type":[
"description":"Custom title to apply to all items in the EPG group.",
"null",
"nullable":true
"string"
],
"description":"Custom title to apply to all items in the EPG group."
}
}
}
}
},
},
"ControlWaitUntil":{
"ControlWaitUntil":{
"required":[
"when"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"when":{
"when":{
"type":"string",
"type":"string",
"description":"The time of day to wait (insert unscheduled time) until",
"description":"The time of day to wait (insert unscheduled time) until"
"nullable":true
},
},
"tomorrow":{
"tomorrow":{
"type":"boolean",
"type":"boolean",
@ -1805,6 +1835,9 @@
}
}
},
},
"ControlWaitUntilExact":{
"ControlWaitUntilExact":{
"required":[
"when"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"when":{
"when":{
@ -1826,12 +1859,14 @@
"items":{
"items":{
"type":"string"
"type":"string"
},
},
"description":"A list of existing watermark names to turn off. All (scripted) watermarks will be turned off if this list is null or empty.",
"description":"A list of existing watermark names to turn off. All (scripted) watermarks will be turned off if this list is null or empty."
"nullable":true
}
}
}
}
},
},
"ControlWatermarkOn":{
"ControlWatermarkOn":{
"required":[
"watermark"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"watermark":{
"watermark":{
@ -1839,17 +1874,19 @@
"items":{
"items":{
"type":"string"
"type":"string"
},
},
"description":"A list of existing watermark names to turn on",
"description":"A list of existing watermark names to turn on"
"nullable":true
}
}
}
}
},
},
"PeekItemDuration":{
"PeekItemDuration":{
"required":[
"content",
"milliseconds"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string"
"nullable":true
},
},
"milliseconds":{
"milliseconds":{
"type":"integer",
"type":"integer",
@ -1859,12 +1896,15 @@
}
}
},
},
"PlaylistItem":{
"PlaylistItem":{
"required":[
"content",
"count"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content",
"description":"The 'key' for the content"
"nullable":true
},
},
"count":{
"count":{
"type":"integer",
"type":"integer",
@ -1873,6 +1913,12 @@
}
}
},
},
"PlayoutContext":{
"PlayoutContext":{
"required":[
"currentTime",
"startTime",
"finishTime",
"isDone"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"currentTime":{
"currentTime":{
@ -1897,26 +1943,33 @@
}
}
},
},
"PlayoutCount":{
"PlayoutCount":{
"required":[
"content",
"count"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content that should be added",
"description":"The 'key' for the content that should be added"
"nullable":true
},
},
"count":{
"count":{
"type":"integer",
"type":"integer",
"format":"int32"
"format":"int32"
},
},
"fillerKind":{
"fillerKind":{
"type":"string",
"type":[
"description":"Flags this content as filler, which influences EPG grouping",
"null",
"nullable":true
"string"
],
"description":"Flags this content as filler, which influences EPG grouping"
},
},
"customTitle":{
"customTitle":{
"type":"string",
"type":[
"description":"Overrides the title used in the EPG",
"null",
"nullable":true
"string"
],
"description":"Overrides the title used in the EPG"
},
},
"disableWatermarks":{
"disableWatermarks":{
"type":"boolean"
"type":"boolean"
@ -1924,22 +1977,26 @@
}
}
},
},
"PlayoutDuration":{
"PlayoutDuration":{
"required":[
"content",
"duration"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content that should be added",
"description":"The 'key' for the content that should be added"
"nullable":true
},
},
"duration":{
"duration":{
"type":"string",
"type":"string",
"description":"The amount of time to add using the referenced content",
"description":"The amount of time to add using the referenced content"
"nullable":true
},
},
"fallback":{
"fallback":{
"type":"string",
"type":[
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.",
"null",
"nullable":true
"string"
],
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit."
},
},
"trim":{
"trim":{
"type":"boolean",
"type":"boolean",
@ -1959,14 +2016,18 @@
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified duration will be unscheduled (offline)"
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified duration will be unscheduled (offline)"
},
},
"fillerKind":{
"fillerKind":{
"type":"string",
"type":[
"description":"Flags this content as filler, which influences EPG grouping",
"null",
"nullable":true
"string"
],
"description":"Flags this content as filler, which influences EPG grouping"
},
},
"customTitle":{
"customTitle":{
"type":"string",
"type":[
"description":"Overrides the title used in the EPG",
"null",
"nullable":true
"string"
],
"description":"Overrides the title used in the EPG"
},
},
"disableWatermarks":{
"disableWatermarks":{
"type":"boolean"
"type":"boolean"
@ -1974,12 +2035,15 @@
}
}
},
},
"PlayoutPadToNext":{
"PlayoutPadToNext":{
"required":[
"content",
"minutes"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content that should be added",
"description":"The 'key' for the content that should be added"
"nullable":true
},
},
"minutes":{
"minutes":{
"type":"integer",
"type":"integer",
@ -1987,9 +2051,11 @@
"format":"int32"
"format":"int32"
},
},
"fallback":{
"fallback":{
"type":"string",
"type":[
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.",
"null",
"nullable":true
"string"
],
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit."
},
},
"trim":{
"trim":{
"type":"boolean",
"type":"boolean",
@ -2009,14 +2075,18 @@
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified interval will be unscheduled (offline)"
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified interval will be unscheduled (offline)"
},
},
"fillerKind":{
"fillerKind":{
"type":"string",
"type":[
"description":"Flags this content as filler, which influences EPG grouping",
"null",
"nullable":true
"string"
],
"description":"Flags this content as filler, which influences EPG grouping"
},
},
"customTitle":{
"customTitle":{
"type":"string",
"type":[
"description":"Overrides the title used in the EPG",
"null",
"nullable":true
"string"
],
"description":"Overrides the title used in the EPG"
},
},
"disableWatermarks":{
"disableWatermarks":{
"type":"boolean"
"type":"boolean"
@ -2024,26 +2094,30 @@
}
}
},
},
"PlayoutPadUntil":{
"PlayoutPadUntil":{
"required":[
"content",
"when"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content that should be added",
"description":"The 'key' for the content that should be added"
"nullable":true
},
},
"when":{
"when":{
"type":"string",
"type":"string",
"description":"The time of day that content should be added until",
"description":"The time of day that content should be added until"
"nullable":true
},
},
"tomorrow":{
"tomorrow":{
"type":"boolean",
"type":"boolean",
"description":"Only used when the current playout time is already after the specified pad until time. When true, content will be scheduled until the specified time of day (the next day). When false, no content will be scheduled by this request."
"description":"Only used when the current playout time is already after the specified pad until time. When true, content will be scheduled until the specified time of day (the next day). When false, no content will be scheduled by this request."
},
},
"fallback":{
"fallback":{
"type":"string",
"type":[
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.",
"null",
"nullable":true
"string"
],
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit."
},
},
"trim":{
"trim":{
"type":"boolean",
"type":"boolean",
@ -2063,14 +2137,18 @@
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified interval will be unscheduled (offline)"
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified interval will be unscheduled (offline)"
},
},
"fillerKind":{
"fillerKind":{
"type":"string",
"type":[
"description":"Flags this content as filler, which influences EPG grouping",
"null",
"nullable":true
"string"
],
"description":"Flags this content as filler, which influences EPG grouping"
},
},
"customTitle":{
"customTitle":{
"type":"string",
"type":[
"description":"Overrides the title used in the EPG",
"null",
"nullable":true
"string"
],
"description":"Overrides the title used in the EPG"
},
},
"disableWatermarks":{
"disableWatermarks":{
"type":"boolean"
"type":"boolean"
@ -2078,12 +2156,15 @@
}
}
},
},
"PlayoutPadUntilExact":{
"PlayoutPadUntilExact":{
"required":[
"content",
"when"
],
"type":"object",
"type":"object",
"properties":{
"properties":{
"content":{
"content":{
"type":"string",
"type":"string",
"description":"The 'key' for the content that should be added",
"description":"The 'key' for the content that should be added"
"nullable":true
},
},
"when":{
"when":{
"type":"string",
"type":"string",
@ -2091,9 +2172,11 @@
"format":"date-time"
"format":"date-time"
},
},
"fallback":{
"fallback":{
"type":"string",
"type":[
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit.",
"null",
"nullable":true
"string"
],
"description":"The 'key' for the content that should be used to fill any remaining unscheduled time. One item will be selected to be looped and trimmed to exactly fit."
},
},
"trim":{
"trim":{
"type":"boolean",
"type":"boolean",
@ -2113,14 +2196,18 @@
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified interval will be unscheduled (offline)"
"description":"When true, afer scheduling everything that will fit, any remaining time from the specified interval will be unscheduled (offline)"
},
},
"fillerKind":{
"fillerKind":{
"type":"string",
"type":[
"description":"Flags this content as filler, which influences EPG grouping",
"null",
"nullable":true
"string"
],
"description":"Flags this content as filler, which influences EPG grouping"
},
},
"customTitle":{
"customTitle":{
"type":"string",
"type":[
"description":"Overrides the title used in the EPG",
"null",
"nullable":true
"string"
],
"description":"Overrides the title used in the EPG"