Player Settings Entity (2020/10)
All player settings entities are structured as follows:
entity
:
Name
string: The device name. The maximum length of this string is 128 characters.Description
string:Â A customer-defined description of the device. The description does not need to be unique within the scope of the account.ConcatNameAndSerial
bool:Â The device-naming method:True
 indicates that clients should append the device serial number to the device name,ÂFalse
 indicates that nothing should be appended to the device name.SetupType
DeviceSetupType: Either "Standalone", "BSN", "LFN", "SFN", "PartnerApplication", or "Unknown"Group
GroupInfo:ÂId
int: The unique identifier for the group instance to which the device belongs.Name
string: The name of the group instance to which the device belongs
BrightWall
BrightWallScreenInfo:ÂId
Nullable<int>:Â A unique identifier for the BrightWallName
string: The BrightWall nameScreen
byte:Â The BrightWall screen number to which the device is assignedLink
Uri:Â The Uri of the BSN.cloud API for the BrightWall
Timezone
string:Â The time zone of the playerScreen
DeviceScreenSettings:ÂIdleColor
string:Â The AARRGGBB color code for the idle screenSplashUrl
Uri:Â The Uri address for the splash screen
Synchronization
PlayerSynchronizationSettings:Â Supported representations include:Status
PlayerStatusSynchronizationSettings:ÂPeriod
TimeSpan:Â The frequency of the status updates that the player sends to the server. Currently, the value is five minutes for all players.
Settings
PlayerSettingsSynchronizationSettings:ÂPeriod
TimeSpan: 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
Schedule
PlayerScheduleSynchronizationSettings:Period
TimeSpan: Players with "BSN" setup type only use this to check for missed updates of scheduled content
Content
PlayerContentSynchronizationSettings:Start
TimeSpan: 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.End
TimeSpan: 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.
Network
PlayerNetworkSettings: The Player Network Settings EntityBeacons
DeviceBeacon[]: An array of Device Beacons entitiesLocation
DeviceLocation:Â Supported representations include:PlaceId
string:Â The textual identifier of the device locationGPSLatitude
Nullable<double>:Â The latitude of the device locationGPSLongitude
 Nullable<double>: The longitude of the device locationCountry
string:Â The country in which the device is located (for example, "Germany")CountryLongName
string:Â The full name of the country in which the device is located (for example, "Federal Republic of Germany")AdminAreaLevel1
string:Â The largest subnational administrative unit of a country (for example, "state" in the USA and "prefecture" in Japan) in which the device is locatedAdminAreaLevel1LongName
string:Â The full name of the largest subnational administrative unit of a country in which the device is locatedAdminAreaLevel2
string: The county name (within the United States), or a second-order civil entity belowadminAreaLevel1
, in which the device is located.ÂAdminAreaLevel2LongName
string:Â The full county name (within the United States), or the full name of the second-order civil entity belowadminAreaLevel1
, in which the device is located.Locality
string: The name of the city, town, or rural area in which the device is locatedLocalityLongName
string: The full name of the city, town, or rural area in which the device is locatedPath
string:Â The path property of the location structure. This value is the result of the concatenation ofCountry
,AdminAreaLevel1
,AdminAreaLevel2
, andLocality
.PathLongName
string:Â The path property of the location structure. This value is the result of the concatenation ofCountryLongName
,AdminAreaLevel1LongName
,AdminAreaLevel2LongName
, andLocalityLongName
.
Screenshots
PlayerScreenshotsSettings:ÂInterval
 TimeSpan: How often the player should take a snapshot of the presentation display. See TimeSpan for more information about this data type.CountLimit
ushort:Â How many images can be stored on the local storage of the player (the maximum is 100 images)Quality
byte:Â The quality level of each image fileOrientation
ScreenOrientation: One of "Unknown", "Landscape", "PortraitBottomLeft", or "PortraitBottomRight"
Logging
DeviceLogsSettings:ÂEnableDiagnosticLog
bool: Whether or not diagnostic logging is enabled on the associated deviceEnableEventLog
bool:Â Whether or not event logging is enabled on the associated deviceEnablePlaybackLog
bool:Â Whether or not playback logging is enabled on the associated deviceEnableStateLog
 bool: Whether or not state logging is enabled on the associated deviceEnableVariableLog
bool:Â Whether or not variable logging is enabled on the associated deviceUploadAtBoot
bool: Whether logs will be uploaded when the device bootsUploadTime
Nullable<TimeSpan>: The time when the device will upload logs to BSN.cloud, if available. See TimeSpan for more information about this data type.
LWS
LocalWebServerSettings:ÂUsername
string: The local web server username (for example, "admin")Password
string:Â The local web server passwordEnableUpdateNotifications
bool: Whether or not enable update notifications is enabled
LDWS
DiagnosticWebServerSettings:ÂPassword
string: The password associated with the local diagnostic web server
LastModifiedDate
DateTime: The date on which the settings were last modified. See DateTime for more information about this data type.