ISourceScreen
Defined in: core/source/iscreen.ts:10
Methods
Section titled “Methods”getCaptureArea()
Section titled “getCaptureArea()”getCaptureArea():
Promise<Rectangle>
Defined in: core/source/iscreen.ts:119
return: Promise
Gets the Capture Area of the Screen Capture Item. Returns a Rectangle object.
See also: #util/Rectangle Util/Rectangle
Returns
Section titled “Returns”Promise<Rectangle>
getCaptureLayered()
Section titled “getCaptureLayered()”getCaptureLayered():
Promise<boolean>
Defined in: core/source/iscreen.ts:36
return Promise
Checks if the Screen Capture layered window is selected.
Returns
Section titled “Returns”Promise<boolean>
getOptimizedCapture()
Section titled “getOptimizedCapture()”getOptimizedCapture():
Promise<boolean>
Defined in: core/source/iscreen.ts:53
return Promise
Checks if the Exclusive Window capture is selected.
Returns
Section titled “Returns”Promise<boolean>
getShowMouse()
Section titled “getShowMouse()”getShowMouse():
Promise<boolean>
Defined in: core/source/iscreen.ts:96
return: Promise
Checks if the Show mouse is selected.
ShowMouse determine if you would want to display the mouse on your screen captured area.
Returns
Section titled “Returns”Promise<boolean>
getShowMouseClicks()
Section titled “getShowMouseClicks()”getShowMouseClicks():
Promise<boolean>
Defined in: core/source/iscreen.ts:73
return: Promise
Checks if the Show mouse clicks is selected.
ShowMouseClicks determine if you would want to display the clicks you’re doing inside your screen captured area.
Returns
Section titled “Returns”Promise<boolean>
isClientArea()
Section titled “isClientArea()”isClientArea():
Promise<boolean>
Defined in: core/source/iscreen.ts:141
return: Promise
Checks if the Screen Capture Item only captures the Client area (does not capture the title bar, menu bar, window border, etc.)
Returns
Section titled “Returns”Promise<boolean>
isStickToTitle()
Section titled “isStickToTitle()”isStickToTitle():
Promise<boolean>
Defined in: core/source/iscreen.ts:17
return: Promise
Checks if the Screen Capture Item captures a window based on the window’s title.
Returns
Section titled “Returns”Promise<boolean>
setCaptureArea()
Section titled “setCaptureArea()”setCaptureArea(
dimension):Promise<ISourceScreen>
Defined in: core/source/iscreen.ts:133
param: Promise
return: Promise<ISourceScreen>Sets the Window Capture Area of the Screen Capture Item.
Chainable.
See also: #util/Rectangle Util/Rectangle
Parameters
Section titled “Parameters”dimension
Section titled “dimension”Returns
Section titled “Returns”Promise<ISourceScreen>
setCaptureLayered()
Section titled “setCaptureLayered()”setCaptureLayered(
value):Promise<ISourceScreen>
Defined in: core/source/iscreen.ts:46
param: (value: boolean)
return Promise<ISourceScreen>Sets the Screen Capture Layered window
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourceScreen>
setClientArea()
Section titled “setClientArea()”setClientArea(
value):Promise<ISourceScreen>
Defined in: core/source/iscreen.ts:152
param: Promise
return: Promise<ISourceScreen>Set the Screen Capture to capture the Client area only or include the titlebar, menu bar, window border, etc.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourceScreen>
setOptimizedCapture()
Section titled “setOptimizedCapture()”setOptimizedCapture(
value):Promise<ISourceScreen>
Defined in: core/source/iscreen.ts:63
param: (value: boolean)
return Promise<ISourceScreen>Sets the Exclusive Window capture.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourceScreen>
setShowMouse()
Section titled “setShowMouse()”setShowMouse(
value):Promise<ISourceScreen>
Defined in: core/source/iscreen.ts:109
param: (value: boolean)
return: Promise<ISourceScreen>Sets the Show Mouse.
ShowMouse determine if you would want to display the mouse on your screen captured area.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourceScreen>
setShowMouseClicks()
Section titled “setShowMouseClicks()”setShowMouseClicks(
value):Promise<ISourceScreen>
Defined in: core/source/iscreen.ts:86
param: (value: boolean)
return: Promise<ISourceScreen>Sets the Show mouse clicks.
ShowMouseClicks determine if you would want to display the clicks you’re doing inside your screen captured area.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourceScreen>
setStickToTitle()
Section titled “setStickToTitle()”setStickToTitle(
value):Promise<ISourceScreen>
Defined in: core/source/iscreen.ts:29
param: Promise
return: Promise<ISourceScreen>Set the Screen Capture to capture the window based on the window title. Useful when capturing programs with multiple tabs, for you to only capture a particular tab.
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<ISourceScreen>