View source for Documentation:Modules/screen

{{Module|name=screen|type=Access|description=screen capture}}

Stream or save a video of your computer screen.

== Options ==
{{Option
|name=screen-caching
|value=integer
|description=Time in milliseconds
}}

{{Option
|name=screen-fps
|value=integer
|default=0
|description=Capture frames per second
}}

{{Option
|name=screen-fragment-size
|value=integer
|default=0
|description=(Windows only) Optimize the capture by fragmenting the screen in chunks of predefined height (16 might be a good value, and 0 means disabled)
}}

{{Option
|name=screen-top
|value=integer
|default=0
|description=The top edge coordinate of the subscreen. (New in VLC 0.9.0 on x11, New in VLC 1.0.0 on Windows)
}}

{{Option
|name=screen-left
|value=integer
|default=0
|description=The left edge coordinate of the subscreen. (New in VLC 0.9.0 on x11, New in VLC 1.0.0 on Windows)
}}

{{Option
|name=screen-width
|value=integer
|default=<full screen width>
|description=The width of the subscreen. (New in VLC 0.9.0 on x11, New in VLC 1.0.0 on Windows)
}}

{{Option
|name=screen-height
|value=integer
|default=<full screen height>
|description=The height of the subscreen. (New in VLC 0.9.0 on x11, New in VLC 1.0.0 on Windows)
}}
  
{{Option
|name=screen-follow-mouse, no-screen-follow-mouse
|default=no-screen-follow-mouse
|description=Follow the mouse when capturing a subscreen. (New in VLC 0.9.0 on x11, New in VLC 1.0.0 on Windows)
}}

{{Option
|name=screen-mouse-image
|value=filename
|default=""
|description=Mouse pointer image to use. If specified, the pointer will be overlayed on the captured video. (New in VLC 1.0.0, Windows and x11 only)
}}

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.

{{Stub}}

{{Documentation}}