Topics
All
MacOS
(Only)
Windows
(Only)
Linux
(Only, Not)
iOS
(Only, Not)
Components
Crossplatform Mac & Win
Server
Client
Old
Deprecated
Guides
Examples
Videos
New in version:
9.5
10.0
10.1
10.2
10.3
10.4
10.5
11.0
11.1
11.2
Statistic
FMM
Blog
Sets video input to screen.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
AVRecorder | 8.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | ❌ No |
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.
Created 17th July 2018, last changed 8th January 2019
AVRecorder.SetFilePath - AVRecorder.SetVideoDevice
Feedback: Report problem or ask question.