Interface ScreenProviderInterface

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

ScreenProviderInterface

interface ScreenProviderInterface {
    grabScreen(): Promise<Image>;
    grabScreenRegion(region): Promise<Image>;
    highlightScreenRegion(region, duration, opacity): Promise<void>;
    screenHeight(): Promise<number>;
    screenSize(): Promise<Region>;
    screenWidth(): Promise<number>;
}

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 Promise<Image>
The Image object holding screenshot data
- Defined in provider-interfaces/lib/screen-provider.interface.ts:15

grabScreenRegion

grabScreenRegion(region): Promise<Image>
Returns the same result as grabScreen, but limited to a specified region
Parameters
- region: Region
  The Region to take the screenshot of
Returns Promise<Image>
The Image object holding screenshot data
- Defined in provider-interfaces/lib/screen-provider.interface.ts:23

highlightScreenRegion

highlightScreenRegion(region, duration, opacity): 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-interfaces/lib/screen-provider.interface.ts:32

screenHeight

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

Returns Promise<number>
The screen height
- Defined in provider-interfaces/lib/screen-provider.interface.ts:50

screenSize

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

Returns Promise<Region>
The Region object representing the screen dimensions
- Defined in provider-interfaces/lib/screen-provider.interface.ts:57

screenWidth

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

Returns Promise<number>
The screen width
- Defined in provider-interfaces/lib/screen-provider.interface.ts:43

Generated using TypeDoc