On Screen Display (OSD) Schema

From XAP Automation
Jump to: navigation, search

On-Screen Display

This describes a set of schema to display text on various display devices. Currently this includes TiVo, Slimdevices SliMP3/Squeezebox and Audrey.

Class = xAP-OSD.Display

Display.TiVo
{
Text=(text to display)
--- mandatory
Duration=(seconds to display)
--- optional
Priority=[High|Medium|Low] (may override current msg)
--- optional (Low is assumed if not stated)
Row=(screen line)
--- optional
Column=(screen column)
--- optional
Foreground=(foreground colour rgb)
--- optional
Background=(background colour rgb)
--- optional
}


Display.SliMP3
{
Line1="Text to display"
--- mandatory
Line2="Text to display"
--- mandatory
Duration="Duration to display in seconds"
--- mandatory
Align1=[Left | Centre | Right]
--- optional (Left aligntment is assumed if not present)
Align2=[Left | Centre | Right]
--- optional (Left aligntment is assumed if not present)
}

Notes:

  • Alignment can be adjusted by including spaces in the text to be displayed.
  • The Alignment setting just gets the display software to do the work in one place rather than in every application that uses this. It additionally decouples the code from the exact dimensions of the display.

Display.Audrey allows Text or a web URL to be pushed to Audrey' touchscreen

Display.Audrey
{
Duration=(seconds to display text)
--- optional (Infinite if not specified)
Text=(text to display)
--- mandatory (unless URL is used)
URL=(URL for browser display)
--- mandatory (unless Text is used)
}

Notes:

  • Text or URL is required, but not both.


Display.ACID allows two lines of data to be sent to the ACID application that runs on the Audrey.

Display.ACID
{
Line1=(text to display)
--- mandatory
Line2=(text to display)
--- optional
}

For display message queue control the following block can be used:

Queue.Clear
{
Clear=[All | Above | EqualOrAbove | Below | EqualOrBelow | Matching]
--- Mandatory
Priority=
--- optional (determined by sending device configuration)
}