Documentation:Modules/image

From VideoLAN Wiki
Revision as of 03:56, 5 April 2019 by DoesItReallyMatter (talk | contribs) (Accuracy fixes, expand, format)
Jump to navigation Jump to search

Options

Video output

Module: image
Type Video output
First VLC version 0.8.2
Last VLC version 0.9.10
Operating system(s) all
Description Outputs the video images to files
Shortcut(s) -

In VLC 1.0.0 the image video output was rewritten into a video-filter named scene, and the old image video output was removed.

Trivia bit: the help text was inaccurate, claiming width and height options were … [b]y default (-1) …. The variables that inherited the command-line options, p_vout->p_sys->i_width and p_vout->p_sys->i_height, were unsigned integers and the value 0 was passed as the second argument in the call to add_integer.
Thus, --image-out-width and --image-out-height had defaults of 0, not -1.
The help-text probably wasn't updated, since this error was prior to the first public release. It has since been fixed.

Option aliases --image-width for --image-out-width and --image-height for --image-out-height were deprecated in 0.9.0.

  • image-out-format <string> {png,jpeg} : Format of the output images default value: png
  • image-out-width <integer> : You can enforce the image width. By default -1 VLC will adapt to the video characteristics default value: -1
  • image-out-height <integer> : You can enforce the image height. By default -1 VLC will adapt to the video characteristics default value: -1
  • image-out-ratio <integer> : Ratio of images to record. 3 means that one image out of three is recorded default value: 3
  • image-out-prefix <string> : Prefix of the output images filenames. Output filenames will have the "prefixNUMBER.format" form. Starting with VLC 0.9.0 you can also use format time and meta variables default value: img
  • image-out-replace <boolean> : Always write to the same file instead of creating one file per image. In this case, the number is not appended to the filename default value: disabled

Source code

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.