Setup Package Entity (v2)
0 min
- _id string read-only: A unique identifier of a given Setup package
- version semver read-only: A semantic version which defines the format of this Setup package entity, "2.0.0" by default
- bDeploy OwnershipInfo read-only: An Ownership Info Entity (v2) which defines the creator of this Setup package
- firmwareUpdatesByFamily FirmwareUpdateCollection read-write: A Firmware Update Collection Entity (v2) which defines the BOS version of each player family
- firmwareUpdateType string read-write: One of "standard", "different", "newer", "save" enumeration values which determine the kind of target BOS version.
- setupType string read-write: Either "standalone", "bsn", "lfn", "sfn", or "partnerApplication"
- bsnDeviceRegistrationTokenEntity:
- token: string read-only: The token granted for authentication purposes
- scope: string read-only: The scope granted by the token. For example, a successful user authentication response will contain both "Full" and "Self" values.
- validFrom DateTime read-only: The token will be valid from this date and time. See DateTime for more information about this data type.
- validTo DateTime read-only: The date and time that the token expires. See DateTime for more information about this data type.
- enableSerialDebugging bool read-write: A flag specifying whether serial debugging should be enabled for all players assigned to the Group instance
- enableSystemLogDebugging bool read-write: A flag specifying whether system log debugging should be enabled for players assigned to the Group instance
- remoteDwsEnabled bool read-write: A flag which defines wherever the Remote Diagnostic Web Server should be enabled
- dwsEnabled bool read-write: A flag which defines wherever the Local Diagnostic Web Server should be enabled
- dwsPassword string read-write: The password associated with the Local Diagnostic Web Server
- dwsPasswordPreviousSavedTimeStamp long read-write: A UNIX timestamp which defines when the local DWS password was last saved
- lwsEnabled bool read-write: A flag which defines wherever the Local Web Server should be enabled
- lwsConfig string read-write: A local web server operation mode which can be either "content" for LFN setup type and "status" for the other setup types. The difference is if the LWS server should be used for content publish.
- lwsUserName string read-write: The Local Web Server username (for example, "admin")
- lwsPassword string read-write: The Local Web Server password
- lwsEnableUpdateNotifications bool read-write: Whether or not enable update notifications is enabled
- bsnCloudEnabled bool read-write: A flag that indicates whether a player should connect and register in BSN.Cloud
- deviceName string read-write: The player name. The maximum length of this string is 128 characters.
- deviceDescription string read-write: A customer-defined description of the player. The description does not need to be unique within the scope of the account.
- unitNamingMethod string read-write: The player-naming method:
- appendNameAndSerial indicates that clients should append the player serial number to the player name.
- unitNameOnly indicates that nothing should be appended to the player name.
- timeZone string read-write: The time zone a player should operate in, which is one of the values in Supported Time Zones
- bsnGroupName string read-write: The name of the group instance to which the player is assigned
- timeBetweenNetConnects ushort read-write: An interval in seconds of player settings and schedule synchronization with a BSN or SFN server
- timeBetweenHeartbeats ushort read-write: An interval in seconds of player heartbeat reporting to a BSN or SFN server
- sfnWebFolderUrl URL read-write: The base URL of the target SFN folder which contains sync spec and related media content
- sfnUserName string read-write: The username the player should provide to authenticate on an SFN server using the basic authentication method
- sfnPassword string read-write: The password the player should provide to authenticate on an SFN server using the basic authentication method
- sfnEnableBasicAuthentication bool read-write: Whether basic authentication is required by the SFN server
- playbackLoggingEnabled bool read-write: Whether or not playback logging is enabled on the associated player.
- eventLoggingEnabled bool read-write: Whether or not event logging is enabled on the associated player.
- diagnosticLoggingEnabled bool read-write: Whether or not diagnostic logging is enabled on the associated player
- stateLoggingEnabled bool read-write: Whether or not state logging is enabled on the associated player.
- variableLoggingEnabled bool read-write: Whether or not variable logging is enabled on the associated player.
- uploadLogFilesAtBoot bool read-write: Whether autorun logs will be uploaded when the player boots.
- uploadLogFilesAtSpecificTime bool read-write: Whether autorun logs should be uploaded at a specific time of the day.
- uploadLogFilesTime int read-write: The time in minutes when the player should upload autorun logs to the server if the uploadLogFilesAtSpecificTime flag is set.
- logHandlerUrl URL read-write: The optional address of a custom endpoint which handles the uploaded autorun logs
- enableRemoteSnapshot bool read-write: Whether a player should capture and upload screenshots to the server.
- remoteSnapshotInterval int read-write: The number of minutes to wait between capturing each snapshot.
- remoteSnapshotMaxImages int read-write: The maximum number of snapshot images to keep in the player storage. Possible values are 1 to 100.
- remoteSnapshotJpegQualityLevel int read-write: The JPEG quality level for the snapshot images, on a scale from 1 to 100
- remoteSnapshotScreenOrientation string read-write: The image orientation, which is one of "Landscape", "PortraitBottomRight", or "PortraitBottomLeft"
- remoteSnapshotHandlerUrl URL read-write: The optional address of a custom endpoint which handles the uploaded snapshot images
- idleScreenColor object optional: An object with RGBA properties. The default color is black.
- r byte read-write: The value of the red color channel in byte code
- g byte read-write: The value of the green color channel in byte code
- b byte read-write: The value of the blue color channel in byte code
- a byte read-write: The value of the alpha channel in byte code
- networkDiagnosticsEnabled bool read-write: Whether a player should perform network diagnostics during setup and display the results on the screen.
- testEthernetEnabled bool read-write: Whether a player should perform Ethernet connection diagnostics during setup and display the results on the screen.
- testWirelessEnabled bool read-write: Whether a player should perform Wi-Fi connection during setup and display the results on the screen.
- testInternetEnabled bool read-write: Whether a player should check whether the BSN server is accessible during setup and display the results on the screen.
- useCustomSplashScreen bool read-write: Whether a player should display a custom splash screen during setup
- BrightWallName string read-write: The optional name of the BrightWall instance to which the player should be assigned
- BrightWallScreenNumber string read-write: The optional number of the BrightWall screen to which the player should be assigned
- contentDownloadsRestricted bool read-write: A flag which defines whether a player should download media content only within the specified time window
- contentDownloadRangeStart int read-write: A time of the day in minutes when the player may start the media content download
- contentDownloadRangeEnd int read-write: A time of the day in minutes when the player should stop the media content download
- heartbeatsRestricted bool read-write: Whether a player should report heartbeats to the BSN.Cloud server
- heartbeatsRangeStart int read-write: A time of the day in minutes when the player may start the heartbeat reporting period
- heartbeatsRangeEnd int read-write: A time of the day in minutes when the player should finish the heartbeat reporting period
- usbUpdatePassword string optional: The password for the USB update feature
- inheritNetworkProperties bool read-write: Whether a player should keep the existing network settings during registration
- internalCaArtifacts internalCaArtifacts[] optional: A list of certificate objects. Each object has a name and an asset (the certificate file object). This can be an empty object.