View source for Documentation:Modules/marq

{{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.
}}

{{Option
|name=marq-refresh
|value=integer
|default=1000
|description=Number of milliseconds between string updates. This is mainly useful when using meta data or time format string sequences.
}}

== Avalabile Format Variables ==

* Time related: 
**%Y = year
**%m = month
**%d = day
**%H = hour
**%M = minute
**%S = second

*Meta data related:
**$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

== 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.

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

{{Stub}}

{{Documentation footer}}

[[Category:Video Filters]]