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 BrightWall
Name
string: The BrightWall name
Screen
byte: The BrightWall screen number to which the device is assigned
Link
Uri: The Uri of the BSN.cloud API for the BrightWall
Timezone
string: The time zone of the player
Screen
DeviceScreenSettings:
IdleColor
string: The AARRGGBB color code for the idle screen
SplashUrl
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 Entity
Beacons
DeviceBeacon[]: An array of Device Beacons entities
Location
DeviceLocation: Supported representations include:
PlaceId
string: The textual identifier of the device location
GPSLatitude
Nullable<double>: The latitude of the device location
GPSLongitude
Nullable<double>: The longitude of the device location
Country
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 located
AdminAreaLevel1LongName
string: The full name of the largest subnational administrative unit of a country in which the device is located
AdminAreaLevel2
string: The county name (within the United States), or a second-order civil entity below adminAreaLevel1
, 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 below adminAreaLevel1
, in which the device is located.
Locality
string: The name of the city, town, or rural area in which the device is located
LocalityLongName
string: The full name of the city, town, or rural area in which the device is located
Path
string: The path property of the location structure. This value is the result of the concatenation of Country
, AdminAreaLevel1
, AdminAreaLevel2
, and Locality
.
PathLongName
string: The path property of the location structure. This value is the result of the concatenation of CountryLongName
, AdminAreaLevel1LongName
, AdminAreaLevel2LongName
, and LocalityLongName
.
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 file
Orientation
ScreenOrientation: One of "Unknown", "Landscape", "PortraitBottomLeft", or "PortraitBottomRight"
Logging
DeviceLogsSettings:
EnableDiagnosticLog
bool: Whether or not diagnostic logging is enabled on the associated device
EnableEventLog
bool: Whether or not event logging is enabled on the associated device
EnablePlaybackLog
bool: Whether or not playback logging is enabled on the associated device
EnableStateLog
bool: Whether or not state logging is enabled on the associated device
EnableVariableLog
bool: Whether or not variable logging is enabled on the associated device
UploadAtBoot
bool: Whether logs will be uploaded when the device boots
UploadTime
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 password
EnableUpdateNotifications
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.