generate
Description
The generate endpoint is used to generate playlists server-side.
See also:
Endpoint
https://air.control-prod.broadsign.com/playlist/v1/generate
HTTP Method
POST
Request Body Parameters
Parameter | Description | Type | Required (R) or Optional (O) |
---|---|---|---|
player_identifier | Unique Broadsign Control Player identifier, expected to represent a unique venue. | string | R |
active_conditions | Uses active conditions to generate playlists specific for those conditions. Passes an array of Condition objects. | Array of Condition | O |
Condition.name | Name of the condition. If active_conditions is used, this is mandatory. |
string | R |
Condition.exclusive | If set to "true", after generating the loop, the player will strip out all slots that are without this condition.
|
boolean | O |
screen_identifier | Identifier for one screen within a venue. | string | O |
duration |
Time duration, in seconds, covered by the generated Playlist. The default value is 1 hour (3,600 seconds). The maximum supported value is 48 hours (172,800 seconds). For example, if the duration is 1 hour, the returned Playlist will cover the next hour. The total duration of the returned items may be shorter than the covered time, for example if there are times where nothing is scheduled to play. See api.proto for definition. |
google.protobuf.Duration | O |
next_expected_poll |
Defines whether the player is online, offline, or mia. The format <year>-<month>-<day>T<hour>:<minute>:<seconds>.<milliseconds>Z is supported. For example: 2021-09-23T20:00:00.000Z. If this parameter is not specified in the request, the player is considered offline. Note: If the See api.proto for definition. |
google.protobuf.Timestamp | O |
Response
Refer to Response for complete information about the Broadsign Air Response parameters.