Documentation:Modules/marq
Jump to navigation
Jump to search
| Module: marq | |
|---|---|
| Type | Video sub-filter |
| First VLC version | - |
| Last VLC version | - |
| Operating system(s) | all |
| Description | Overlays text on the video |
| Shortcut(s) | - |
The marq subfilter can be used to display text on a video.
Options
- marq-marquee <string> : Marquee text to display. Since VLC version 0.9.0 you can use format strings to display meta data and time information default value: VLC
- 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: 5
- marq-opacity <integer> : Marquee opacity. 0 is transparent, 255 is fully opaque. default value: 255
- marq-color <integer> : Marquee color. Use the decimal value of the HTML color code. default value: 16777215 (0xFFFFFF, white)
- marq-size <integer> : Font size in pixels. -1 uses the default font size default value: -1
- marq-timeout <integer> : Number of millitseconds the marquee must remain displayed. 0 means forever. default value: 0
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.
