Player Settings Entity (2020/10)

All player settings entities are structured as follows:

entity:

• [string] Name: The device name. The maximum length of this string is 128 characters.

• [string] Description: A customer-defined description of the device. The description does not need to be unique within the scope of the account.

• [bool]  ConcatNameAndSerial:  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.

• [DeviceSetupType]  SetupType: Either "Standalone", "BSN", "LFN", "SFN",  "PartnerApplication", or "Unknown"

• [GroupInfo] Group: 

  • [int] Id: The unique identifier for the group instance to which the device belongs.
  • [string] Name: The name of the group instance to which the device belongs

• [BrightWallScreenInfo] BrightWall: 

  • [Nullable<int>] Id: A unique identifier for the BrightWall

  • [string] Name: The BrightWall name

  • [byte] Screen: The BrightWall screen number to which the device is assigned

  • [Uri] Link: The Uri of the BSN.cloud API for the BrightWall

• [string] Timezone: The time zone of the player

• [DeviceScreenSettings] Screen: 

  • [string] IdleColor: The AARRGGBB color code for the idle screen
  • [Uri] SplashUrl: The Uri address for the splash screen

• [PlayerSynchronizationSettings] Synchronization: Supported representations include:

  • [PlayerStatusSynchronizationSettings] Status: 

    • [TimeSpan] Period: The frequency of the status updates that the player sends to the server. Currently, the value is five minutes for all players.

  • [PlayerSettingsSynchronizationSettings] Settings: 

    • [TimeSpan] Period: 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

  • [PlayerScheduleSynchronizationSettings] Schedule:

    • [TimeSpan] Period: Players with "BSN" setup type only use this to check for missed updates of scheduled content

  • [PlayerContentSynchronizationSettings] Content:

    • [TimeSpan] Start:  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.
    • [TimeSpan] End:  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.

• [PlayerNetworkSettings] Network: The Player Network Settings Entity

• [DeviceBeacon[]] Beacons: An array of Device Beacons entities

• [DeviceLocation] Location: Supported representations include:

  • [string] PlaceId: The textual identifier of the device location

  • [Nullable<double>] GPSLatitude: The latitude of the device location

  • [Nullable<double>] GPSLongitude: The longitude of the device location

  • [string] Country: The country in which the device is located (for example, "Germany")

  • [string] CountryLongName: The full name of the country in which the device is located (for example, "Federal Republic of Germany")

  • [string] AdminAreaLevel1: The largest subnational administrative unit of a country (for example, "state" in the USA and "prefecture" in Japan) in which the device is located
  • [string] AdminAreaLevel1LongName: The full name of the largest subnational administrative unit of a country in which the device is located

  • [string] AdminAreaLevel2: The county name (within the United States), or a second-order civil entity below adminAreaLevel1, in which the device is located. 

  • [string] AdminAreaLevel2LongName: 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.

  • [string] Locality: The name of the city, town, or rural area in which the device is located

  • [string] LocalityLongName: The full name of the city, town, or rural area in which the device is located

  • [string] Path: The path property of the location structure. This value is the result of the concatenation of Country, AdminAreaLevel1, AdminAreaLevel2, and Locality.

  • [string] PathLongName: The path property of the location structure. This value is the result of the concatenation of CountryLongName, AdminAreaLevel1LongName, AdminAreaLevel2LongName, and LocalityLongName.

• [PlayerScreenshotsSettings] Screenshots: 

  • [TimeSpan] Interval: How often the player should take a snapshot of the presentation display. See TimeSpan for more information about this data type.

  • [ushort] CountLimit: How many images can be stored on the local storage of the player (the maximum is 100 images)

  • [byte] Quality:  The quality level of each image file

  • [ScreenOrientation] Orientation: One of "Unknown", "Landscape", "PortraitBottomLeft", or "PortraitBottomRight"

• [DeviceLogsSettings] Logging: 

  • [bool] EnableDiagnosticLog: Whether or not diagnostic logging is enabled on the associated device

  • [bool] EnableEventLog: Whether or not event logging is enabled on the associated device

  • [bool] EnablePlaybackLog: Whether or not playback logging is enabled on the associated device

  • [bool] EnableStateLog: Whether or not state logging is enabled on the associated device

  • [bool] EnableVariableLog: Whether or not variable logging is enabled on the associated device

  • [bool] UploadAtBoot:  Whether logs will be uploaded when the device boots

  • [TimeSpan?] UploadTime: The time when the device will upload logs to BSN.cloud, if available. See TimeSpan for more information about this data type.

• [LocalWebServerSettings] LWS: 

  • [string] Username: The local web server username (for example, "admin")
  • [string] Password:  The local web server password
  • [bool] EnableUpdateNotifications: Whether or not enable update notifications is enabled

• [DiagnosticWebServerSettings] LDWS: 

  • [string] Password: The password associated with the local diagnostic web server

• [DateTime] LastModifiedDate: The date on which the settings were last modified. See DateTime for more information about this data type.