Documentation:Modules/screen

Module: screen
Type	Access
First VLC version	-
Last VLC version	-
Operating system(s)	all
Description	screen capture
Shortcut(s)	-

Stream or save a video of your computer screen.

Options

• screen-caching <integer> : Time in milliseconds

• screen-fps <integer> : Capture frames per second default value: 0

• screen-fragment-size <integer> : (Windows only) Optimize the capture by fragmenting the screen in chunks of predefined height (16 might be a good value, and 0 means disabled) default value: 0

• screen-top <integer> : The top edge coordinate of the subscreen default value: 0

• screen-left <integer> : The left edge coordinate of the subscreen default value: 0

• screen-width <integer> : The width of the subscreen default value: <full screen width>

• screen-height <integer> : The height of the subscreen default value: <full screen height>

• screen-follow-mouse, no-screen-follow-mouse : Follow the mouse when capturing a subscreen. default value: no-screen-follow-mouse

Run...

% vlc -H

...for the definitive options for your version.

Example

Capture a screen:

% vlc screen:// --screen-fps=1 --screen-width=100 --screen-height=100

The screen thus captured is 100x100 pixels in from the top left corner of the active screen.

This page is part of official VLC media player Documentation (User Guide • Streaming HowTo • Hacker Guide • Modules)
Please read the Documentation Editing Guidelines before you edit the documentation

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.