Class default

Hierarchy

default

Implements

ScreenProviderInterface

Index

Constructors

constructor

Methods

Constructors

constructor

new default(): default

- Defined in provider/native/libnut-screen.class.ts:19
Returns default

Methods

grabScreen

grabScreen(): Promise<Image>

Implementation of ScreenProviderInterface.grabScreen
- Defined in provider/native/libnut-screen.class.ts:22
grabScreen should return an Image object containing a screenshot data of a systems main screen as well as its dimensions

Returns Promise<Image>

grabScreenRegion

grabScreenRegion(region: Region): Promise<Image>

Implementation of ScreenProviderInterface.grabScreenRegion
- Defined in provider/native/libnut-screen.class.ts:48
Returns the same result as grabScreen, but limited to a specified region

Parameters
- region: Region
Returns Promise<Image>

highlightScreenRegion

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

Implementation of ScreenProviderInterface.highlightScreenRegion
- Defined in provider/native/libnut-screen.class.ts:75
Highlights a screen Region for a given duration by overlaying it with an opaque window

Parameters
- region: Region
- duration: number
- opacity: number
Returns Promise<void>

screenHeight

screenHeight(): Promise<number>

Implementation of ScreenProviderInterface.screenHeight
- Defined in provider/native/libnut-screen.class.ts:94
screenHeight returns a systems main screen height

Returns Promise<number>

screenSize

screenSize(): Promise<Region>

Implementation of ScreenProviderInterface.screenSize
- Defined in provider/native/libnut-screen.class.ts:105
screenSize returns a Region object the size of a systems main screen

Returns Promise<Region>

screenWidth

screenWidth(): Promise<number>

Implementation of ScreenProviderInterface.screenWidth
- Defined in provider/native/libnut-screen.class.ts:83
screenWidth returns a systems main screen width

Returns Promise<number>