Learn how to evaluate and integrate the VNC SDK
DisplayManager¶
-
class DisplayManager
¶ Manages the list of displays made available by a Server.
For more information, see
vnc_DisplayManager
in the C API documentation.
Nested classes¶
Method summary
Modifier and Type | Method and Description |
---|---|
Int32 |
Returns the number of displays. |
void |
Registers a callback notifying when displays are added or removed, or the resolution of an existing display changes. |
void |
Chooses a particular display to remote to connected Viewer app users. |
Int32 |
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). |
Boolean |
Returns whether this is the primary (or main) display. |
Int32 |
Gets the horizontal resolution of the display in pixels. |
Int32 |
Gets the vertical resolution of the display in pixels. |
Int32 |
Gets the horizontal origin of the display in pixels. |
Int32 |
Gets the vertical origin of the display in pixels. |
Boolean |
Returns whether the selectDisplay() call is permitted. |
void |
Specifies whether screen sharing is enabled. |
Boolean |
Returns whether the server is sharing its screens, whether it is being called from a server or a viewer. |
Methods¶
-
Int32
DisplayManager.GetDisplayCount
()¶ Returns the number of displays.
For more information, see
vnc_DisplayManager_getDisplayCount()
in the C API documentation.
-
void
DisplayManager.SetCallback
(DisplayManager.Callback callback)¶ 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()
in the C API documentation.
-
void
DisplayManager.SelectDisplay
(Int32 index)¶ Chooses a particular display to remote to connected Viewer app users.
For more information, see
vnc_DisplayManager_selectDisplay()
in the C API documentation.
-
Int32
DisplayManager.GetDisplayIndex
()¶ Gets the index of the currently selected display.
For more information, see
vnc_DisplayManager_getDisplayIndex()
in the C API documentation.
-
String
DisplayManager.GetId
(Int32 index)¶ Gets the ID of the display (typically a short string).
For more information, see
vnc_DisplayManager_getId()
in the C API documentation.
-
String
DisplayManager.GetName
(Int32 index)¶ Gets the name of the display (typically a human-readable string).
For more information, see
vnc_DisplayManager_getName()
in the C API documentation.
-
Boolean
DisplayManager.IsPrimary
(Int32 index)¶ Returns whether this is the primary (or main) display.
For more information, see
vnc_DisplayManager_isPrimary()
in the C API documentation.
-
Int32
DisplayManager.GetResolutionX
(Int32 index)¶ Gets the horizontal resolution of the display in pixels.
For more information, see
vnc_DisplayManager_getResolutionX()
in the C API documentation.
-
Int32
DisplayManager.GetResolutionY
(Int32 index)¶ Gets the vertical resolution of the display in pixels.
For more information, see
vnc_DisplayManager_getResolutionY()
in the C API documentation.
-
Int32
DisplayManager.GetOriginX
(Int32 index)¶ Gets the horizontal origin of the display in pixels.
For more information, see
vnc_DisplayManager_getOriginX()
in the C API documentation.
-
Int32
DisplayManager.GetOriginY
(Int32 index)¶ Gets the vertical origin of the display in pixels.
For more information, see
vnc_DisplayManager_getOriginY()
in the C API documentation.
-
Boolean
DisplayManager.IsSelectDisplayAllowed
()¶ Returns whether the selectDisplay() call is permitted.
For more information, see
vnc_DisplayManager_isSelectDisplayAllowed()
in the C API documentation.
-
void
DisplayManager.Enable
(Boolean enable)¶ Specifies whether screen sharing is enabled.
For more information, see
vnc_DisplayManager_enable()
in the C API documentation.
-
Boolean
DisplayManager.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()
in the C API documentation.