Documentation:Modules/marq - Revision history

Courmisch at 14:44, 10 May 2020

2020-05-10T14:44:09Z

@@ Line 79: / Line 79: @@
 Example command line use '''(VLC 2.0.0 and newer)''':
-  {{%}} vlc --sub-source="marq{marquee=test,color=0xFFFF00}" somevideo.avi
+  {{%}} vlc '--sub-source=marq{marquee="%Y-%m-%d,%H:%M:%S",position=9,color=0xFFFF00,size=12}' somevideo.avi
-This example displays yellow ''test'' text in the top left corner of video
+This example displays the current date and time in yellow in the top left corner of video.
 === Versions 0.9.0 to 1.1.13 ===
@@ Line 88: / Line 91: @@
   {{Prompt|cmd}} {{Path to VLC|windows}} --sub-filter=marq{marquee=$t ($P%%),color=0xFFFF00}:marq{marquee=%H:%m%s,position=6} somevideo.avi
 == Gallery ==

Courmisch at 14:41, 10 May 2020

2020-05-10T14:41:34Z

← Older revision		Revision as of 14:41, 10 May 2020
Line 1:		Line 1:
	{{Module\|name=marq\|type=Video sub-filter\|first_version=0.8.0\|description=Overlays text on the video\|sc=marq\|sc2=time}}		{{Module\|name=marq\|type=Video sub-filter\|first_version=0.8.0\|description=Overlays text on the video\|sc=marq\|sc2=time}}

	The marq ~~sub-~~filter can be used to display text on a video. The {{docmod\|time}} filter was merged with this filter in version 0.9.0, adding time [[Documentation:Format String\|format string]] recognition.		The ''marq'' subtitle filter can be used to display text on a video. The {{docmod\|time}} filter was merged with this filter in version 0.9.0, adding time [[Documentation:Format String\|format string]] recognition. There are two methods of specifying position: coordinate and (since VLC 0.9.0) [[#marq-position\|numbered positions]].

	There are two methods of specifying position: coordinate and [[#marq-position\|numbered positions]]. VLC 0.8.6d and prior only permitted well-formed coordinate pairs, falling back to numbered positions.<br />Since {{Commit\|34c0fe95c2e6fc7aade6a4950fd2b3c89c1220f3}} the marq module permits zero, one or two coordinates and zero or one numbered positions, allowing these methods to be intermixed. This means it is easier to e.g. provide a 100-pixel margin between a marquee and the bottom right corner.

	== Options ==		== Options ==
Line 77:		Line 75:

	== Examples ==		== Examples ==

			=== Versions 2.0 and later ===

	Example command line use '''(VLC 2.0.0 and newer)''':		Example command line use '''(VLC 2.0.0 and newer)''':
Line 82:		Line 82:
	This example displays yellow ''test'' text in the top left corner of video		This example displays yellow ''test'' text in the top left corner of video

	=== ~~VLC~~ 0.9.0 - 1.1.13 ===		=== Versions 0.9.0 to 1.1.13 ===
	{{$}} vlc --sub-filter 'marq{marquee=$t ($P%%),color=0xFFFF00}:marq{marquee=%H:%M:%S,position=6}' somevideo.avi		{{$}} vlc --sub-filter 'marq{marquee=$t ($P%%),color=0xFFFF00}:marq{marquee=%H:%M:%S,position=6}' somevideo.avi
	This command line will show the stream's title (<code>$t</code>) and current position (<code>$P</code>) in the upper left corner and the current time in the upper right corner. The <u>''single''</u> quotes <code>'</code> enclose our <code>$</code> characters to prevent them from being interpreted as Bash variables.<br />		This command line will show the stream's title (<code>$t</code>) and current position (<code>$P</code>) in the upper left corner and the current time in the upper right corner. The <u>''single''</u> quotes <code>'</code> enclose our <code>$</code> characters to prevent them from being interpreted as Bash variables.<br />
	On Windows the command line would be:		On Windows the command line would be:
	{{Prompt\|cmd}} {{Path to VLC\|windows}} --sub-filter=marq{marquee=$t ($P%%),color=0xFFFF00}:marq{marquee=%H:%m%s,position=6} somevideo.avi		{{Prompt\|cmd}} {{Path to VLC\|windows}} --sub-filter=marq{marquee=$t ($P%%),color=0xFFFF00}:marq{marquee=%H:%m%s,position=6} somevideo.avi

	~~=== 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=0x008000 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 ===		=== time ===

DoesItReallyMatter: Heavy copy-edit. Noted the [34c0fe95c2e6fc7aade6a4950fd2b3c89c1220f3] change allowing for relative offsets of numbered positions

2019-06-02T07:16:41Z

Heavy copy-edit. Noted the [34c0fe95c2e6fc7aade6a4950fd2b3c89c1220f3] change allowing for relative offsets of numbered positions

← Older revision		Revision as of 07:16, 2 June 2019
Line 1:		Line 1:
	{{Module\|name=marq\|type=Video sub-filter\|first_version=0.8.0\|description=Overlays text on the video\|sc=marq}}		{{Module\|name=marq\|type=Video sub-filter\|first_version=0.8.0\|description=Overlays text on the video\|sc=marq\|sc2=time}}

	The marq sub-filter can be used to display text on a video. The {{docmod\|time}} filter was merged with this filter in version 0.9.0.		The marq sub-filter can be used to display text on a video. The {{docmod\|time}} filter was merged with this filter in version 0.9.0, adding time [[Documentation:Format String\|format string]] recognition.

			There are two methods of specifying position: coordinate and [[#marq-position\|numbered positions]]. VLC 0.8.6d and prior only permitted well-formed coordinate pairs, falling back to numbered positions.<br />Since {{Commit\|34c0fe95c2e6fc7aade6a4950fd2b3c89c1220f3}} the marq module permits zero, one or two coordinates and zero or one numbered positions, allowing these methods to be intermixed. This means it is easier to e.g. provide a 100-pixel margin between a marquee and the bottom right corner.

	== Options ==		== Options ==
Line 8:		Line 10:
	\|value=string		\|value=string
	\|default=VLC		\|default=VLC
	\|description=Marquee text to display. ~~Since VLC version 0.9.0 you can use [[Documentation:Format String\|format strings]] to display time information~~		\|description=Marquee text to display.
	}}		}}
	{{Option		{{Option
	\|name=marq-file		\|name=marq-file
	\|value=string		\|value=string
	\|description=File to read the marquee text from		\|default=NULL
	}}		\|description=File to read the marquee text from.
			}}<noinclude>
			=== Position ===
			</noinclude>
	{{Option		{{Option
	\|name=marq-x		\|name=marq-x
	\|value=integer		\|value=integer
	\|default=0 ~~(0.8.6d and prior: -1)~~		\|default=0
	\|description=X offset from ~~upper~~ left ~~corner. (0.8~~.~~6d and prior: This is only if both marq-x and marq-y are positive)~~		\|description=X offset, from the left screen edge.
	}}		}}
	{{Option		{{Option
Line 25:		Line 30:
	\|value=integer		\|value=integer
	\|default=0		\|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)~~		\|description=Y offset, down from the top.
	}}		}}
	{{Option		{{Option
	\|name=marq-position		\|name=marq-position<span id="marq-position"></span>
	\|value=integer		\|value=integer
	\|default=-1 ~~(formerly 5)~~		\|default=-1
	\|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.
	}}		}}<noinclude>
	{{Option		=== Font ===
			</noinclude>{{Option
	\|name=marq-opacity		\|name=marq-opacity
	\|value=integer		\|value=integer
Line 39:		Line 45:
	\|max=255		\|max=255
	\|default=255		\|default=255
	\|description=~~Marquee opacity~~. 0 is transparent, 255 ~~is fully~~ opaque		\|description=Opacity (inverse of transparency) of overlaid text. 0 {{=}} transparent, 255 {{=}} totally opaque.
	}}		}}
	{{Option		{{Option
	\|name=marq-color<span id="marq-color"></span>		\|name=marq-color<span id="marq-color"></span>
	\|value=integer		\|value=integer
			\|select={ 0x000000, 0x808080, 0xC0C0C0, 0xFFFFFF, 0x800000, 0xFF0000, 0xFF00FF, 0xFFFF00, 0x808000, 0x008000, 0x008080, 0x00FF00, 0x800080, 0x000080, 0x0000FF, 0x00FFFF }
	\|default=0xFFFFFF		\|default=0xFFFFFF
	\|description=Color<sup>('''[[#appendix_marq-color\|key]]''')</sup> 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~~.		\|description=Color<noinclude><sup>('''[[#appendix_marq-color\|key]]''')</sup></noinclude> 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.
	}}		}}
	{{Option		{{Option
Line 52:		Line 59:
	\|min=0		\|min=0
	\|max=4096		\|max=4096
	\|default=0 ~~(formerly -1)~~		\|default=0
	\|description=Font size in pixels. 0 uses the default font size ~~(formerly represented by -1)~~		\|description=Font size, in pixels. 0 uses the default font size.
	}}		}}<noinclude>
	{{Option		=== Misc ===
			</noinclude>{{Option
	\|name=marq-timeout		\|name=marq-timeout
	\|value=integer		\|value=integer
	\|default=0		\|default=0
	\|description=Number of milliseconds the marquee must remain displayed. 0 means forever		\|description=Number of milliseconds the marquee must remain displayed. 0 means forever.
	}}		}}
	{{Option		{{Option
Line 65:		Line 73:
	\|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 [[Documentation:Format String\|format string]] sequences.
	}}</onlyinclude>		}}</onlyinclude>

Line 74:		Line 82:
	This example displays yellow ''test'' text in the top left corner of video		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 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=0xFFFF00}:marq{marquee=%H:%M:%S,position=6}' somevideo.avi
	This command line will show the stream's title (<code>$t</code>) and current position (<code>$P</code>) in the upper left corner and the current time in the upper right corner. The <u>''single''</u> quotes <code>'</code> enclose our <code>$</code> characters to prevent them from being interpreted as Bash variables.<br />		This command line will show the stream's title (<code>$t</code>) and current position (<code>$P</code>) in the upper left corner and the current time in the upper right corner. The <u>''single''</u> quotes <code>'</code> enclose our <code>$</code> characters to prevent them from being interpreted as Bash variables.<br />
	On ~~windows~~ the command line would be:		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		{{Prompt\|cmd}} {{Path to VLC\|windows}} --sub-filter=marq{marquee=$t ($P%%),color=0xFFFF00}:marq{marquee=%H:%m%s,position=6} somevideo.avi

	~~Example command line '''(All versions including~~ VLC 0.8.6d and prior~~)''':~~		=== 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		{{%}} vlc --sub-filter=marq --marq-marquee="Obvious Watermark" --marq-position=0 --marq-size=50 --marq-opacity=25 --marq-color=0x008000 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.		This command will show centered transparent green text. Text sized too large to fit the video window will not appear, and may crash VLC.

Line 88:		Line 96:

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

	'''marq equivalent:'''		'''marq equivalent:'''
Line 111:		Line 119:
	== Source code ==		== Source code ==
	* {{VLCSourceFile\|modules/spu/marq.c}}		* {{VLCSourceFile\|modules/spu/marq.c}}
			* {{VLCSourceFile\|p=vlc/vlc-0.8.git\|modules/video_filter/marq.c}}

	== Appendix ==		== Appendix ==

DoesItReallyMatter: Light copy-edit and correct unbalanced double quote

2019-06-02T05:58:53Z

Light copy-edit and correct unbalanced double quote

← Older revision		Revision as of 05:58, 2 June 2019
Line 8:		Line 8:
	\|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:Format String\|format strings]] to display time information
	}}		}}
	{{Option		{{Option
Line 71:		Line 71:

	Example command line use '''(VLC 2.0.0 and newer)''':		Example command line use '''(VLC 2.0.0 and newer)''':
	% ~~'''~~vlc --sub-source="marq{marquee=test,color=~~16776960~~} somevideo.avi~~'''~~		{{%}} vlc --sub-source="marq{marquee=test,color=0xFFFF00}" somevideo.avi
	:This example displays yellow ''test'' text in the top left corner of video		This example displays yellow ''test'' text in the top left corner of video

	Example command line use '''(VLC 0.9.0 - 1.1.13)''':		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 (<code>$t</code>) and current position (<code>$P</code>) in the upper left corner and the current time in the upper right corner. The <u>''single''</u> quotes <code>'</code> enclose our <code>$</code> characters to prevent them from being interpreted as Bash variables.		This command line will show the stream's title (<code>$t</code>) and current position (<code>$P</code>) in the upper left corner and the current time in the upper right corner. The <u>''single''</u> quotes <code>'</code> enclose our <code>$</code> characters to prevent them from being interpreted as Bash variables.<br />
	:On windows the command line would be:		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~~'''~~		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)''':		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~~'''~~		{{%}} 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.		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 ===		=== time ===
Line 91:		Line 91:

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

	'''marq equivalent (long form):'''		'''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		% vlc input_stream --sub-source=marq --marq-marquee="%Y-%m-%d,%H:%M:%S" --marq-position=9 --marq-color=0xFFFFFF --marq-size=12

	'''additional marq example:'''		'''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}'		% vlc input_stream '--sub-source=marq{marquee="%c (Week %V)",color=0xFF0000,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.		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.

Line 106:		Line 106:

	== See also ==		== See also ==
	* [[Documentation:~~Format_String~~]]		* [[Documentation:Format String]]
	* [[Documentation:Modules/rss]]		* [[Documentation:Modules/rss]]

DoesItReallyMatter: /* Examples */ Single quotes for Bash are simpler and safer

2019-06-02T05:43:30Z

Examples: Single quotes for Bash are simpler and safer

← Older revision		Revision as of 05:43, 2 June 2019
Line 75:		Line 75:

	Example command line use '''(VLC 0.9.0 - 1.1.13)''':		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'''
	% '''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 (<code>$t</code>) and current position (<code>$P</code>) in the upper left corner and the current time in the upper right corner. The <u>''single''</u> quotes <code>'</code> enclose our <code>$</code> characters to prevent them from being interpreted as Bash variables.
	: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:		: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'''		C:\Program Files\VideoLAN\VLC\>'''vlc.exe --sub-filter=marq{marquee=$t ($P%%),color=16776960}:marq{marquee=%H:%m%s,position=6} somevideo.avi'''

DoesItReallyMatter: Use Template:Colour mapping, misc.

2019-06-02T05:00:01Z

Use Template:Colour mapping, misc.

← Older revision		Revision as of 05:00, 2 June 2019
Line 42:		Line 42:
	}}		}}
	{{Option		{{Option
	\|name=marq-color		\|name=marq-color<span id="marq-color"></span>
	\|value=integer		\|value=integer
	\|default=~~-268435456 (formerly 16777215 (~~0xFFFFFF~~, white))~~		\|default=0xFFFFFF
	\|description=~~Marquee~~ color. Use the decimal value of the HTML color code		\|description=Color<sup>('''[[#appendix_marq-color\|key]]''')</sup> 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.
	}}		}}
	{{Option		{{Option
Line 113:		Line 113:
	* {{VLCSourceFile\|modules/spu/marq.c}}		* {{VLCSourceFile\|modules/spu/marq.c}}

	{{Documentation}}		== Appendix ==
			<div class="plainlist">
			*^ [[#marq-color\|--marq-color]]<span id="appendix_marq-color"></span>
			</div>
			{{Colour mapping}}

			{{Documentation footer}}

DoesItReallyMatter: /* Gallery */ New section with :File:Marq demonstration - VLC 3.0.6 Linux.png

2019-06-01T10:31:56Z

Gallery: New section with File:Marq demonstration - VLC 3.0.6 Linux.png

← Older revision		Revision as of 10:31, 1 June 2019
Line 100:		Line 100:
	% vlc input_stream '--sub-source=marq{marquee="%c (Week %V)",color=16711680,opacity=216,size=16,position=4,timeout=500,refresh=1000}'		% 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.		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 ==
			<gallery>
			File:Marq demonstration - VLC 3.0.6 Linux.png\|Marq can be chained, allowing several marquees to be displayed at the same time.\|alt=Marq can be chained, allowing several marquees to be displayed at the same time. Nine positions and text colours are shown against a black background.
			</gallery>

	== See also ==		== See also ==
Line 107:		Line 112:
	== Source code ==		== Source code ==
	* {{VLCSourceFile\|modules/spu/marq.c}}		* {{VLCSourceFile\|modules/spu/marq.c}}

	~~{{Image requested}}~~

	{{Documentation}}		{{Documentation}}

DoesItReallyMatter: +{{GPL}}, misc.

2019-05-23T05:19:21Z

+{{GPL}}, misc.

← Older revision		Revision as of 05:19, 23 May 2019
Line 1:		Line 1:
	{{Module\|name=marq\|type=Video ~~subfilter~~\|first_version=0.8.0\|description=Overlays text on the video}}		{{Module\|name=marq\|type=Video sub-filter\|first_version=0.8.0\|description=Overlays text on the video\|sc=marq}}

	The marq ~~subfilter~~ can be used to display text on a video. The ~~[[Documentation:Modules/time~~\|time]] filter was merged with this filter in version 0.9.0.		The marq sub-filter can be used to display text on a video. The {{docmod\|time}} filter was merged with this filter in version 0.9.0.

	== Options ==		== Options ==
Line 110:		Line 110:
	{{Image requested}}		{{Image requested}}

	{{Documentation ~~footer~~}}		{{Documentation}}

DoesItReallyMatter: Change Time to /* time */

2019-04-04T06:56:34Z

Change Time to time

← Older revision		Revision as of 06:56, 4 April 2019
Line 85:		Line 85:
	:This command will show centered transparent green text. Text sized too large to fit the video window will not appear, and may crash VLC.		: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~~ ===		=== time ===
	The {{docmod\|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:		The {{docmod\|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:

DoesItReallyMatter: Prepare for transclusion

2019-04-04T06:09:17Z

Prepare for transclusion

← Older revision		Revision as of 06:09, 4 April 2019
Line 4:		Line 4:

	== Options ==		== Options ==
			<onlyinclude>{{Option
	{{Option
	\|name=marq-marquee		\|name=marq-marquee
	\|value=string		\|value=string
Line 11:		Line 10:
	\|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		{{Option
	\|name=marq-file		\|name=marq-file
Line 17:		Line 15:
	\|description=File to read the marquee text from		\|description=File to read the marquee text from
	}}		}}

	{{Option		{{Option
	\|name=marq-x		\|name=marq-x
Line 24:		Line 21:
	\|description=X offset from upper left corner. (0.8.6d and prior: This is only if both marq-x and marq-y are positive)		\|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		{{Option
	\|name=marq-y		\|name=marq-y
Line 31:		Line 27:
	\|description=Y offset from upper left corner. (0.8.6d and prior: This is only if both marq-x and marq-y are positive)		\|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		{{Option
	\|name=marq-position		\|name=marq-position
Line 38:		Line 33:
	\|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)
	}}		}}

	{{Option		{{Option
	\|name=marq-opacity		\|name=marq-opacity
Line 47:		Line 41:
	\|description=Marquee opacity. 0 is transparent, 255 is fully opaque		\|description=Marquee opacity. 0 is transparent, 255 is fully opaque
	}}		}}

	{{Option		{{Option
	\|name=marq-color		\|name=marq-color
Line 54:		Line 47:
	\|description=Marquee color. Use the decimal value of the HTML color code		\|description=Marquee color. Use the decimal value of the HTML color code
	}}		}}

	{{Option		{{Option
	\|name=marq-size		\|name=marq-size
Line 63:		Line 55:
	\|description=Font size in pixels. 0 uses the default font size (formerly represented by -1)		\|description=Font size in pixels. 0 uses the default font size (formerly represented by -1)
	}}		}}

	{{Option		{{Option
	\|name=marq-timeout		\|name=marq-timeout
Line 70:		Line 61:
	\|description=Number of milliseconds the marquee must remain displayed. 0 means forever		\|description=Number of milliseconds the marquee must remain displayed. 0 means forever
	}}		}}

	{{Option		{{Option
	\|name=marq-refresh		\|name=marq-refresh
Line 76:		Line 66:
	\|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
	}}		}}</onlyinclude>

	== Examples ==		== Examples ==