Player Settings Entity (2022/06)

1 min

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