Cloud APIs
...
Data Types (2022/06)
Custom Data Types (2022/06)

Player Settings Entity (2022/06)

1min
all player settings entities are structured as follows entity name string string read write read write the device name the maximum length of this string is 128 characters description string string read write read write a customer defined description of the device the description does not need to be unique within the scope of the account concatnameandserial bool bool read write read write 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 devicesetuptype read only read only either "standalone", "bsn", "lfn", "sfn", "partnerapplication", or "unknown" group groupinfo groupinfo id int int read write read write the unique identifier for the group instance to which the device belongs name string string read write read write the name of the group instance to which the device belongs brightwall brightwallscreeninfo brightwallscreeninfo id nullable\<int> nullable\<int> read write read write a unique identifier for the brightwall name string string read write read write the brightwall name screen byte byte read write read write the brightwall screen number to which the device is assigned link uri uri read write read write the uri of the bsn cloud api for the brightwall timezone string string read write read write the time zone of the player screen devicescreensettings devicescreensettings idlecolor string string read write read write the aarrggbb color code for the idle screen splashurl uri uri read write read write the uri address for the splash screen synchronization playersynchronizationsettings playersynchronizationsettings read write read write the player synchronization settings entity (2022/06) docid 9wqlt7ew ktnaogp5wtjd network playernetworksettings playernetworksettings read write read write the player network settings entity (2022/06) docid\ jlx8nx2w5tzdzsryvoqdq beacons devicebeacon\[] devicebeacon\[] read write read write an array of player beacon entity (2022/06) docid\ bsghv6pw46ze0xu2t2i8i entities location devicelocation devicelocation placeid string string read write read write the textual identifier of the device location gpslatitude nullable\<double> nullable\<double> read write read write the latitude of the device location gpslongitude nullable\<double> nullable\<double> read write read write the longitude of the device location country string string read write read write the country in which the device is located (for example, "germany") countrylongname string string read write read write the full name of the country in which the device is located (for example, "federal republic of germany") adminarealevel1 string string read write read write 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 string read write read write the full name of the largest subnational administrative unit of a country in which the device is located adminarealevel2 string string read write read write the county name (within the united states), or a second order civil entity below adminarealevel1, in which the device is located adminarealevel2longname string string read write read write 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 string read write read write the name of the city, town, or rural area in which the device is located localitylongname string string read write read write the full name of the city, town, or rural area in which the device is located path string string read only read only the path property of the location structure this value is the result of the concatenation of country , adminarealevel1 , adminarealevel2 , and locality pathlongname string string read only read only the path property of the location structure this value is the result of the concatenation of countrylongname , adminarealevel1longname , adminarealevel2longname , and localitylongname screenshots playerscreenshotssettings playerscreenshotssettings interval timespan timespan read write read write how often the player should take a snapshot of the presentation display see custom data types (2022/06) docid\ dx1c8usfkxpwntprb9f t for more information about this data type countlimit ushort ushort read write read write how many images can be stored on the local storage of the player (the maximum is 100 images) quality byte byte read write read write the quality level of each image file orientation screenorientation screenorientation read write read write one of "unknown", "landscape", "portraitbottomleft", or "portraitbottomright" logging devicelogssettings devicelogssettings enablediagnosticlog bool bool read write read write whether or not diagnostic logging is enabled on the associated device enableeventlog bool bool read write read write whether or not event logging is enabled on the associated device enableplaybacklog bool bool read write read write whether or not playback logging is enabled on the associated device enablestatelog bool bool read write read write whether or not state logging is enabled on the associated device enablevariablelog bool bool read write read write whether or not variable logging is enabled on the associated device uploadatboot bool bool read write read write whether logs will be uploaded when the device boots uploadtime nullable\<timespan> nullable\<timespan> read write read write the time when the device will upload logs to bsn cloud, if available see custom data types (2022/06) docid\ dx1c8usfkxpwntprb9f t for more information about this data type lws localwebserversettings localwebserversettings username string string read write read write the local web server username (for example, "admin") password string string read write read write the local web server password enableupdatenotifications bool bool read write read write whether or not enable update notifications is enabled ldws diagnosticwebserversettings diagnosticwebserversettings password string string read write read write the password associated with the local diagnostic web server lastmodifieddate datetime datetime read only read only the date on which the settings were last modified see custom data types (2022/06) docid\ dx1c8usfkxpwntprb9f t for more information about this data type