Modules

On this page

Modules

All content displayed in Xibo is added/edited and served by a Media Module. Xibo has a wide variety of Modules to choose from with more being introduced with new releases.

Modules can be enabled/disabled from the Modules page under the Administration section of the Menu.

Modules are enabled/disabled by using the row menu for the selected Module. Selecting Edit will open a form where an Enabled checkbox can be ticked/unticked. Each Module has a range of available settings, dependent on the Module, which can be adjusted.

Library Modules

At times it may be necessary to add or remove the allowed extensions on a particular file based Module.

A typical use case would be if a Player is being used which does not support that particular type of file.
Screenshot/Image

Generic Files

The Generic File Module is used to send additional files to the Player that can then be used for other purposes.

This could be useful for:

  • Embedded HTML - supplementary files can be provided to be used as relative paths (e.g. An up and down arrow that is dynamically shown in the embedded HTML based on the results of stock data)

Screenshot/Image

Caching and external access

The core Modules are designed to have their data cached and served from the CMS so that they can be played back without an active connection and/or without direct access to external resources that might be required.

The CMS also uses this mechanism to be a good citizen when requesting 3rd party data.

For example, a Ticker Widget with the address http://anexternal.com/feed would only be accessed by the CMS and only once per updateInterval. The Players showing the Layout would not need to access that address directly.
Screenshot/Image

All of the core modules adopt this approach, with the exceptions noted below:

Notable Exceptions

  • The Web Page Module does not cache from the CMS and will always attempt to open the specified web page address using the browser on the Player. This means that the Player must have network access to the web address at all times.
  • The Embedded Module can be cached using library references, however, the User that creates the Module is free to specify external resources should they require them.
  • The Local Video Module is rendered by the video decoder on the Player and can reference an external stream.
  • Flash Files have the capability to reference an external file and will be run on the Player.

Xibo is shipped with all of the stock modules which can be enabled for use.

We prevent the installation of your own or third-party modules with Xibo in the Cloud.

Installing new Modules

New modules must be uploaded to the CMS manually and then installed from the Module Administration screen. Modules which are not installed are detected automatically and will be offered as installation options on the Install Module form.

Click on the Module name to install and refresh the page.

Player Support table for Widgets and Modules - v3 CMS

  • Common Alert Protocol
  • Adobe Flash
  • Agenda
  • Attach Audio
  • Audio
  • Calendar
  • Calendar View
  • Chart
  • Clock
  • Countdown
  • Currencies
  • Dashboards
  • DataSet Ticker
  • DataSet View
  • Dynamic Data
  • Embedded HTML
  • Google Traffic Maps
  • HLS Stream
  • HTML Package
  • Image
  • Image "Fit" Scaling
  • (Preview) Menu Boards
  • Notification
  • PDF
  • PowerPoint
  • Power Point Conversion Service
  • Shell Command
  • Spacer
  • Stocks
  • Sub-Playlist
  • Text
  • Ticker
  • Twitter
  • Twitter Metro
  • Video
  • Video - full screen switch
  • Video In
  • Local Video
  • H.265 HVAC
  • Weather
  • Weather Tiles (On Request)
  • Webpage
  • Webpage - Page load error trigger
  • World Clock
  • Widget Expiry Dates
  • Widgets and Modules
  • Adobe Flash
  • Agenda
  • Attach Audio
  • Audio
  • Calendar
  • Calendar View
  • Chart
  • Clock
  • Countdown
  • Currencies
  • Dashboards
  • DataSet Ticker
  • DataSet View
  • Embedded HTML
  • Google Traffic Maps
  • HLS Stream
  • HTML Package
  • R200
  • R200
  • R200
  • R203
  • Image
  • Image "Fit" Scaling
  • R304
  • R303
  • R303
  • R303
  • (Preview) Menu Boards
  • Notification
  • PDF
  • PowerPoint
  • Shell Command
  • R303
  • R303
  • Spacer
  • Stocks
  • Sub-Playlist
  • Text
  • Ticker
  • Twitter
  • Twitter Metro
  • Video
  • Video - full screen switch
  • R200
  • R253
  • Video In
  • R303
  • Local Video
  • H.265 HVAC
  • 5.0+
  • 8.1+
  • Weather
  • Weather Tiles (On Request)
  • Webpage
  • Webpage - Page load error trigger
  • R303
  • R303
  • R302
  • R302
  • World Clock
  • Widget Expiry Dates
  • R200