Difference between revisions of "Documentation:Modules/marq"
Jump to navigation
Jump to search
m (→Source code: New section) |
(Update/add options, misc.) |
||
| Line 9: | Line 9: | ||
|value=string | |value=string | ||
|default=VLC | |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 time information}} | + | |description=Marquee text to display. Since VLC version 0.9.0 you can use [[Documentation:Play_HowTo/Format_String|format strings]] to display time information |
| + | }} | ||
| + | |||
| + | {{Option | ||
| + | |name=marq-file | ||
| + | |value=string | ||
| + | |description=File to read the marquee text from | ||
| + | }} | ||
{{Option | {{Option | ||
| Line 28: | Line 35: | ||
|name=marq-position | |name=marq-position | ||
|value=integer | |value=integer | ||
| − | |default=5 | + | |default=-1 (formerly 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) | |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) | ||
}} | }} | ||
| Line 35: | Line 42: | ||
|name=marq-opacity | |name=marq-opacity | ||
|value=integer | |value=integer | ||
| + | |min=0 | ||
| + | |max=255 | ||
|default=255 | |default=255 | ||
| − | |description=Marquee opacity. 0 is transparent, 255 is fully opaque | + | |description=Marquee opacity. 0 is transparent, 255 is fully opaque |
}} | }} | ||
| Line 42: | Line 51: | ||
|name=marq-color | |name=marq-color | ||
|value=integer | |value=integer | ||
| − | |default=16777215 (0xFFFFFF, white) | + | |default=-268435456 (formerly 16777215 (0xFFFFFF, white)) |
| − | |description=Marquee color. Use the decimal value of the HTML color code | + | |description=Marquee color. Use the decimal value of the HTML color code |
}} | }} | ||
| Line 49: | Line 58: | ||
|name=marq-size | |name=marq-size | ||
|value=integer | |value=integer | ||
| − | |default=-1 | + | |min=0 |
| − | |description=Font size in pixels. | + | |max=4096 |
| + | |default=0 (formerly -1) | ||
| + | |description=Font size in pixels. 0 uses the default font size (formerly represented by -1) | ||
}} | }} | ||
| Line 57: | Line 68: | ||
|value=integer | |value=integer | ||
|default=0 | |default=0 | ||
| − | |description=Number of | + | |description=Number of milliseconds the marquee must remain displayed. 0 means forever |
}} | }} | ||
| Line 64: | Line 75: | ||
|value=integer | |value=integer | ||
|default=1000 | |default=1000 | ||
| − | |description=Number of milliseconds between string updates. This is mainly useful when using meta data or time format string sequences | + | |description=Number of milliseconds between string updates. This is mainly useful when using meta data or time format string sequences |
}} | }} | ||
Revision as of 09:07, 26 February 2019
| 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) | - |
The marq subfilter can be used to display text on a video. The time filter was merged with this filter in version 0.9.0.
Contents
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> : Marquee color. Use the decimal value of the HTML color code default value: -268435456 (formerly 16777215 (0xFFFFFF, white))
- 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.
See also
Source code
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
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.
