The Download class

Support in HbbTV

Available since: HbbTV 1.0 (ETSI TS 102 796 V1.1.1, OIPF DAE V1.1)

The currentBitrate property is not included.

The errorLevel property shall be supported (see clause A.2.11 below).

The flaggedForDeletion property defined in clause 8.2.4 shall be supported.

Comment

Security: Trusted

This class shall be extended with the following additional property.

readonly Number errorLevel
A representation of the quantity of detected but uncorrected errors in a file downloaded using FDP (as defined in annex H).

The value of this property shall be calculated as the number of erroneous or missing File Segments divided by the total number of File Segments. A value of zero indicates that the downloaded file has no errors.

If state does not equal 1, or if the file is not downloaded using FDP, then the value of this property is not defined.

The following additional property on the Download object (as defined in the OIPF DAE specification [1]) shall be supported.

Boolean flaggedForDeletion
DescriptionBoolean property set by the application indicating whether the content item has been flagged as suitable for automatic deletion. When additional storage space is needed to complete a download that has been registered, if deleting content items flagged for automatic deletion would provide the additional storage space needed then enough of these content items shall be deleted by the terminal to provide the space needed.

 

When a download is removed automatically as a result of this flag being set, the effect shall be the same as the effect of the remove() method: the download and any data and media content associated with it shall be removed, and all properties on the Download object shall be set to undefined.

 

The storage space corresponding to the downloads which are flagged for deletion shall be deemed as free by the checkDownloadPossible() method.

 

The order in which items flagged for deletion are actually removed by the terminal, and the time at which they are removed, is implementation-dependent, and may take into account factors such as the time at which the item was flagged for deletion, the size of the item compared to the amount of space needed. Items flagged for deletion shall not be removed automatically if they are currently being referred to by an A/V Control object or a <video> element.

A Download object being made available by the application/oipfDownloadManager embedded object represents a content item that has either been downloaded from a remote server or is in the process of being downloaded.

If the ID of a download is a TV-Anytime CRID, then the values of the name, description and parentalRatings properties SHALL be set by the OITF based on the metadata provided for the item matching that CRID.

In order to preserve backwards compatibility with already existing DAE content the JavaScript toString() method SHALL return the Download.id for Download objects.

Properties

readonly Integer totalSize
The total size (in bytes) of the download.
readonly Integer state
The current state of the download. When this changes, a DownloadStateChange event SHALL be generated. Valid values are: Value Description 1 The download has completed. 2 The download is in progress. 4 The download has been paused (either by an application or automatically by the platform). 8 The download has failed. 16 The download is queued but has not yet started. 32 The download has stalled due to a transient failure and the Download Manager is attempting to recuperate and re-establish the download. Note: these values are used as a bitfield in the DownloadManager.createFilteredList() method.
readonly Integer reason
The reason property is only valid if the value of the state property is 8 (download failed). Reason Semantics 0 The local storage device is full. 1 The item cannot be downloaded (e.g. because it has not been purchased). 2 The item is no longer available for download. 3 The item is invalid due to bad checksum or length. 4 Other reason. If no error has occurred, this argument SHALL take the value undefined.
readonly Integer amountDownloaded
The amount of data that has been downloaded returned in bytes, or zero if no data has been downloaded.
readonly Integer currentBitrate
The bitrate (in bits per second) at which the download is currently transferred. This value is non-zero only when the Download object is in state 2 (in progress) If this is unknown the value of this property SHALL be undefined.
String name
The name of the download or undefined if this information is not present. In case the download is triggered through a Content Access Download Descriptor, this corresponds to the value for the <Title> element in the Content Access Download Descriptor. If the Content Access Download Descriptor is not specified then the property may be set by the origin site. Note that the property may only be set by the site that initiated the download. The DAE application may store data related to the Download. The OITF SHALL support a minimum of 200 bytes for the property. If DAE application attempts to store a string larger than the available size the OITF SHALL set the property to NULL. The maximum length of the property value is implementation dependent.
readonly String id
The ID of the download as determined by the OITF.
readonly String uri
A uri identifying the content item in local storage according to [RFC3986]. The format of the URI is outside the scope of this specification except that; · the scheme SHALL NOT be one that is included in this specification · the URI SHALL NOT include a fragment
readonly String contentURL
The URL the content is being fetched from, or undefined if this information is not available.
String description
A description of the download or undefined if this information is not present. In case the download is triggered through a Content Access Download Descriptor, this corresponds to the value for the <Synopsis> element in the Content Access Download Descriptor, or undefined if this element is not present. If the Content Access Download Descriptor is not specified the property may be set by the origin site. Note that the property may only be set by the site that initiated the download. The DAE application may store data related to the Download. The OITF SHALL support a minimum of 2000 bytes for the property. If DAE application attempts to store a string larger than the available size the OITF SHALL set the property to NULL. The maximum length of the property value is implementation dependent.
readonly ParentalRatingCollection parentalRatings
The parental rating collection related to the downloaded content item, or undefined if this information is not present. In case the download is triggered through a Content Access Download Descriptor, this corresponds to the value for the <ParentalRating> element in the Content Access Download Descriptor, or undefined if this element is not present.
readonly DRMControlInfoCollection drmControl
The DRMControlInformation object corresponding to the DRM Control information of the downloaded content item, or undefined if this information is not present. In case the download is triggered through a Content Access Download Descriptor, this corresponds to the value for the <DRMControlInformation> element associated with the same DRMSystemID of the selected <ContentURL>, or is undefined if this information is not present. The related DRMControlInformation object is defined in section 7.4.6.
readonly Date startTime
The time that the download is scheduled to start (in the case of scheduled downloads) or undefined if no start time was set.
readonly Integer timeElapsed
The time (in seconds) that has elapsed since the download of the item was started. The elapsed time SHALL be based on the time spent in the in-progress and stalled download states. This SHALL NOT include any time the item spent queued for download.
readonly Integer timeRemaining
The estimated time remaining (in seconds) for the download to complete. The estimated time SHALL be based on the time spent in the in-progress and stalled download states. The estimate SHALL NOT include any time the item spent queued for download or paused. If an estimate cannot be calculated, the value of this property SHALL be undefined.
readonly String transferType
In case the download was triggered through a Content Access Download Descriptor, this is the value of property TransferType of the selected <ContentURL>. In the case where the download was not triggered through a Content Access Download Descriptor, the OITF is responsible for returning either the value “playable_download” or “full_download”, based on criteria defined by the OITF.
readonly String originSite
In the case where the download was triggered through a Content Access Download Descriptor, this is the value of element <OriginSite>. In case the download was not triggered through a Content Access Download Descriptor, this is the FQDN of the site that initiated the download.
readonly String originSiteName
In case the download is triggered through a Content Access Download Descriptor, this is the value of element <OriginSiteName>, or undefined if this information is not present. In case the download is not triggered through a Content Access Download Descriptor, this property is undefined.
String contentID
A unique identification of the content item relative to originSite. In case the download is triggered through a Content Access Download Descriptor, and a <ContentID> element has been defined for the given content item, this is the value of element <ContentID>. If the download is started using registerDownloadFromCRID(), this is the TV Anytime CRID. This property shall take the value undefined if no content ID is available. If the Content Access Download Descriptor is not specified the property may be set by the originSite. Note that the property may only be set by the site that initiated the download. The DAE application may store data related to the Download. The OITF SHALL support a minimum of 2000 bytes for the property. If DAE application attempts to store a string larger than the available size the OITF SHALL set the property to NULL. The maximum length of the property value is implementation dependent.
readonly String iconURL
The URL of an image that provides a visual representation of the item that is being downloaded. In the case where the download was triggered a Content Access Download Descriptor, this is the value of element <IconURL>, or undefined if this element is not present. In the case where the download was not triggered through a content access descriptor document, this property is undefined.
readonly Document metadata
For downloads registered through a Content Access Download Descriptor, this function SHALL return the contents of the Content Access Download Descriptor as an XML Document object using the syntax as defined in section E.1 without using any namespace definitions. For downloads registered using a URL, the value of this property SHALL be null.
readonly Integer priority
The relative priority of the download with respect to other downloads registered by that application. Higher values indicate a higher priority.
readonly Boolean suspendedByTerminal
Flag indicating whether the download has been paused automatically by the OITF, either because the download has been pre-empted by higher priority downloads or because the number of simultaneous downloads supported by the OITF has been exceeded.