Showtimes card

Category: Events. Tags: Schedules, Lobbies and reception, Events and venues.

Previews

Views and forms

Views: canvas, corner, chip. Canvas forms: landscape, portrait, square, strip.

Card views, themes and publishing. Browse the gallery.

Data and privacy

Feed: screenrig.showtimes/v1.

Feed documents carry source attribution. The Player supplies the feed to the card.

Properties

For theme, background, accent and position, see Common properties.

Set static properties in params. Bind data to a project card data key for live values; that document holds only dynamic properties. Without a data key, put the complete configuration in params. Nested rows describe the contents of their parent property.

Static properties

Name	Type	Default	Values and limits	Description
`title`	string	`"Now showing"`	maxLength: `40`
`venue`	string	`""`	maxLength: `60`	The cinema's name, when the feed carries none.
`perPage`	integer	`4`	minimum: `2`; maximum: `6`	Films on a page; further films take the next page.
`pageSeconds`	integer	`12`	minimum: `5`; maximum: `60`	How long each page stays on screen.
`maxTimes`	integer	`4`	minimum: `2`; maximum: `6`	Most session times shown for a film.
`windowHours`	integer	`12`	minimum: `1`; maximum: `48`	Sessions starting later than this are left out.
`graceMinutes`	integer	`10`	minimum: `0`; maximum: `60`	A session stays on the board this long after it starts, as Now.
`fewSeats`	integer	`20`	minimum: `1`; maximum: `500`	Seats left at or below this show in the warning colour.
`staleMinutes`	integer	`30`	minimum: `1`; maximum: `1440`
`hour12`	boolean	`false`

Dynamic properties

Name	Type	Default	Values and limits	Description
`films`	array	`[]`	minItems: `0`; maxItems: `40`	The films and their sessions. A feed (screenrig.showtimes/v1) wins when present; the data store supplies the same rows otherwise.
`films[].id`	string		maxLength: `40`
`films[].title`	string		minLength: `1`; maxLength: `80`; Required
`films[].rating`	string		maxLength: `10`	The classification, for example PG.
`films[].runtimeMin`	number		minimum: `1`; maximum: `600`
`films[].genre`	string		maxLength: `30`
`films[].format`	string		maxLength: `20`	For example IMAX or 3D.
`films[].poster`	string		maxLength: `120`	A media reference (media:<id>).
`films[].sessions`	array	`[]`	minItems: `0`; maxItems: `30`
`films[].sessions[].start`	string		maxLength: `32`; Required	ISO 8601.
`films[].sessions[].screen`	string		maxLength: `20`
`films[].sessions[].format`	string		maxLength: `20`
`films[].sessions[].seatsLeft`	number		minimum: `0`; maximum: `2000`
`films[].sessions[].soldOut`	boolean
`updated`	string	`""`	maxLength: `32`	When the sessions were fetched, ISO 8601 (data store only; a feed carries fetchedAt).

Canvas example

Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.

{
  "id": "showtimes",
  "primitive": "card",
  "card": "showtimes",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "showtimes-main"
}

Write live data

Create this document before showing the card, then replace it to update the screen without republishing. Use the same project as the playlist. Supply your API authorization through the environment; see API authentication.

curl --request PUT "https://api.screenrig.ai/api/card-data/showtimes-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"films":[],"updated":""}}'