The application/oipfRemoteManagement embedded object

Support in HbbTV

Available since: Not implemented in HbbTV

The application/oipfRemoteManagement embedded object has the following properties and methods.

Access to the functionality of the application/oipfRemoteManagement embedded object SHALL adhere to the security requirements as defined in section 10.

Properties

readonly String vendorName
The value of this property SHALL be the same as the value of the LocalSystem.vendorName property (see section 7.3.3.1)
readonly String modelName
The value of this property SHALL be the same as the value of the LocalSystem.modelName property (see section 7.3.3.1)
readonly String softwareVersion
The value of this property SHALL be the same as the value of the LocalSystem.softwareVersion property (see section 7.3.3.1)
readonly String hardwareVersion
The value of this property SHALL be the same as the value of the LocalSystem.hardwareVersion property (see section 7.3.3.1)
readonly String familyName
The value of this property SHALL be the same as the value of the LocalSystem.familyName property (see section 7.3.3.1)

function onSoftwareUpdate( String updateEvent, Integer seconds, String message,
String version )

The function that is called when the OITF’s software update state is changed. The specified function is called with the following arguments:

· String updateEvent – The event type that caused the invocation of this function. One of:

Value

Description

SOFTWARE_AVAILABLE

New software for the OITF has been found on a remote management server. The message argument may contain a user-centric message regarding this new software version and the version argument may contain the version number of the software update.

SOFTWARE_DOWNLOADING

New software for the OITF is in the process of being downloaded. The version argument may contain the version number of the software being downloaded. This event type may be signalled at multiple times during the download of the new software, indicating positive progress; in this case the message argument should contain an indication of the download progress.

SOFTWARE_DOWNLOAD_FAILED

The download of new software has failed. A descriptive reason for the failure may be found in the message argument and the version argument may contain the version number of the software that failed to be downloaded

SOFTWARE_DOWNLOADED

A new software version of the OITF has been downloaded but has not yet been installed. Applications can now save relevant data that should survive a firmware upgrade. The actual mechanism of the download is out of scope of this specification. The message argument may contain a user-centric message regarding this new software version. The seconds argument has no significance.

FORCED_UPDATE

A new software version will shortly be installed. This event may occur if the users has not agreed to install the software but the system must have a new software version. The seconds argument gives the time until the OITF will install the new software.

· Integer seconds – The time before action takes place. The meaning depends on the event type as described above.

· String message – A message that may be used to inform the user about the purpose of this update to the software in order to receive the users consent to perform the actual update. undefined if not used.

· String version – The new version number of the software identified for the update, or undefined if not available.

Methods

String getParameter( String parameterName )

Description

Returns the requested parameter.

Arguments

parameterName

“SAMPLE_PACKET_LOSS”: This queries the RTP packet loss since the last call to this function, or the start of the current RTP content item, whichever is more recent. The returned string is of the format “<time in milliseconds since the last sample> <fraction lost> <number of packets lost>”. These fields (i.e. <xxx>) are defined as described in [RFC3550] section 6.4.2 and are decimal numbers (encoded as strings). If no content item is playing an empty string is returned.

“SAMPLE_DECODER_ERRORS”: This queries the decoder errors since the last call to this function, or the start of the current RTP content item, whichever is more recent. The returned string is of the format “<time in milliseconds since the sample> <total number of frames decoded> <total number of errors>”. These fields are decimal numbers (encoded as strings). If no content item is playing an empty string is returned.

“CUMULATIVE_PACKET_LOSS”: This queries the RTP packet loss since the start of the current RTP content item. The returned string is of the format “<time in milliseconds of this sample within the content> <fraction lost> <number of packets lost>”. These fields (i.e. <xxx>) are defined as described in [RFC3550] section 6.4.2 and are decimal numbers (encoded as strings). If no content item is playing an empty string is returned.

“CUMULATIVE_DECODER_ERRORS”: This queries the decoder errors since the start of the current RTP content item, whichever is more recent. The returned string is of the format “<time in milliseconds of this sample within the content> <total number of frames decoded> <total number of errors>”. These fields are decimal numbers (encoded as strings). If no content item is playing an empty string is returned.

Values are not case sensitive. Optionally, further vendor specific parameters may be supported.

In the case that a parameter is requested that a device does not support, it SHALL return an empty string.

Integer triggerSoftwareUpdate( String token )

Description

Triggers an OITF to start its software update process. The process itself and any user involvement (e.g. to confirm agreement for a software update) is not defined. The method is blocking. The process of updating the software MAY generate SoftwareUpdate events to indicate progress.

The returned integer is a result code that can take the following values:

Result message

Description

Semantics

0

Successful

The request is successful and the device software will be updated.

1

Unknown error

triggerSoftwareUpdate() failed because an unspecified error occurred.

2

Invalid token

triggerSoftwareUpdate() failed because the token is not valid.

3

No update available

triggerSoftwareUpdate() failed, because no update exists.

Arguments

token

An optional token string used to assist in the software update process. The token may be used to transfer credentials information to control the software update.

Integer softwareUpdateStatus()

Description

Returns the current status of any ongoing software update activity. The value returned by this function shall be:

Value

Description

-2

No software update is in progress.

-1

New software is available to download for the OITF.

0 … 99

New software is being downloaded to the OITF and the value gives an approximation of the amount already downloaded.

100

Indicates that new software has been successfully downloaded to the OITF and is available for installation.

1001 … 1999

Indicates that an error occurred during the download of new software to the OITF. This range of values can be used to provide an implementation specific error code.

Events

For the intrinsic events listed in the table below, a corresponding DOM event SHALL be generated in the following manner:

Intrinsic eventCorresponding DOM eventDOM Event properties
onSoftwareUpdateSoftwareUpdateBubbles: No Cancellable: No Context Info: updateEvent, seconds

Note: the DOM events are directly dispatched to the event target, and will not bubble nor capture. Applications SHOULD NOT rely on receiving these events during the bubbling or the capturing phase. Remote UIs that use DOM event handlers SHALL call the addEventListener() method on the application/oipfScheduledRecording object itself. The third parameter of addEventListener, i.e. “useCapture”, will be ignored.