---
title: Player Settings Entity (2022/06)
slug: develop/player-settings-entity-202206
docTags: 
createdAt: 2025-03-11T07:03:30.743Z
---

All Player Settings entities are structured as follows:

`entity`:

- `Name` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The player name. The maximum length of this string is 128 characters.
- `Description` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: A customer-defined description of the player. The description does not need to be unique within the scope of the account.
- `ConcatNameAndSerial` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: The player-naming method: `True` indicates that clients should append the device serial number to the player name, `False` indicates that nothing should be appended to the player name.
- `SetupType` <font color="#704ae0">DeviceSetupType</font> <font color="#01a0af">read-only</font>: Either "Standalone", "BSN", "LFN", "SFN", "PartnerApplication", or "Unknown"
- `Group` <font color="#704ae0">GroupInfo</font>:&#x20;
  - `Id` <font color="#704ae0">int</font> <font color="#01a0af">read-write</font>: The unique identifier for the group instance to which the device belongs.
  - `Name` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The name of the group instance to which the device belongs
- `BrightWall` <font color="#704ae0">object </font><font color="#01a0af">read-write</font>: This property is deprecated and will be removed in the next BSN.Cloud API version
- `Timezone` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The time zone of the player
- `Screen` <font color="#704ae0">DeviceScreenSettings</font>:&#x20;
  - `IdleColor` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The AARRGGBB color code for the idle screen
  - `SplashUrl` <font color="#704ae0">Uri</font> <font color="#01a0af">read-write</font>: The Uri address for the splash screen
- `Synchronization` <font color="#704ae0">PlayerSynchronizationSettings</font> <font color="#01a0af">read-write</font>: The [Player Synchronization Settings Entity](docId:9wQlt7eW-kTnaOgp5WTjD)&#x20;
- `Network` <font color="#704ae0">PlayerNetworkSettings</font> <font color="#01a0af">read-write</font>: The [Player Network Settings Entity](docId\:jLx8nx2W5TzDZSRyVoqDq)&#x20;
- `Beacons` <font color="#704ae0">DeviceBeacon[]</font> <font color="#01a0af">read-write</font>: An array of [Player Beacon](docId\:BsgHv6pw46ZE0xu2T2I8I) entities
- `Location` <font color="#704ae0">DeviceLocation</font>:&#x20;
  - `PlaceId` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The textual identifier of the player location
  - `GPSLatitude` <font color="#704ae0">Nullable&lt;double&gt;</font> <font color="#01a0af">read-write</font>: The latitude of the player location
  - `GPSLongitude` <font color="#704ae0">Nullable&lt;double&gt;</font> <font color="#01a0af">read-write</font>: The longitude of the player location
  - `Country` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The country in which the player is located (for example, "Germany")
  - `CountryLongName` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The full name of the country in which the player is located (for example, "Federal Republic of Germany")
  - `AdminAreaLevel1` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The largest subnational administrative unit of a country (for example, "state" in the USA and "prefecture" in Japan) in which the player is located
  - `AdminAreaLevel1LongName` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The full name of the largest subnational administrative unit of a country in which the player is located
  - `AdminAreaLevel2` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The county name (within the United States), or a second-order civil entity below adminAreaLevel1, in which the player is located.&#x20;
  - `AdminAreaLevel2LongName` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The full county name (within the United States), or the full name of the second-order civil entity below adminAreaLevel1, in which the player is located.
  - `Locality` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The name of the city, town, or rural area in which the player is located
  - `LocalityLongName` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The full name of the city, town, or rural area in which the player is located
  - `Path` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The path property of the location structure. This value is the result of the concatenation of `Country`, `AdminAreaLevel1`, `AdminAreaLevel2`, and `Locality`.
  - `PathLongName` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The path property of the location structure. This value is the result of the concatenation of `CountryLongName`, `AdminAreaLevel1LongName`, `AdminAreaLevel2LongName`, and `LocalityLongName`.
- `Screenshots` <font color="#704ae0">PlayerScreenshotsSettings</font>:&#x20;
  - `Interval` <font color="#704ae0">TimeSpan</font> <font color="#01a0af">read-write</font>: How often the player should take a snapshot of the presentation display. See [TimeSpan](docId\:dX1C8uSfkXPwntpRb9f-T) for more information about this data type.
  - `CountLimit` <font color="#704ae0">ushort</font> <font color="#01a0af">read-write</font>: How many images can be stored on the local storage of the player (the maximum is 100 images)
  - `Quality` <font color="#704ae0">byte</font> <font color="#01a0af">read-write</font>: The quality level of each image file
  - `Orientation` <font color="#704ae0">ScreenOrientation</font><font color="#01a0af"> read-write</font>: One of "Unknown", "Landscape", "PortraitBottomLeft", or "PortraitBottomRight"
- `Logging` <font color="#704ae0">DeviceLogsSettings</font>:&#x20;
  - `EnableDiagnosticLog` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether or not diagnostic logging is enabled on the associated player
  - `EnableEventLog` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether or not event logging is enabled on the associated player
  - `EnablePlaybackLog` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether or not playback logging is enabled on the associated player
  - `EnableStateLog` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether or not state logging is enabled on the associated player
  - `EnableVariableLog` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether or not variable logging is enabled on the associated player
  - `UploadAtBoot` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether logs will be uploaded when the player boots
  - `UploadTime` <font color="#704ae0">Nullable&lt;TimeSpan&gt;</font> <font color="#01a0af">read-write</font>: The time when the player will upload logs to BSN.Cloud, if available. See [TimeSpan](docId\:dX1C8uSfkXPwntpRb9f-T) for more information about this data type.
- `LWS` <font color="#704ae0">LocalWebServerSettings</font>:&#x20;
  - `Username` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The local web server username (for example, "admin")
  - `Password` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The local web server password
  - `EnableUpdateNotifications` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: Whether or not enable update notifications is enabled
- `LDWS` <font color="#704ae0">DiagnosticWebServerSettings</font>:&#x20;
  - `Password` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The password associated with the local diagnostic web server
- `LastModifiedDate` <font color="#704ae0">DateTime</font> <font color="#01a0af">read-only</font>: The date on which the settings were last modified. See [DateTime](docId\:dX1C8uSfkXPwntpRb9f-T) for more information about this data type.

