Interface ScreenProviderInterface

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

Interface

ScreenProviderInterface

Hierarchy

ScreenProviderInterface

Implemented by

default

Index

Methods

grabScreen grabScreenRegion highlightScreenRegion screenHeight screenSize screenWidth

Methods

grabScreen

grabScreen(): Promise<Image>
grabScreen should return an Image object containing a screenshot data of a systems main screen as well as its dimensions

Returns
The Image object holding screenshot data

Returns Promise<Image>
- Defined in provider/screen-provider.interface.ts:16

grabScreenRegion

grabScreenRegion(region: Region): Promise<Image>
Returns the same result as grabScreen, but limited to a specified region

Returns
The Image object holding screenshot data
Parameters
- region: Region
  
  The Region to take the screenshot of
Returns Promise<Image>
- Defined in provider/screen-provider.interface.ts:24

highlightScreenRegion

highlightScreenRegion(region: Region, duration: number, opacity: number): Promise<void>
Highlights a screen Region for a given duration by overlaying it with an opaque window
Parameters
- region: Region
  
  The Region to highlight
- duration: number
  
  The highlight duration
- opacity: number
  
  Overlay opacity
Returns Promise<void>
- Defined in provider/screen-provider.interface.ts:33

screenHeight

screenHeight(): Promise<number>
screenHeight returns a systems main screen height

Returns
The screen height

Returns Promise<number>
- Defined in provider/screen-provider.interface.ts:51

screenSize

screenSize(): Promise<Region>
screenSize returns a Region object the size of a systems main screen

Returns
The Region object representing the screen dimensions

Returns Promise<Region>
- Defined in provider/screen-provider.interface.ts:58

screenWidth

screenWidth(): Promise<number>
screenWidth returns a systems main screen width

Returns
The screen width

Returns Promise<number>
- Defined in provider/screen-provider.interface.ts:44