Learn how to evaluate and integrate the VNC SDK
DisplayManager¶
-
public abstract class
DisplayManager
¶ Manages the list of displays made available by a Server.
Nested Classes¶
- interface
DisplayManager.Callback
Method Summary¶
Modifier and Type | Method and Description |
---|---|
void |
Specifies whether screen sharing is enabled. |
int |
Returns the number of displays. |
int |
Gets the index of the currently selected display. |
String |
Gets the ID of the display (typically a short string). |
String |
Gets the name of the display (typically a human-readable string). |
int |
Gets the horizontal origin of the display in pixels. |
int |
Gets the vertical origin of the display in pixels. |
int |
Gets the horizontal resolution of the display in pixels. |
int |
Gets the vertical resolution of the display in pixels. |
boolean |
Returns whether the server is sharing its screens, whether it is being called from a server or a viewer. |
boolean |
Returns whether this is the primary (or main) display. |
boolean |
Returns whether the selectDisplay() call is permitted. |
void |
Chooses a particular display to remote to connected Viewer app users. |
void |
Registers a callback notifying when displays are added or removed, or the resolution of an existing display changes. |
Methods¶
-
public void
enable
(boolean enable) throws Library.VncException¶ Specifies whether screen sharing is enabled.
For more information, see
vnc_DisplayManager_enable()
.
-
public int
getDisplayCount
()¶ Returns the number of displays.
For more information, see
vnc_DisplayManager_getDisplayCount()
.
-
public int
getDisplayIndex
()¶ Gets the index of the currently selected display.
For more information, see
vnc_DisplayManager_getDisplayIndex()
.
-
public String
getId
(int index) throws Library.VncException¶ Gets the ID of the display (typically a short string).
For more information, see
vnc_DisplayManager_getId()
.
-
public String
getName
(int index) throws Library.VncException¶ Gets the name of the display (typically a human-readable string).
For more information, see
vnc_DisplayManager_getName()
.
-
public int
getOriginX
(int index)¶ Gets the horizontal origin of the display in pixels.
For more information, see
vnc_DisplayManager_getOriginX()
.
-
public int
getOriginY
(int index)¶ Gets the vertical origin of the display in pixels.
For more information, see
vnc_DisplayManager_getOriginY()
.
-
public int
getResolutionX
(int index)¶ Gets the horizontal resolution of the display in pixels.
For more information, see
vnc_DisplayManager_getResolutionX()
.
-
public int
getResolutionY
(int index)¶ Gets the vertical resolution of the display in pixels.
For more information, see
vnc_DisplayManager_getResolutionY()
.
-
public boolean
isEnabled
()¶ Returns whether the server is sharing its screens, whether it is being called from a server or a viewer.
For more information, see
vnc_DisplayManager_isEnabled()
.
-
public boolean
isPrimary
(int index)¶ Returns whether this is the primary (or main) display.
For more information, see
vnc_DisplayManager_isPrimary()
.
-
public boolean
isSelectDisplayAllowed
()¶ Returns whether the selectDisplay() call is permitted.
For more information, see
vnc_DisplayManager_isSelectDisplayAllowed()
.
-
public void
selectDisplay
(int index) throws Library.VncException¶ Chooses a particular display to remote to connected Viewer app users.
For more information, see
vnc_DisplayManager_selectDisplay()
.
-
public void
setCallback
(DisplayManager.Callback callback) throws Library.VncException¶ Registers a callback notifying when displays are added or removed, or the resolution of an existing display changes.
For more information, see
vnc_DisplayManager_setCallback()
.