Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old


Sets video input to screen.

Component Version macOS Windows Linux Server iOS SDK
AVRecorder 8.4 ✅ Yes ❌ No ❌ No ❌ No ❌ No
MBS( "AVRecorder.SetScreenInput"; AVSession { ; DisplayIndex; capturesCursor; capturesMouseClicks; cropRectLeft; cropRectBottom; cropRectWidth; cropRectHeight } )   More


Parameter Description Example Flags
AVSession The ID for the AVRecorder session as returned by AVRecorder.Init. $AVSession
DisplayIndex The index of the screen.
Derfault is zero for main screen.
0 Optional
capturesCursor Whether the cursor should be rendered to the captured output.
By default, screen input draws the cursor in its captured output. If this parameter is zero, the captured output contains only the windows on the screen. Cursor is omitted. Note that cursor position and mouse button state at the time of capture is preserved in CMSampleBuffers emitted from screen input.
1 Optional
capturesMouseClicks Whether mouse clicks should be highlighted in the captured output.
By default, screen input does not highlight mouse clicks in its captured output. If this parameter is 1, mouse clicks are highlighted (a circle is drawn around the mouse for the duration of the click) in the captured output.
1 Optional
cropRectLeft Optional
cropRectBottom Optional
cropRectWidth Optional
cropRectHeight Optional


Returns OK or error.


Sets video input to screen.
cropRectLeft, cropRectBottom, cropRectWidth, cropRectHeight indicate the bounding rectangle of the screen area to be captured in pixels.
Screen input captures the entire area of the display with which it is associated. To limit the capture rectangle to a subsection of the screen, set the cropRect property, which defines a smaller section of the screen in the screen's coordinate system. The origin (0,0) is the bottom-left corner of the screen.

This function is not available for iOS as AVFoundation framework on iOS has no screen input class.

See also

Release notes

Blog Entries

This function checks for a license.

Created 17th July 2018, last changed 8th January 2019

AVRecorder.SetFilePath - AVRecorder.SetVideoDevice