casts

Cast content to screens

Put content on air across a set of screens for a period of time, after which the screens automatically revert to their normal content. Send contentKind (media, playlist, app, creative, or schedule), contentId, scopeKind, and optionally scopeNodeId, screenIds, and expiresAt. scopeKind accepts all, node, or screens and defaults to all: a request sent with no scope casts to every screen the caller can reach. An active emergency override takes priority over a cast, and the cast resumes automatically once the emergency is cleared.

Puts one piece of content on the chosen screens now, above their schedule, until it expires or is cleared. An emergency still pre-empts a cast.

post/v1/casts

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/casts
  • Auth: HTTP bearer

Request body

contentKind'media' | 'playlist' | 'app' | 'creative' | 'schedule' required

What kind of thing contentId names.

contentIdstring required

The media, playlist, app instance, creative or schedule to put on air.

contentNamestring

Label for the cast (shown in the console). Defaults to "Cast".

scopeKind'all' | 'node' | 'screens'

Which screens: every screen you can reach (all), one location's subtree (node), or a list (screens). Defaults to all: omit it and the cast goes to EVERY screen you can reach.

scopeNodeIdstring

Location id, with scopeKind: node.

screenIdsstring[]

Screen ids, with scopeKind: screens.

Response

Success.

Example response

{
  "data": {
    "id": "cast_9f2c4a1b7d3e5f60"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.