Version:
interface

ScreenProviderInterface

A ScreenActionProvider should provide access to a system's main screen

typescript
interface ScreenProviderInterface

Methods

grabScreen

grabScreen(): Promise<Image>

grabScreen should return an object containing a screenshot data of a systems
main screen as well as its dimensions

Returns

Promise<Image>

grabScreenRegion

grabScreenRegion(region: Region): Promise<Image>

Returns the same result as grabScreen, but limited to a specified region

Parameters

regionRegionThe to take the screenshot of

Returns

Promise<Image>

highlightScreenRegion

highlightScreenRegion(region: Region, duration: number, opacity: number): Promise<void>

Highlights a screen for a given duration by overlaying it with an opaque window

Parameters

regionRegionThe to highlight
durationnumberThe highlight duration
opacitynumberOverlay opacity

Returns

Promise<void>

screenHeight

screenHeight(): Promise<number>

screenHeight returns a systems main screen height

Returns

Promise<number>

screenSize

screenSize(): Promise<Region>

screenSize returns a object the size of a systems main screen

Returns

Promise<Region>

screenWidth

screenWidth(): Promise<number>

screenWidth returns a systems main screen width

Returns

Promise<number>

Was this page helpful?