ScheduleSlot

One stretch of the station's day: from this time, on these days, the station plays this

Attributes (34)

Attribute	Type	Required	Description
id	string	Yes	read-only
label	string	Yes	What the operator calls this stretch of the day. Becomes the broadcast's name
startsAtMinutes	number	Yes	When it starts, as minutes past midnight on the station's clock
endsAtMinutes	number	Yes	When it stops, in the same terms. Before the start means the block runs past midnight, which is ordinary for a late show; equal to it means a full twenty-four hours
days	number[]	No	The weekdays it runs on, Sunday 0. Absent or empty means every day
sourcePluginId	string	No	The plugin the records come from. Absent, with no playlist, is a slot the station fills itself
sourcePlaylistId	string	No
sourceChartId	string	No	A published chart to play instead, as pluginId:chartId. An ALTERNATIVE to the playlist pair rather than a companion, and it wins if both are sent: a playlist names copies the station can already fetch and a chart names records it has to look up
sourceChartOrder	'countdown' | 'ranked' | 'unordered'	No	Which way round that chart is played. Absent is countdown, which ends on number one. Ignored without sourceChartId
sourceStationPlaylistId	string	No	A playlist the station owns to play instead, read from the station's own library when the block starts rather than from a provider. An ALTERNATIVE to the playlist pair, which it wins over, and to sourceChartId, which wins over it
personaId	string	No	Who hosts this stretch of the day. Absent means the station's own active persona
brief	string	No	What this stretch of the day is asked to play, in the operator's own words. The same ceiling PutOnAirInput.brief has, because a changeover builds one of those from this and the two boxes are one field set on the console
eraFrom	number	No	The earliest release year this stretch of the day plays. Absent means no lower bound, and a record whose year the catalog does not know is played whatever the period
eraTo	number	No	The latest release year, on the same terms. Set with eraFrom for a decade; either may stand alone
moods	('love' | 'happiness' | 'comfort' | 'sadness' | 'loneliness' | 'anger' | 'fear')[]	No	The moods this stretch of the day leans into, as stages in order: the first for its opening stretch, the last for its close, each an equal share of the slot. Records a model has judged to be in the stage's mood are a little more likely to be picked; nothing is ever kept off the air for it. One mood leans the whole slot one way. Absent or empty is no lean
avoidMoods	('love' | 'happiness' | 'comfort' | 'sadness' | 'loneliness' | 'anger' | 'fear')[]	No	The moods this stretch of the day steers away from, for the whole of it. Records a model has judged to be in one are less likely to be picked, half as likely; nothing is ever kept off the air for it, and a never-play rule is the way to refuse a genre outright. Absent or empty avoids nothing
breaks	boolean	No	Whether the host talks between the records during this stretch of the day. Absent is the mode's own answer: a rotation talks and a setlist does not. Set it true on a setlist for a chart countdown with a host, which talks as often as the station does while the records play exactly as the setlist has them. A feature stays silent whatever this says
callins	boolean	No	Whether somebody phones in during this stretch of the day. Absent is no calls, exactly as it is when an operator puts a broadcast on air by hand; a setlist or a feature takes no calls whatever this says
mixInSimilar	boolean	No	Whether records that sound like this slot's playlist are mixed in among its records, one every rotation.mixInEvery records. Absent leaves the station's own setting standing, exactly as it does when an operator airs a playlist by hand; a slot with no playlist, or a setlist or a feature, never mixes whatever this says
chartPositions	boolean	No	Whether the host says where the chart placed each record it named: "number seven on the Hot 100". Absent is yes, exactly as it is when an operator puts a chart on air by hand. Set it false to air this slot's chart without its positions read out
requestShow	boolean	No	Whether this stretch of the day is a request show: each listener request placed in it is followed by records that sound like it, in place of what was planned. Absent is no. A setlist or a feature never has a request followed, since that would throw its own sequence away
requestFollowOn	number	No	How many records follow each request on a request show. Absent is 4. Ignored unless requestShow is true
repeatWindowDays	number	No	Days a record rests after airing before this stretch of the day may play it again, in place of the station's rotation.repeatWindowDays. 0 lifts the window. Absent keeps the mode's own answer: the station's for a rotation, none for a setlist or a feature. A lift never reaches a dislike or a never-play rule
artistCooldownMinutes	number	No	Minutes an artist rests after airing during this stretch of the day, in place of the station's rotation.artistCooldownMinutes. 0 lifts the cooldown, which is what an hour of one artist needs first. Absent keeps the mode's own answer, on repeatWindowDays' terms
maxPerArtist	number	No	Most records by one artist in each batch the station programmes for this stretch of the day, in place of the station's rotation.maxPerArtist. 0 lifts the cap. Absent keeps the mode's own answer, on repeatWindowDays' terms
writerOrder	'model' | 'station'	No	Which writer is asked first for this stretch of the day's breaks, in place of the station's llm.breakWriterOrder: model, with the station's own words underneath, or station, the phrasings, headlines and stories as written with the model underneath. Absent keeps the station's setting. Changes nothing while the model is switched off
startsOn	string	No	The first date this slot runs on, as YYYY-MM-DD, which makes it a SPECIAL rather than a weekly slot. On its dates a special takes over from the weekly schedule for its hours, and the weekly show resumes when it ends. Sent with endsOn or not at all
endsOn	string	No	The last date it runs on, inclusive. days still applies in between, so the Fridays in December are a range and a mask
coHosts	SlotCoHost[]	No	Who presents beside the slot's host, in order: every night, on fixed nights, or as a visitor who turns up at random. At most three are on any one night; a visitor who wins a night that is already full sits it out
guestHosts	SlotGuestHost[]	No	Hosts who sit in for this slot's own host on some nights, in precedence order: the first whose night it is takes it. A guest on fixed nights wins over one at random. Absent or empty is a slot its own host presents every time
yearly	boolean	No	Whether the special repeats every year on the same month and day, such as Halloween. Absent is a one-off. A yearly range may run past New Year and must be shorter than a year
resumePlaylist	boolean	No	Whether a playlist slot picks its playlist up where it left off: each time it opens, it starts with the record after the last one from the playlist that aired, rather than from the top. Absent is no. A record no longer on the playlist starts it from the top again, and so does changing the slot's source. Ignored for a chart or a slot with no playlist
mode	'rotation' | 'setlist' | 'feature'	Yes
onEnd	'extend' | 'repeat' | 'stop'	Yes