Difference between revisions of "Documentation:Modules/scene"

From VideoLAN Wiki
Jump to navigation Jump to search
m (More accurate default with INT_MAX)
m (nn)
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
 
'''Note:''' Before version 1.0.0, this used to be [[Documentation:Modules/image|image]].
 
'''Note:''' Before version 1.0.0, this used to be [[Documentation:Modules/image|image]].
  
 +
== Options ==
 
{{Option
 
{{Option
 
|name=scene-format
 
|name=scene-format
 
|value=string
 
|value=string
|description=Image format. Format of the output images (png, jpeg, ...)
+
|default=png
 +
|description=Image format. Format of the output images ([[png]], [[jpeg]], ...)
 
}}
 
}}
 
{{Option
 
{{Option
Line 23: Line 25:
 
|name=scene-prefix
 
|name=scene-prefix
 
|value=string
 
|value=string
|description=Filename prefix. Prefix of the output images filenames. Output filenames will have the "prefixNUMBER.format" form if replace is not true
+
|default=scene
 +
|description=Filename prefix. Prefix of the output images filenames. Output filenames will have the "prefixNUMBER.format" form if <var>scene-replace</var> is not true
 
}}
 
}}
 
{{Option
 
{{Option
 
|name=scene-path
 
|name=scene-path
 
|value=string
 
|value=string
 +
|default=NULL
 
|description=Directory path prefix. Directory path where images files should be saved. If not set, then images will be automatically saved in users homedir
 
|description=Directory path prefix. Directory path where images files should be saved. If not set, then images will be automatically saved in users homedir
 
}}
 
}}
Line 39: Line 43:
 
|name=scene-ratio
 
|name=scene-ratio
 
|value=integer
 
|value=integer
 +
|default=50
 
|min=1
 
|min=1
 
|max=<var>INT_MAX</var>
 
|max=<var>INT_MAX</var>
|description=Recording ratio. Ratio of images to record. 3 means that one image out of three is recorded.
+
|description=Recording ratio. Ratio of images to record. 3 means that one image out of three is recorded
 
}}
 
}}
  
{{Documentation footer}}
+
== Source code ==
 +
* {{VLCSourceFile|modules/video_filter/scene.c}}
 +
 
 +
{{Documentation}}

Latest revision as of 04:44, 5 April 2019

Module: scene
Type Video filter
First VLC version 1.0.0
Last VLC version -
Operating system(s) all
Description Send your video to picture files
Shortcut(s) -

Note: Before version 1.0.0, this used to be image.

Options

  • scene-format <string> : Image format. Format of the output images (png, jpeg, ...) default value: png
  • scene-width <integer> : Image width. You can enforce the image width. By default (-1) VLC will adapt to the video characteristics default value: -1
  • scene-height <integer> : Image height. You can enforce the image height. By default (-1) VLC will adapt to the video characteristics default value: -1
  • scene-prefix <string> : Filename prefix. Prefix of the output images filenames. Output filenames will have the "prefixNUMBER.format" form if scene-replace is not true default value: scene
  • scene-path <string> : Directory path prefix. Directory path where images files should be saved. If not set, then images will be automatically saved in users homedir default value: NULL
  • scene-replace <boolean> : Always write to the same file. 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
  • scene-ratio <integer [1 .. INT_MAX]> : Recording ratio. Ratio of images to record. 3 means that one image out of three is recorded default value: 50

Source code

This page is part of official VLC media player Documentation (User GuideStreaming HowToHacker GuideModules)
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.