Documentation:Modules/marq

Module: marq
Type	Video sub-filter
First VLC version	0.8.0
Last VLC version	-
Operating system(s)	all
Description	Overlays text on the video
Shortcut(s)	marq

The marq sub-filter can be used to display text on a video. The time filter was merged with this filter in version 0.9.0.

Options

• marq-marquee <string> : Marquee text to display. Since VLC version 0.9.0 you can use format strings to display time information default value: VLC
• marq-file <string> : File to read the marquee text from
• marq-x <integer> : X offset from upper left corner. (0.8.6d and prior: This is only if both marq-x and marq-y are positive) default value: 0 (0.8.6d and prior: -1)
• marq-y <integer> : Y offset from upper left corner. (0.8.6d and prior: This is only if both marq-x and marq-y are positive) default value: 0
• marq-position <integer> : 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) default value: -1 (formerly 5)
• marq-opacity <integer [0 .. 255]> : Marquee opacity. 0 is transparent, 255 is fully opaque default value: 255
• marq-color <integer> : Color^(key) of the text that will be rendered on the video. This must be an hexadecimal (like HTML colors). The first two chars are for red, then green, then blue. Use the decimal value of the HTML color code. default value: 0xFFFFFF
• marq-size <integer [0 .. 4096]> : Font size in pixels. 0 uses the default font size (formerly represented by -1) default value: 0 (formerly -1)
• marq-timeout <integer> : Number of milliseconds the marquee must remain displayed. 0 means forever default value: 0
• marq-refresh <integer> : Number of milliseconds between string updates. This is mainly useful when using meta data or time format string sequences default value: 1000

Examples

Example command line use (VLC 2.0.0 and newer):

% vlc --sub-source="marq{marquee=test,color=16776960} somevideo.avi

This example displays yellow test text in the top left corner of video

Example command line use (VLC 0.9.0 - 1.1.13):

% 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 0.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.

time

The time module has different command-lines than the marq module. This not-functional command snippet overlays a white 12-point time display in the lower left of an input stream or video:

time:

% vlc input_stream --sub-filter=time --time-format %Y-%m-%d,%H:%M:%S --time-position 9 --time-color 16777215 --time-size 12

marq equivalent:

% vlc input_stream '--sub-source=marq{marquee="%Y-%m-%d,%H:%M:%S",position=9,color=16777215,size=12}'

marq equivalent (long form):

% vlc input_stream --sub-source=marq --marq-marquee="%Y-%m-%d,%H:%M:%S" --marq-position=9 --marq-color=16777215 --marq-size=12

additional marq example:

% vlc input_stream '--sub-source=marq{marquee="%c (Week %V)",color=16711680,opacity=216,size=16,position=4,timeout=500,refresh=1000}'

This overlays a 25%-transparent flashing red 16-point locale-dependent time representation with week number at the top of the input stream or video.

Gallery

• 

  Marq can be chained, allowing several marquees to be displayed at the same time.

See also

• Documentation:Format_String
• Documentation:Modules/rss

Source code

• modules/spu/marq.c

Appendix

• ^ --marq-color

Colour key

Sample	Colour	Hex code
	Black	0x000000
	Gray	0x808080
	Silver	0xC0C0C0
	White	0xFFFFFF
	Maroon	0x800000
	Red	0xFF0000
	Fuchsia	0xFF00FF
	Yellow	0xFFFF00
	Olive	0x808000
	Green	0x008000
	Teal	0x008080
	Lime	0x00FF00
	Purple	0x800080
	Navy	0x000080
	Blue	0x0000FF
	Aqua	0x00FFFF

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.