dsplay_media

Everything the player knows about the media on screen, in one flat object: general fields for every media type, plus the fields of each type.

var dsplay_media = {
  // General fields (all media types)
  id: 1, // Media ID
  name: 'My Media', // Media name
  count: 25, // How many media items the player has played so far
  iteration: 4, // How many times this media has been played so far
  duration: 15000, // Media duration in milliseconds
  // type-specific fields...
}

String values have $ replaced by $. Lists are sent as JSON arrays.

Media types

Media Templates
Image Image, Photo Collage
Message Countdown, Count Up, Wi-Fi, Meeting Room, Flight Information, Building Directions
RSS RSS
Weather Weather Forecast
Twitter Twitter Basic
Instagram Instagram Basic, Instagram Image Only
Facebook Facebook Posts
Ticket Calling Chamador Loterias Caixa
JSON Service Lottery (Brazil), Exchange Rates, Menu Board

Video, audio, website, YouTube, video stream and playlist media don’t use templates.


Table of contents


Copyright © 2012-2026 DSPLAY - Digital Signage. Distributed by an MIT license.

This site uses Just the Docs, a documentation theme for Jekyll.