All player settings entities are structured as follows:
entity:
...
Namestring
...
: The device name
...
. The maximum length of this string is 128 characters.
Descriptionstring: A customer-defined description of the device. The description does not need to be unique within the scope of the account.
...
ConcatNameAndSerialbool
...
: The device-naming method:
Trueindicates that clients should append the device serial number to the device name,Falseindicates that nothing should be appended to the device name.
...
SetupTypeDeviceSetupType
...
: Either "Standalone", "BSN", "LFN", "SFN", "PartnerApplication", or "Unknown"
...
GroupGroupInfo
...
:
...
Idint
...
: The unique identifier for the group instance to which the device belongs.
...
Namestring
...
: The name of the group instance to which the device belongs
...
BrightWallBrightWallScreenInfo
...
:
...
IdNullable<int>: A unique identifier for the BrightWall
...
Namestring
...
: The BrightWall name
...
Screenbyte
...
: The BrightWall screen number to which the device is assigned
...
LinkUri
...
: The Uri of the BSN.cloud API for the BrightWall
...
Timezonestring
...
: The time zone of the player
...
ScreenDeviceScreenSettings
...
:
...
IdleColorstring
...
: The AARRGGBB color code for the idle screen
...
SplashUrlUri
...
: The Uri address for the splash screen
...
SynchronizationPlayerSynchronizationSettings
...
: Supported representations include:
...
StatusPlayerStatusSynchronizationSettings
...
:
...
PeriodTimeSpan
...
: The frequency of the status updates that the player sends to the server. Currently, the value is five minutes for all players.
...
SettingsPlayerSettingsSynchronizationSettings
...
:
...
PeriodTimeSpan
...
:
...
The frequency of the synchronization settings updates that the player sends to and receives from the server, to
...
ensure that it hasn’t missed an update from the server
...
SchedulePlayerScheduleSynchronizationSettings
...
:
...
PeriodTimeSpan
...
: Players with "BSN" setup type only use this to check for missed updates of scheduled content
...
ContentPlayerContentSynchronizationSettings
...
:
...
StartTimeSpan
...
:
...
Defines the time of the day when the player is allowed to download content (to avoid network impacts). See TimeSpan
...
for more information about this data type.
...
EndTimeSpan
...
:
...
Defines time of the day when the player is allowed to download content (to avoid network impacts).
...
See TimeSpan
...
for more information about this data type.
...
NetworkPlayerNetworkSettings
...
[string][Uri] ProxyServer:The Uri address of the proxy server[[Uri[]]TimeServers:The Uri address for the NTP server[PlayerNetworkInterfaceSettings[]]Interfaces:Supported representations include:[PlayerNetworkInterfaceType] Type:One of "Ethernet", "Cellular", "WiFi", "Virtual", "Bridge", or "Other"
...
BeaconsDeviceBeacon[]: An array of Device Beacons
...
entities
...
LocationDeviceLocation
...
: Supported representations include:
...
PlaceIdstring
...
: The textual identifier of the device location
...
GPSLatitudeNullable<double>: The latitude of the device location
...
GPSLongitudeNullable<double>: The longitude of the device location
...
Countrystring
...
: The country in which the device is located (for example, "Germany")
...
CountryLongNamestring
...
: The full name of the country in which the device is located (for example, "Federal Republic of Germany")
...
AdminAreaLevel1string
...
: The largest subnational administrative unit of a country (for example, "state" in the USA and "prefecture" in Japan) in which the device is located
...
AdminAreaLevel1LongNamestring
...
: The full name of
...
the largest subnational administrative unit of a country in which the device is located
...
AdminAreaLevel2string
...
: The county name (within the United States), or a second-order civil entity below
adminAreaLevel1, in which the device is located.
...
AdminAreaLevel2LongNamestring
...
: The full county name (within the United States), or the full name of the second-order civil entity below
adminAreaLevel1, in which the device is located.
...
Localitystring
...
: The name of the city, town, or rural area in which the device is located
...
LocalityLongNamestring
...
:
...
The full name of the city, town, or rural area in which the device is located
...
Pathstring
...
:
...
[string]
[PlayerScreenshotsSettings] Screenshots:
...
The path property of the location structure. This value is the result of the concatenation of
Country,AdminAreaLevel1,AdminAreaLevel2, andLocality.PathLongNamestring: The path property of the location structure. This value is the result of the concatenation ofCountryLongName,AdminAreaLevel1LongName,AdminAreaLevel2LongName, andLocalityLongName.
ScreenshotsPlayerScreenshotsSettings:IntervalTimeSpan: How often the player should take a snapshot of the presentation display.
...
See TimeSpan
...
for more information about this data type.
...
CountLimitushort
...
: How many images can be stored on the local storage of the player (the maximum is 100 images)
...
Qualitybyte
...
: The quality level of each image file
...
OrientationScreenOrientation
...
: One of "Unknown", "Landscape", "PortraitBottomLeft", or "PortraitBottomRight"
...
LoggingDeviceLogsSettings
...
:
...
EnableDiagnosticLogbool
...
: Whether or not diagnostic logging is enabled on the associated device
...
EnableEventLogbool
...
: Whether or not event logging is enabled on the associated device
...
EnablePlaybackLogbool
...
: Whether or not playback logging is enabled on the associated device
...
EnableStateLogbool
...
: Whether or not state logging is enabled on the associated device
...
EnableVariableLogbool
...
: Whether or not variable logging is enabled on the associated device
...
UploadAtBootbool
...
:
...
Whether logs will be uploaded when the device boots
...
UploadTimeNullable<TimeSpan>: The time when the device will upload logs to BSN.cloud, if available.
...
See TimeSpan
...
for more information about this data type.
...
LWSLocalWebServerSettings
...
:
...
Usernamestring
...
: The local web server username (for example, "admin")
...
Passwordstring
...
: The local web server password
...
EnableUpdateNotificationsbool
...
: Whether or not enable update notifications is enabled
...
LDWSDiagnosticWebServerSettings
...
:
...
Passwordstring
...
: The password associated with the local diagnostic web server
...
LastModifiedDateDateTime
...
: The date on which the settings were last modified.
...
See DateTime
...
for more information about this data type.