Learn how to evaluate and integrate the VNC SDK
DisplayManager¶
-
class
vncsdk.
DisplayManager
¶ Manages the list of displays made available by a Server.
Nested Classes¶
Method Summary¶
Modifier and Type | Method and Description |
---|---|
Specifies whether screen sharing is enabled. |
|
int |
Returns the number of displays. |
int |
Gets the index of the currently selected display. |
str |
Gets the ID of the display (typically a short string). |
str |
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. |
bool |
Returns whether the server is sharing its screens, whether it is being called from a server or a viewer. |
bool |
Returns whether this is the primary (or main) display. |
bool |
Returns whether the selectDisplay() call is permitted. |
Chooses a particular display to remote to connected Viewer app users. |
|
Registers a callback notifying when displays are added or removed, or the resolution of an existing display changes. |
Methods¶
-
DisplayManager.
enable
(enable)¶ Specifies whether screen sharing is enabled.
For more information, see
vnc_DisplayManager_enable()
.Parameters: enable (bool) –
-
DisplayManager.
get_display_count
()¶ Returns the number of displays.
For more information, see
vnc_DisplayManager_getDisplayCount()
.Return type: int
-
DisplayManager.
get_display_index
()¶ Gets the index of the currently selected display.
For more information, see
vnc_DisplayManager_getDisplayIndex()
.Return type: int
-
DisplayManager.
get_id
(index)¶ Gets the ID of the display (typically a short string).
For more information, see
vnc_DisplayManager_getId()
.Parameters: index (int) – Return type: str
-
DisplayManager.
get_name
(index)¶ Gets the name of the display (typically a human-readable string).
For more information, see
vnc_DisplayManager_getName()
.Parameters: index (int) – Return type: str
-
DisplayManager.
get_origin_x
(index)¶ Gets the horizontal origin of the display in pixels.
For more information, see
vnc_DisplayManager_getOriginX()
.Parameters: index (int) – Return type: int
-
DisplayManager.
get_origin_y
(index)¶ Gets the vertical origin of the display in pixels.
For more information, see
vnc_DisplayManager_getOriginY()
.Parameters: index (int) – Return type: int
-
DisplayManager.
get_resolution_x
(index)¶ Gets the horizontal resolution of the display in pixels.
For more information, see
vnc_DisplayManager_getResolutionX()
.Parameters: index (int) – Return type: int
-
DisplayManager.
get_resolution_y
(index)¶ Gets the vertical resolution of the display in pixels.
For more information, see
vnc_DisplayManager_getResolutionY()
.Parameters: index (int) – Return type: int
-
DisplayManager.
is_enabled
()¶ 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()
.Return type: bool
-
DisplayManager.
is_primary
(index)¶ Returns whether this is the primary (or main) display.
For more information, see
vnc_DisplayManager_isPrimary()
.Parameters: index (int) – Return type: bool
-
DisplayManager.
is_select_display_allowed
()¶ Returns whether the selectDisplay() call is permitted.
For more information, see
vnc_DisplayManager_isSelectDisplayAllowed()
.Return type: bool
-
DisplayManager.
select_display
(index)¶ Chooses a particular display to remote to connected Viewer app users.
For more information, see
vnc_DisplayManager_selectDisplay()
.Parameters: index (int) –
-
DisplayManager.
set_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()
.Parameters: callback ( vncsdk.DisplayManager.Callback
or None) –