|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ocap.hardware.pod.POD
public class POD
This class provides an access to functions and information of the OpenCable CableCARD device on the OCAP Host device. The following functions and information are provided.
Constructor Summary | |
---|---|
protected |
POD()
A constructor of this class. |
Method Summary | |
---|---|
PODApplication[] |
getApplications()
This method returns the CableCARD device applications listed in the Application_info_cnf() APDU defined in the OpenCable CableCARD Interface specification. |
int[] |
getHostFeatureList()
This method returns a list of the Feature IDs supported by the Host device. |
byte[] |
getHostParam(int featureID)
This method returns the current Feature parameter value in the Host device for the specified Feature ID. |
static POD |
getInstance()
This method returns the sole instance of the POD class. |
int |
getManufacturerID()
This method returns a CableCARD device manufacturer ID. |
int |
getVersionNumber()
This method returns a CableCARD device version number. |
boolean |
isReady()
This method provides a current status of the CableCARD device. |
void |
setHostParamHandler(HostParamHandler handler)
This method sets an instance of a class that implements the HostParamHandler interface. |
boolean |
updateHostParam(int featureID,
byte[] value)
This method updates the Feature parameter value in the Host device. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected POD()
getInstance()
method to create an instance.
Method Detail |
---|
public static POD getInstance()
java.lang.SecurityException
- if the caller does not have
MonitorAppPermission("podApplication").public boolean isReady()
public int getManufacturerID()
java.lang.IllegalStateException
- if the CableCARD is not ready, i.e.,
the isReady()
method returns false.public int getVersionNumber()
java.lang.IllegalStateException
- if the CableCARD is not ready, i.e.,
the isReady()
method returns false.public PODApplication[] getApplications()
This method returns the CableCARD device applications listed in the Application_info_cnf() APDU defined in the OpenCable CableCARD Interface specification.
Note that the Host need not to send the Application_info_req APDU. It may cache the information.
java.lang.IllegalStateException
- if the CableCARD is not ready, i.e.,
the isReady()
method returns false.public int[] getHostFeatureList()
public boolean updateHostParam(int featureID, byte[] value)
This method updates the Feature parameter value in the Host device.
In this method call, the HostParamHandler.notifyUpdate(int, byte[])
method
shall be called. The notifyUpdate() method may reject update of the
Feature parameter and also the Host device may reject it.
The updated Feature parameter shall be notified to the CableCARD device
according to [CCIF 2.0] after this
method returns, but this method doesn't confirm a successful
notification to the CableCARD device.
The Feature ID and Feature parameter format is defined in [CCIF 2.0].
See also the
HostParamHandler
for more information.
Note that the
HostParamHandler.notifyUpdate(int, byte[])
method
shall be called before the Feature parameter is updated by this method
call.
featureID
- a Feature ID to be updated. Feature ID is defined
in [CCIF 2.0].
The Feature ID reserved for proprietary use (0x70 - 0xFF)
can be specified.value
- a new Feature parameter value for the specified featureID.
An actual format of each Feature parameter is defined
in [CCIF 2.0].
For example, if the featureID is 0x1, the value is
Rf_output_channel() {
Output_channel
Output_channel_ui
}
true
if update was successful.
false
if rejected by the Host.
java.lang.IllegalArgumentException
- if the specified featureID is not in a
range of 0 <= featureID <= 0xFF, or the value is null.HostParamHandler
public byte[] getHostParam(int featureID)
HostParamHandler
for more information.
featureID
- a Feature ID defined
in [CCIF 2.0].
The Feature ID reserved for proprietary use (0x70 - 0xFF)
can be specified.
Rf_output_channel() {
Output_channel
Output_channel_ui
}
An array of length zero, if the specified featureID is
not supported.
java.lang.IllegalArgumentException
- if the specified featureID is not in a
range of 0 <= featureID <= 0xFF.HostParamHandler
public void setHostParamHandler(HostParamHandler handler)
handler
- an instance of a class that implements the
HostParamHandler. if null
is specified,
the current HostParamHandler is removed.HostParamHandler
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |