Documentation:Format String

From VideoLAN Wiki
Revision as of 15:51, 30 January 2008 by Graven69 (talk | contribs) (→‎Time)
Jump to navigation Jump to search
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

Starting with VLC media player 0.9.0, format string variables can be used with the following options:

  • --marq-marquee
  • --snapshot-path (when specifying a full image path, not a directory)
  • --snapshot-prefix
  • --image-out-prefix
  • --msn-format (windows only)
  • file access output dst/url (like in std{access=file,mux=ts,dst=THIS})

There are two kinds of format string variables: time variables and meta variables.

Time

Time variables are those defined by the strftime C function. Those include:

  • %Y : year
  • %m : month
  • %d : day
  • %H : hour
  • %M : minute
  • %s : second

For an extensive list have a look at man strftime.

Meta

Meta variables are VLC specific. The complete list is:

  • $a : artist
  • $b : album
  • $c : copyright
  • $d : description
  • $e : encoded by
  • $g : genre
  • $l : language
  • $n : track num
  • $p : now playing
  • $r : rating
  • $s : subtitles language
  • $t : title
  • $u : url
  • $A : date
  • $B : audio bitrate (in kb/s)
  • $C : chapter
  • $D : duration
  • $F : full name with path
  • $I : title
  • $L : time left
  • $N : name
  • $O : audio language
  • $P : position (in %)
  • $R : rate
  • $S : audio sample rate (in kHz)
  • $T : time
  • $U : publisher
  • $V : volume
  • $_ : new line
  • $<any other char> : <any other char> (for example: $$ transforms to $)

You can insert a space between the $ sign and the character to tell it to not display anything if the meta data isn't available. For example: $ T instead will display "" if no time is available while $T would display "--:--:--".

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.