AVCaptureScreenInputMBS.capturesCursor as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	AVFoundation	MBS AVFoundation Plugin	13.2	✅ Yes	❌ No	❌ No	❌ No	Desktop, Console & Web

A property indicating whether the cursor should be rendered to the captured output.

By default, AVCaptureScreenInput draws the cursor in its captured output. If this property is set to false, 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 AVCaptureScreenInput. See the inline documentation for kCMIOSampleBufferAttachmentKey_MouseAndKeyboardModifiers in <CoreMediaIO/CMIOSampleBuffer.h>

Available in Mac OS X 10.8 and newer.
(Read and Write computed property)

Some examples using this property:

• /AVFoundation/Screen Input

AVCaptureScreenInputMBS.capturesMouseClicks as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	AVFoundation	MBS AVFoundation Plugin	13.2	✅ Yes	❌ No	❌ No	❌ No	Desktop, Console & Web

Indicates whether mouse clicks should be highlighted in the captured output.

By default, AVCaptureScreenInput does not highlight mouse clicks in its captured output.

If you set this property is set to true, mouse clicks are highlighted (a circle is drawn around the mouse for the duration of the click) in the captured output.
(Read and Write computed property)

Some examples using this property:

• /AVFoundation/Screen Input

AVCaptureScreenInputMBS.Constructor(CGDisplay as Variant)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	AVFoundation	MBS AVFoundation Plugin	13.2	✅ Yes	❌ No	❌ No	❌ No	Desktop, Console & Web

Initializes a capture screen input that provides media data from a given display.

CGDisplay: The display from which to capture video. Must be CGDisplayMBS object.
Handle is non zero on success.

AVCaptureScreenInputMBS.cropRect as CGRectMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	AVFoundation	MBS AVFoundation Plugin	13.2	✅ Yes	❌ No	❌ No	❌ No	Desktop, Console & Web

Indicates the bounding rectangle of the screen area to be captured, in pixels.

By default, AVCaptureScreenInput captures the entire area of the displayID with which it is associated.

Set the value of this property to limit the capture rectangle to a subsection of the screen.

The rectangle should define a smaller section of the screen in the screen's coordinate system. The origin (0,0) is the bottom-left corner of the screen.
(Read and Write computed property)

Some examples using this property:

• /AVFoundation/Screen Input

AVCaptureScreenInputMBS.minFrameDuration as CMTimeMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	AVFoundation	MBS AVFoundation Plugin	13.2	✅ Yes	❌ No	❌ No	❌ No	Desktop, Console & Web

The screen input's minimum frame duration.

The minFrameDuration is the reciprocal of its maximum frame rate.

You use this property to request a maximum frame rate at which the input produces video frames. The requested rate may not be achievable due to overall bandwidth, so actual frame rates may be lower.
(Read and Write computed property)

AVCaptureScreenInputMBS.removesDuplicateFrames as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	AVFoundation	MBS AVFoundation Plugin	13.2	✅ Yes	❌ No	❌ No	❌ No	Desktop, Console & Web

A property indicating whether duplicate frames should be removed by the input.

By default, AVCaptureScreenInput performs frame differencing and when it detects duplicate frames, it drops them. If this property is set to false, the captured output receives all frames from the input.

Available in Mac OS X 10.8 and newer.
(Read and Write computed property)

Some examples using this property:

• /AVFoundation/Screen Input

AVCaptureScreenInputMBS.scaleFactor as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	AVFoundation	MBS AVFoundation Plugin	13.2	✅ Yes	❌ No	❌ No	❌ No	Desktop, Console & Web

Indicates the factor by which video buffers captured from the screen are to be scaled.

By default, AVCaptureScreenInput captures the video buffers from the display at a scale factor of 1.0 (no scaling). Set this property to scale the buffers by a given factor; for example a 320x240 capture area with a scaleFactor of 2.0 produces video buffers at 640x480.
(Read and Write computed property)