|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.virtualbox_4_2.IUnknown
org.virtualbox_4_2.IDisplay
public class IDisplay
The IDisplay interface represents the virtual machine's display.
The object implementing this interface is contained in each
IConsole.getDisplay()
attribute and represents the visual
output of the virtual machine.
The virtual display supports pluggable output targets represented by the
IFramebuffer interface. Examples of the output target are a window on
the host computer or an RDP session's display on a remote computer.
Interface ID: {B83EE395-8679-40CA-8D60-1A0CBE724930}
Field Summary |
---|
Fields inherited from class org.virtualbox_4_2.IUnknown |
---|
obj, port |
Constructor Summary | |
---|---|
IDisplay(java.lang.String wrapped,
org.virtualbox_4_2.jaxws.VboxPortType port)
|
Method Summary | |
---|---|
void |
getScreenResolution(java.lang.Long screenId,
Holder<java.lang.Long> width,
Holder<java.lang.Long> height,
Holder<java.lang.Long> bitsPerPixel)
Queries display width, height and color depth for given screen. |
void |
invalidateAndUpdate()
Does a full invalidation of the VM display and instructs the VM to update it. |
static IDisplay |
queryInterface(IUnknown obj)
|
void |
resizeCompleted(java.lang.Long screenId)
Signals that a framebuffer has completed the resize operation. |
void |
setSeamlessMode(java.lang.Boolean enabled)
Enables or disables seamless guest display rendering (seamless desktop integration) mode. |
void |
setVideoModeHint(java.lang.Long display,
java.lang.Boolean enabled,
java.lang.Boolean changeOrigin,
java.lang.Integer originX,
java.lang.Integer originY,
java.lang.Long width,
java.lang.Long height,
java.lang.Long bitsPerPixel)
Asks VirtualBox to request the given video mode from the guest. |
byte[] |
takeScreenShotPNGToArray(java.lang.Long screenId,
java.lang.Long width,
java.lang.Long height)
Takes a guest screen shot of the requested size and returns it as PNG image in array. |
byte[] |
takeScreenShotToArray(java.lang.Long screenId,
java.lang.Long width,
java.lang.Long height)
Takes a guest screen shot of the requested size and returns it as an array of bytes in uncompressed 32-bit RGBA format. |
void |
viewportChanged(java.lang.Long screenId,
java.lang.Long x,
java.lang.Long y,
java.lang.Long width,
java.lang.Long height)
Signals that framebuffer window viewport has changed. |
Methods inherited from class org.virtualbox_4_2.IUnknown |
---|
getRemoteWSPort, getWrapped, releaseRemote |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IDisplay(java.lang.String wrapped, org.virtualbox_4_2.jaxws.VboxPortType port)
Method Detail |
---|
public static IDisplay queryInterface(IUnknown obj)
public void getScreenResolution(java.lang.Long screenId, Holder<java.lang.Long> width, Holder<java.lang.Long> height, Holder<java.lang.Long> bitsPerPixel)
public void setVideoModeHint(java.lang.Long display, java.lang.Boolean enabled, java.lang.Boolean changeOrigin, java.lang.Integer originX, java.lang.Integer originY, java.lang.Long width, java.lang.Long height, java.lang.Long bitsPerPixel)
display
- The number of the guest display to send the hint to.enabled
- True, if this guest screen is enabled,
False otherwise.changeOrigin
- True, if the origin of the guest screen should be changed,
False otherwise.originX
- The X origin of the guest screen.originY
- The Y origin of the guest screen.
Expected result codes:
E_INVALIDARG | The display is not associated with any monitor. |
public void setSeamlessMode(java.lang.Boolean enabled)
IGuest.getFacilityStatus(org.virtualbox_4_2.AdditionsFacilityType,Holder)
with facility Seamless
does not return Active.
public byte[] takeScreenShotToArray(java.lang.Long screenId, java.lang.Long width, java.lang.Long height)
screenId
- Monitor to take screenshot from.width
- Desired image width.height
- Desired image height.
E_NOTIMPL | Feature not implemented. |
@link ::VBOX_E_IPRT_ERROR VBOX_E_IPRT_ERROR | Could not take a screenshot. |
public byte[] takeScreenShotPNGToArray(java.lang.Long screenId, java.lang.Long width, java.lang.Long height)
screenId
- Monitor to take the screenshot from.width
- Desired image width.height
- Desired image height.
E_NOTIMPL | Feature not implemented. |
@link ::VBOX_E_IPRT_ERROR VBOX_E_IPRT_ERROR | Could not take a screenshot. |
public void invalidateAndUpdate()
@link ::VBOX_E_IPRT_ERROR VBOX_E_IPRT_ERROR | Could not invalidate and update screen. |
public void resizeCompleted(java.lang.Long screenId)
@link ::VBOX_E_NOT_SUPPORTED VBOX_E_NOT_SUPPORTED | Operation only valid for external frame buffers. |
public void viewportChanged(java.lang.Long screenId, java.lang.Long x, java.lang.Long y, java.lang.Long width, java.lang.Long height)
screenId
- Monitor to take the screenshot from.x
- Framebuffer x offset.y
- Framebuffer y offset.width
- Viewport width.height
- Viewport height.
Expected result codes:
E_INVALIDARG | The specified viewport data is invalid. |
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |