playlists

Add an item to a playlist

Append one item to a playlist with refKind, refId, and an optional durationSec and other fields. Rejects references from another space, and rejects any nesting that would create a loop, such as a playlist referencing a layout zone that contains the same playlist, with a clear error rather than failing silently.

Appends one item. A video or audio file defaults to playing its full length, an animated image to one loop, anything else to 10 seconds. Returns the whole playlist.

Notes.

  • position is accepted and ignored.
  • The returned approvalState is the value from before the edit; an approved playlist is returned to draft in storage by this call. Re-read with GET to see it.
post/v1/playlists/{id}/items

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/playlists/{id}/items
  • Auth: HTTP bearer

Path parameters

idstring required

Playlist id.

Request body

refKind'media' | 'playlist' | 'app' | 'layout' | 'ad-slot' required
refIdstring required
durationMode'fixed' | 'full' | 'live' | 'loop' | 'manual'
durationSecondsinteger
loopCountnumber
fitstring

contain, cover, fill or blur-fill; anything else means inherit.

fullscreenboolean
playOnlyWhenTappedboolean

Skip it in the rotation; show it only from a show-design tap. Default false.

positionnumber

Accepted but ignored: the item is always appended. Reorder with PUT /v1/playlists/{id}/items.

allocationIdstring

Response

Success.

Example response

{
  "data": {
    "id": "pl_4d5e6f7a8b9c0d1e",
    "items": [
      {
        "id": "pli_7a8b9c0d1e2f3a4b"
      }
    ]
  }
}

Changes

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