VideoLAN Wiki - User contributions [en]

Documentation:Modules/marq

2008-11-27T07:34:37Z

Brotheris: /* Examples */ Fix typos for minute and seconds

{{Module|name=marq|type=Video subfilter|description=Overlays text on the video}}

The marq subfilter can be used to display text on a video.

== Options ==

{{Option
|name=marq-marquee
|value=string
|default=VLC
|description=Marquee text to display. Since VLC version 0.9.0 you can use [[Documentation:Play_HowTo/Format_String|format strings]] to display meta data and time information}}

{{Option
|name=marq-x
|value=integer
|default=0 (0.8.6d and prior: -1)
|description=X offset from upper left corner. (0.8.6d and prior: This is only if both marq-x and marq-y are positive)
}}

{{Option
|name=marq-y
|value=integer
|default=0
|description=Y offset from upper left corner. (0.8.6d and prior: This is only if both marq-x and marq-y are positive)
}}

{{Option
|name=marq-position
|value=integer
|default=5
|description=Marquee position: 0=center, 1=left, 2=right, 4=top, 8=bottom, you can also use combinations of these values, eg 6 = top-right. (0.8.6d and prior: This is only used if marq-x or marq-y are negative)
}}

{{Option
|name=marq-opacity
|value=integer
|default=255
|description=Marquee opacity. 0 is transparent, 255 is fully opaque.
}}

{{Option
|name=marq-color
|value=integer
|default=16777215 (0xFFFFFF, white)
|description=Marquee color. Use the decimal value of the HTML color code.
}}

{{Option
|name=marq-size
|value=integer
|default=-1
|description=Font size in pixels. -1 uses the default font size
}}

{{Option
|name=marq-timeout
|value=integer
|default=0
|description=Number of millitseconds the marquee must remain displayed. 0 means forever.
}}

== Examples ==

Example command line use '''(VLC 0.9.0 and above)''':
% '''vlc --sub-filter "marq{marquee=\$t (\$P%%),color=16776960}:marq{marquee=%H:%M:%S,position=6}" somevideo.avi'''
% '''vlc --sub-filter 'marq{marquee=$t ($P%%),color=16776960}:marq{marquee=%H:%M:%S,position=6}' somevideo.avi'''
:This command line will show the stream's title ($t) and current position ($P) in the upper left corner and the current time in the upper right corner. Note that we have to escape $ characters when running this from command line in UNIX shells (this is why we use \$ instead of $). The second line uses single quotes to delimit the string so we don't need to escape the $ character.
:On windows the command line would be:
C:\Program Files\VideoLAN\VLC\>'''vlc.exe --sub-filter=marq{marquee=$t ($P%%),color=16776960}:marq{marquee=%H:%m%s,position=6} somevideo.avi'''

Example command line '''(All versions including VLC 8.6d and prior)''':
% '''vlc --sub-filter=marq --marq-marquee="Obvious Watermark" --marq-position=0 --marq-size=50 --marq-opacity=25 --marq-color=32768 somevideo.avi'''
:This command will show centered transparent green text. Text sized too large to fit the video window will not appear, and may crash VLC.

== See also ==
* [[Documentation:Modules/rss]]

{{Stub}}

{{Documentation}}

Documentation:Format String

2008-11-27T07:31:05Z

Brotheris: fix %s to %S, because %s is seconds from UNIX epoch

{{RightMenu|documentation play howto toc}}

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 [http://www.hmug.org/man/3/strftime.php man strftime].

==Meta==

Meta variables are VLC specific. The complete list is:
* $a : artist
* $b : album
* $c : copyright
* $d : description
* $e : encoded by
* $f : frame count
* $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 "--:--:--".

{{Documentation}}

Documentation:Format String

2008-11-27T07:29:14Z

Brotheris: Undo revision 12777 by Brotheris (Talk)

{{RightMenu|documentation play howto toc}}

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 [http://www.hmug.org/man/3/strftime.php man strftime].

==Meta==

Meta variables are VLC specific. The complete list is:
* $a : artist
* $b : album
* $c : copyright
* $d : description
* $e : encoded by
* $f : frame count
* $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 "--:--:--".

{{Documentation}}

Documentation:Format String

2008-11-27T07:28:14Z

Brotheris: