Displays
5.1.0Glue42 Desktop provides a way for applications to programmatically capture screenshots of the available monitors, of windows and window groups.
Based on custom logic you can capture one or all monitors in order to save a snapshot of the visual state at a given moment.
The Displays API is accessible through glue.displays.
object
Description
Displays API.
Description
Returns all Display objects.
Returns
Promise<Display[]>
Description
Returns a single display by ID.
Parameters
id
number
yes
ID of the desired display.
Returns
Promise<Display>
() => Promise<Display>
Description
Returns the primary display.
Returns
Promise<Display>
(options: CaptureAllOptions) => Promise<string | string[]>
Description
Returns a base64 string of the screenshots of all displays. The returned value depends on the combined property specified in the options object.
Parameters
options
yes
Options object specifying the way the captured screenshots should be returned.
Returns
Promise<string | string[]>
(options: CaptureOptions) => Promise<string>
Description
Returns a base64 string of the screenshot of a single display.
Parameters
options
yes
Options object specifying the ID of the display to capture and the size of the returned image.
Returns
Promise<string>
() => Promise<Point>
Description
Returns the X and Y coordinates of the mouse cursor.
Returns
Promise<Point>
object
Description
Object describing a display.
Properties
id:
Unique identifier associated with the display.
bounds:
Bounds of the display (width, height, left and top coordinates)
workingArea:
The working area of the display.
dpi:
Display resolution.
isPrimary:
Whether this is the primary display.
index:
Index assigned to the display by the operating system.
name:
Name assigned to the display by the operating system.
aspectRatio:
Aspect ratio of the display (e.g., 16:9).
scaleFactor:
The scale factor of the returned display.
capture:
Captures a screenshot of the current display.
object
Description
Object describing the bounds of the display.
Properties
height:
The height of the display (integer).
width:
The width of the display (integer).
left:
The horizontal coordinate of the top left corner of the display (integer).
top:
The vertical coordinate of the top left corner of the display (integer).
object
Description
Coordinates of a point on the screen.
Properties
x:
The X coordinate of the point.
y:
The Y coordinate of the point.
object
Description
Options for capturing a single display.
Properties
id:
A number specifying the ID of the targeted display.
size?:
Accepts either a ScaleOptions or an AbsoluteSizeOptions object, specifying the size of the output image.
object
Description
Options for capturing all displays.
Properties
combined:
Specifies whether to return a single image (if true) of all captured displays or a separate image (if false) for each captured display.
size?:
Accepts either a ScaleOptions or an AbsoluteSizeOptions object, specifying the size of the output image.
object
Description
Absolute size of the returned image.
Properties
width?:
Width of the returned image.
height?:
Height of the returned image.
keepAspectRatio?:
Specifies whether to keep the aspect ratio of the output image when you specify width and/or height of the output image.
If true and both width and height are set, then the specified width will be used as a basis for the output image aspect ratio.
object
Description
Relative size of the returned image.
Properties
scale:
Specifies the size of the output image relative to the actual screen size.