Player Error Entity (2020/10)

The structure of the player error entity is defined on the device level, so different properties will be returned depending on the type of error (for example, not all errors will return the response code).

Player error entities are structured as follows:

• Timestamp DateTime: Indicates the most recent time that the device reported an error. See DateTime for more information about this data type.

• ErrorName string:  One of:

  • Source field and device field of error event returned from operating system, in the event of a disk error

  • "Failed to download sync list", if there was an error downloading the sync list

  • The name of the new sync spec, if there was an unexpected error attempting to launch a sync spec download

  • The name of the file that failed to download, if a single file failed to download from BSN

  • None, if one or more files failed during a content download from BSN.

  • The event name, as returned from the operating system, if there was a failure when copying a new script or new firmware file into the root folder after the file has been downloaded into the pool

  • The name in the current sync spec, if the operation to protect certain files from deletion failed

• ErrorEvent string:  One of "Disk error", "deviceError", "FileDownloadFailure”, “POOL_EVENT_ALL_FAILED”, or “Realize Failure”, depending on the type of error.

• Reason string:  One of:

  • The failure reason, as returned by the operating system

  • The error field of the error event returned from the operating system, in the case of a disk error

  • The failure reason, as returned by the operating system, or the response code from the OS if no failure reason was present, in the case of an error downloading a sync list

  • “AsyncDownloadFailure:” followed by the failure reason as returned by the operating system, if an unexpected error occurred when attempting to launch a sync spec download

  • "ProtectFilesFailure: AssetPool Protect Failure" if the operation to protect certain files from deletion failed

• ResponseCode int: One of:

  • The response code returned by the operating system

  • The parameter field of the error event returned by the operating system, if the error is a disk error

  • The value returned by the GetEvent call to the operating system on the returned event object, if the error is a failure when copying a new script or new firmware file into the root folder after the file has been downloaded into the pool

  • There will be no response code if the error is an unexpected error when attempting to launch a sync spec download, or the operation to protect certain files from deletion failed

  • Some errors will not return a response code