|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ocap.hardware.Host
public class Host
This class represents the host terminal device and provides access to the Host ID, raw image data, the power state of the host and a java.util.Enumeration of references to VideoOutputPort instances. See also org.ocap.OcapSystem to get the singleton instance.
Field Summary | |
---|---|
static int |
FULL_POWER
Power mode constant for normal "on" mode. |
static int |
LOW_POWER
Power mode constant for "standby" mode. |
Constructor Summary | |
---|---|
protected |
Host()
A constructor of this class. |
Method Summary | |
---|---|
void |
addPowerModeChangeListener(PowerModeChangeListener l)
Adds the PowerModeChangeListener to be called ( PowerModeChangeListener.powerModeChanged(int)
when the power mode of the box changes (for example when the user presses the Power button). |
void |
codeDownload()
This method initiates a download of the operating software in the Host as specified by [CCIF2.0]. |
boolean |
getACOutlet()
Query whether power to the AC Outlet, if present, is currently On (true) or Off (false) NOTE: AC Outlet refers to an external power plug on the STB. |
java.lang.String |
getID()
Get a human-readable string representing the ID of this Host. |
static Host |
getInstance()
This method returns a singleton system-wide instance of the Host class. |
int |
getPowerMode()
|
java.lang.String |
getReverseChannelMAC()
Gets the MAC address used by the Host for reverse channel unicast communications. |
boolean |
getRFBypass()
Queries whether RF Bypass is currently enabled. |
boolean |
getRFBypassCapability()
Returns capability of RF bypass control on the host. |
java.util.Enumeration |
getVideoOutputPorts()
This method returns a java.util.Enumeration of references to VideoOutputPort instances. |
boolean |
isACOutletPresent()
Query whether there is an AC Outlet on the STB. |
void |
reboot()
This method initiates a reboot of the Host device. |
void |
removePowerModeChangeListener(PowerModeChangeListener l)
Removes the previously-added PowerModeChangeListener. |
void |
removeXAIT()
Removes the XAIT saved to persistent storage. |
void |
setACOutlet(boolean enable)
Switch power to AC Outlet, if present, On (true) or Off (false) NOTE: AC Outlet refers to an external power plug on the STB. |
void |
setPowerMode(int mode)
Transition the power mode of the system to the given mode. |
void |
setRFBypass(boolean enable)
Enables or disables RF Bypass. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int FULL_POWER
public static final int LOW_POWER
Constructor Detail |
---|
protected Host()
getInstance()
method to create an instance.
Method Detail |
---|
public static Host getInstance()
public java.lang.String getID()
public int getPowerMode()
FULL_POWER
,
LOW_POWER
public java.lang.String getReverseChannelMAC()
public void addPowerModeChangeListener(PowerModeChangeListener l)
PowerModeChangeListener.powerModeChanged(int)
when the power mode of the box changes (for example when the user presses the Power button).
l
- is an instance implementing PowerModeChangeListener whose
powerModeChanged method will be called when the power mode of the Host Device changes.public void removePowerModeChangeListener(PowerModeChangeListener l)
l
- is the PowerModeChangeListener to disable. Does nothing if
l was never added, has been removed, or is null.public java.util.Enumeration getVideoOutputPorts()
public void reboot()
This method initiates a reboot of the Host device. The method caller shall have the MonitorAppPermission("reboot").
Note that the SystemEventListener.notifyEvent(org.ocap.system.event.SystemEvent)
method SHALL be called before the initiated reboot is performed by
the Host device. The monitor application MAY clean up resources
in the SystemEventListener.notifyEvent method call.
After the SystemEventListener.notifyEvent method call returns, the
Host device SHALL continue the reboot following the boot process described in
the Boot Process Section of this specification.
java.lang.SecurityException
- if the caller does not have the
MonitorAppPermission("reboot").public void codeDownload()
This method initiates a download of the operating software in the Host as specified by [CCIF2.0].
java.lang.SecurityException
- if the caller does not have
MonitorAppPermission("codeDownload").public boolean isACOutletPresent()
public boolean getACOutlet()
java.lang.IllegalStateException
- if this method is called when there is no AC Outlet.public void setACOutlet(boolean enable)
enable
- The power setting for the AC Outlet.
java.lang.IllegalStateException
- if this method is called when there is no AC Outlet.public boolean getRFBypassCapability()
public boolean getRFBypass()
public void setRFBypass(boolean enable)
enable
- If true, RF Bypass will be enabled. Otherwise it will be
disabled.
java.lang.IllegalStateException
- if the host doesn’t support RF
bypass.public void removeXAIT()
java.lang.SecurityException
- if the calling application is not granted
MonitorAppPermission("storage").public void setPowerMode(int mode)
If the power mode is already in the target mode, this method SHALL do nothing. Setting host power mode to low-power SHALL NOT disrupt any ongoing recording. In devices where a separate power mode is maintained for standby recordings, setting the power mode to low-power SHALL transition to standby-recording power mode when a recording is in progress.
A change of power mode SHALL be communicated to installed
PowerModeChangeListener
s.
mode
- The new power mode for the system.
java.lang.IllegalArgumentException
- if mode is not one of
FULL_POWER
or LOW_POWER
java.lang.SecurityException
- if the caller does not have
MonitorAppPermission("powerMode")
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |