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, |
||||||||||||
|
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:
· 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:
|
||||||||||||||||
|
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:
|
||||||||||||
Events
For the intrinsic events listed in the table below, a corresponding DOM event SHALL be generated in the following manner:
| Intrinsic event | Corresponding DOM event | DOM Event properties |
| onSoftwareUpdate | SoftwareUpdate | Bubbles: 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.