Global Variables

Global variables are set, by default, on all Premium players and can be called from a script. Variables can also be set locally via a script.

BrandId

The ID used by the CX Portal API to identify which brand the player is in.

BrandName

The name of the brand the player is in.

CountryCode

The universal country code of the country the player is in.

CountryId

The ID used by the CX Portal API to identify which country the player is in.

CountryName

The name of the country the player is in.

debug

A true or false value of if debug mode is enabled.

DisplayId

The ID used by the CX Portal API to identify the display(s) of the player.

DisplayName

The name of the display(s).

log.level

The level set when enabling debug mode.

operating_hours.exceptions

Lists all exceptions that impact this player.

operating_hours.mon

Lists all Monday operating hours that impact the player.

operating_hours.tue

Lists all Tuesday operating hours that impact the player.

operating_hours.wed

Lists all Wednesday operating hours that impact the player.

operating_hours.thu

Lists all Thursday operating hours that impact the player.

operating_hours.fri

Lists all Friday operating hours that impact the player.

operating_hours.sat

Lists all Saturday operating hours that impact the player.

operating_hours.sun

Lists all Sunday operating hours that impact the player.

PlaylistItemCount

The number of items in the current playlist showing on the player.

PlaylistItemCurrentIndex

The number of where in the playlist order the currently playing item is.

PlaylistName

The name of the playlist currently showing on the player.

RegionId

The ID used by the CX Portal API to identify which region the player is in.

RegionName

The name of the region the player is in.

SiteAddress

The address set in the CX portal when the site was created.

SiteId

The ID used by the CX Portal API to identify which site the player is in.

SiteLatitude

The latitude set in the CX portal when the site was created.

SiteLongitude

The longitude set in the CX portal when the site was created.

SiteName

The name of the site the player is in.

Tags

Lists all tags assigned to the player.

WorldRegionId

The ID used by the CX Portal API to identify which world region the player is in.

WorldRegionName

The name of the world region the player is in.

ZoneId

The ID used by the CX Portal API to identify which zone the player is in.

ZoneName

The name of the zone the player is in.