Cloud APIs
...
Data Types (2020/10)
Custom Data Types (2020/10)

Player Settings Entity (2020/10)

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