Difference between revisions of "Documentation:Snapshots"

From VideoLAN Wiki
Jump to navigation Jump to search
(→‎Snapshot location, format and name: The Linux / Unix code $(HOME) was incorrect and potentially dangerous, it would try to call a program with name HOME (however unlikely). Fixing/updating)
m (Tweaks, correction: "Snapshot" menu item should be "Take Snapshot")
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{RightMenu|Documentation TOC}}
 
{{RightMenu|Documentation TOC}}
 
There are two ways to take snapshots (i.e., screenshots or frame grabs) with VLC:
 
There are two ways to take snapshots (i.e., screenshots or frame grabs) with VLC:
#Open the ''Video'' menu, and select the ''Snapshot'' menu item.
+
#Open the ''Video'' menu, and select the ''Take Snapshot'' menu item.
 
#Press the snapshot hotkey
 
#Press the snapshot hotkey
#*Linux / Unix / Windows (Qt interface): <kbd>Shift+s</kbd>
+
#*Linux / Unix / Windows (Qt Interface): <kbd>Shift+s</kbd>
 
#*Mac OS X: <kbd>Command+Alt+s</kbd>
 
#*Mac OS X: <kbd>Command+Alt+s</kbd>
  
 
When a snapshot is taken, it will briefly preview as a thumbnail with its filename and then fade away.
 
When a snapshot is taken, it will briefly preview as a thumbnail with its filename and then fade away.
  
To change the hotkey, go to Tools → Preferences. If "Show settings" is set to Simple, click Hotkeys; if "Show settings" is set All, navigate to Interface → Hotkeys settings. Set the hotkey for Take video snapshot.
+
To change the hotkey, go to Tools → Preferences. If "Show settings" is set to Simple, click Hotkeys; if "Show settings" is set to All, navigate to Interface → Hotkeys settings. Set the hotkey for Take video snapshot.
  
 
==Snapshot location, format and name==
 
==Snapshot location, format and name==
Line 14: Line 14:
 
The snapshot location depends upon your operating system:
 
The snapshot location depends upon your operating system:
  
*Windows XP: My Documents\My Pictures\
+
*Windows XP: "%HOMEPATH%\My Pictures\"
*Windows Vista, 7, and 8: C:\Users\''Username''\Pictures\
+
*Windows Vista, 7, 8, and 10: "%HOMEPATH%\Pictures\"
 
*Linux / Unix: ~/Pictures
 
*Linux / Unix: ~/Pictures
*Mac OS X: Desktop/
+
*macOS: Desktop/
  
 
===Configuring snapshot options under Windows:===
 
===Configuring snapshot options under Windows:===
[[File:Basic snapshots config.png|550px|left|alt=]]
+
 
 +
[[File:Basic snapshots config.png|550px|left|alt=|Snapshots dialogue under Windows]]
 
{{Clear|left}}
 
{{Clear|left}}
 
The location, format and name of snapshots may be changed in the ''Preferences'' menu item in the ''Tools'' tab, subsection ''Video''.
 
The location, format and name of snapshots may be changed in the ''Preferences'' menu item in the ''Tools'' tab, subsection ''Video''.
  
The default format for snapshots is PNG, but this may be changed to JPEG.  Also, the default name for snapshots is ''vlcsnap-'' followed by a timestamp that is ''not'' the time of the frame in the video you're viewing, but rather the current date and time--as in 2014-01-16-14h57m19s163.
+
The default format for snapshots is [[PNG]], but this may be changed to [[JPEG]].  Also, the default name for snapshots is ''vlcsnap-'' followed by a timestamp that is ''not'' the time of the frame in the video you're viewing, but rather the current date and time&mdash;as in 2014-01-16-14h57m19s163.
  
 
Also, you may substitute other text for ''vlcsnap-'' in the ''Video snapshot file prefix'' and you may choose to have snapshots numbered sequentially (i.e., 000001, 000002, 000003, and so on) instead of with a timestamp.
 
Also, you may substitute other text for ''vlcsnap-'' in the ''Video snapshot file prefix'' and you may choose to have snapshots numbered sequentially (i.e., 000001, 000002, 000003, and so on) instead of with a timestamp.
  
As of version 0.9.0, you may even use [[Documentation:Play HowTo/Format String|variables]] in the text used for the filename.  For example, ''$T'' (must be upper case) will insert the video's time code into the file name.  If you were to change the prefix to ''Friends-$T-'' while watching a DVD of ''Friends'', then the snapshot filenames would look something like this: ''Friends-00_05_21-2014-01-16-14h57m19s163.png''.  This indicates a snapshot taken at 5 minutes and 21 seconds into the video; and it was taken on this day at this time: ''2014-01-16-14h57m19s163''.  
+
As of version 0.9.0, you may even use variables in the text used for the filename.  For example, ''$T'' (must be upper case) will insert the video's time code into the file name.  If you were to change the prefix to ''Friends-$T-'' while watching a DVD of ''Friends'', then the snapshot filenames would look something like this: ''Friends-00_05_21-2014-01-16-14h57m19s163.png''.  This indicates a snapshot taken at 5 minutes and 21 seconds into the video; and it was taken on this day at this time: ''2014-01-16-14h57m19s163''.  
  
 
For a shorter file name, check the "Sequential numbering" option in the configuration box (below). Instead of numbers like ''2014-01-16-14h57m19s163'', VLC will simply insert the count of snapshots for that session&mdash;for example, ''00004''. Thus, in the example above, a snapshot with sequential numbering would look like this: ''Friends-00_05_21-000001.png''
 
For a shorter file name, check the "Sequential numbering" option in the configuration box (below). Instead of numbers like ''2014-01-16-14h57m19s163'', VLC will simply insert the count of snapshots for that session&mdash;for example, ''00004''. Thus, in the example above, a snapshot with sequential numbering would look like this: ''Friends-00_05_21-000001.png''

Latest revision as of 06:24, 12 February 2019

VLC User Guide

Quick Start Guide
Installing VLC
History
Usage
Interface
Open Media
Audio
Video
Playback
Playlist
Subtitles
Video and Audio Filters
Snapshots
Hotkeys
Uninstalling VLC
Troubleshooting
Advanced usage
Using VLC inside a webpage
Command line
Alternative Interfaces
Misc

Appendix
Building Pages for the HTTP Interface
Format String
Building Lua Playlist Scripts
View this alone

There are two ways to take snapshots (i.e., screenshots or frame grabs) with VLC:

  1. Open the Video menu, and select the Take Snapshot menu item.
  2. Press the snapshot hotkey
    • Linux / Unix / Windows (Qt Interface): Shift+s
    • Mac OS X: Command+Alt+s

When a snapshot is taken, it will briefly preview as a thumbnail with its filename and then fade away.

To change the hotkey, go to Tools → Preferences. If "Show settings" is set to Simple, click Hotkeys; if "Show settings" is set to All, navigate to Interface → Hotkeys settings. Set the hotkey for Take video snapshot.

Snapshot location, format and name

The snapshot location depends upon your operating system:

  • Windows XP: "%HOMEPATH%\My Pictures\"
  • Windows Vista, 7, 8, and 10: "%HOMEPATH%\Pictures\"
  • Linux / Unix: ~/Pictures
  • macOS: Desktop/

Configuring snapshot options under Windows:

The location, format and name of snapshots may be changed in the Preferences menu item in the Tools tab, subsection Video.

The default format for snapshots is PNG, but this may be changed to JPEG. Also, the default name for snapshots is vlcsnap- followed by a timestamp that is not the time of the frame in the video you're viewing, but rather the current date and time—as in 2014-01-16-14h57m19s163.

Also, you may substitute other text for vlcsnap- in the Video snapshot file prefix and you may choose to have snapshots numbered sequentially (i.e., 000001, 000002, 000003, and so on) instead of with a timestamp.

As of version 0.9.0, you may even use variables in the text used for the filename. For example, $T (must be upper case) will insert the video's time code into the file name. If you were to change the prefix to Friends-$T- while watching a DVD of Friends, then the snapshot filenames would look something like this: Friends-00_05_21-2014-01-16-14h57m19s163.png. This indicates a snapshot taken at 5 minutes and 21 seconds into the video; and it was taken on this day at this time: 2014-01-16-14h57m19s163.

For a shorter file name, check the "Sequential numbering" option in the configuration box (below). Instead of numbers like 2014-01-16-14h57m19s163, VLC will simply insert the count of snapshots for that session—for example, 00004. Thus, in the example above, a snapshot with sequential numbering would look like this: Friends-00_05_21-000001.png

For a full list of variables, please see Documentation:Play HowTo/Format String.

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.