Player Full Status Entity (2022/06)

All player full status entities are structured as follows:

entity:

  • Group GroupInfo

    • Id int read-only: The unique identifier for the group

    • Name string read-only: The name of the group

  • BrightWall BrightWallScreenInfo

    • Id Nullable<int> read-onlyA unique identifier for the BrightWall

    • Name string read-only: The BrightWall name

    • Screen byte read-onlyThe BrightWall screen number to which the device is assigned

    • Link Uri read-onlyThe Uri of the BSN.cloud API for the BrightWall

  • Presentation PresentationInfo read-onlyAn array of Presentation Info entities for each presentation on the device

  • Script PlayerScript

    • Type ScriptType read-only"Setup", "Autorun", "Recovery" or "Custom" enumeration values

    • Version string read-onlyThe BrightSignOS version

    • Plugins ScriptPluginInfo[]: 

      • FileName string read-only: The plugin .brs file name for the device instance

      • FileSize uint read-only: The size of the file in bytes

      • FileHash string read-only: The 40 digits hexadecimal SHA-1 hash of the file

  • Firmware FirmwareInfo

    • Version string read-only: The BrightSignOS version running on the player

  • Storage StorageStatus[] read-only: See the Storage Status Entity

  • Network PlayerNetworkStatus

    • ExternalIp string read-onlyAn IPv4 or IPv6 address 

  • Uptime TimeSpan read-onlyThe length of time that the player has been running. See TimeSpan for more information about this data type.

  • CurrentSettingsTimestamp DateTime read-onlyThe date and time. See DateTime for more information about this data type.

  • CurrentScheduleTimestamp DateTime read-onlyThe date and time of the current schedule. See DateTime for more information about this data type.

  • Timezone string read-only: The time zone of the player

  • Health PlayerHealthStatus read-only: Returns either "Normal", "Warning", "Error", or "Unknown"

  • LastModifiedDate Nullable<DateTime> read-only: A UTC timestamp indicating when the dynamic playlist was last modified on BSN.cloud. See DateTime for more information on this data type.

  • Synchronization PlayerSynchronizationStatus read-onlySupported representations include:

    • Settings PlayerSettingsSynchronizationStatus

      • Enabled bool read-only: Whether or not the player settings synchronization status is enabled

    • Schedule PlayerScheduleSynchronizationStatus

      • Enabled bool read-onlyWhether or not the player schedule synchronization status is enabled

    • Content PlayerContentSynchronizationStatus

      • Enabled bool read-onlyWhether or not the player content synchronization status is enabled