Documentation:Modules/logo - Revision history

DoesItReallyMatter: Tweaks

2019-06-02T04:22:03Z

Tweaks

← Older revision		Revision as of 04:22, 2 June 2019
Line 66:		Line 66:

	== Appendix ==		== Appendix ==
	<~~span id~~="~~appendix_logo-position~~"~~></span~~>		<div class="plainlist">
	~~For option --~~[[#logo-position\|logo-position]]		*^ [[#logo-position\|--logo-position]]<span id="appendix_logo-position"></span>
			</div>
	{{Alignment mapping}}		{{Alignment mapping}}

	{{Documentation}}		{{Documentation footer}}

DoesItReallyMatter: +{{GPL}}, add {{Alignment mapping}}, factual, misc.

2019-05-23T05:15:15Z

+{{GPL}}, add {{Alignment mapping}}, factual, misc.

← Older revision		Revision as of 05:15, 23 May 2019
Line 1:		Line 1:
	{{See also\|Documentation:Modules/erase\|VLC HowTo/Add a logo}}		{{See also\|Documentation:Modules/erase\|VLC HowTo/Add a logo}}

	~~{{Module\|name=logo\|type=Video subfilter\|description=Overlays a logo on the video}}~~
	~~{{Module\|name=logo\|type=Video output filter\|description=Overlays a logo on the video}}~~

	The logo filter can be used to add a logo on the video. This logo can be a static image or series of images which will be displayed alternatively. When used as a video output filter, you can move the logo with the mouse.		The logo filter can be used to add a logo on the video. This logo can be a static image or series of images which will be displayed alternatively. When used as a video output filter, you can move the logo with the mouse.

	== ~~Options~~ ==		== Video sub-filter ==
			{{Module\|name=logo\|type=Video sub-filter\|description=Logo sub source\|sc=logo}}
	<onlyinclude>{{Option		<onlyinclude>{{Option
	\|name=logo-file		\|name=logo-file
	\|value=string		\|value=string
	\|description=Image to display. The full format is <code><nowiki><image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]</nowiki></code>}}		\|description=Image to display. The full format is <code><nowiki><image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]</nowiki></code>.
			}}
	{{Option		{{Option
	\|name=logo-x		\|name=logo-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 logo-x and logo-y are positive)~~		\|description=X offset from upper left corner.
	}}		}}
	{{Option		{{Option
Line 21:		Line 20:
	\|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 logo-x and logo-y are positive)~~		\|description=Y offset from upper left corner.
	}}		}}
	{{Option		{{Option
	\|name=logo-position		\|name=logo-position<span id="logo-position"></span>
	\|value=integer		\|value=integer
			\|select=[[#appendix_logo-position\|{ 0, 1, 2, 4, 8, 5, 6, 9, 10 }]]
	\|default=5		\|default=5
	\|description=Logo 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 logo-x or logo-y are negative)~~		\|description=Logo position.
	}}		}}
	{{Option		{{Option
Line 35:		Line 35:
	\|min=0		\|min=0
	\|max=255		\|max=255
	\|description=Logo opacity. 0 is transparent, 255 is fully opaque		\|description=Logo opacity. 0 is transparent, 255 is fully opaque.
	}}		}}
	{{Option		{{Option
Line 41:		Line 41:
	\|value=integer		\|value=integer
	\|default=1000		\|default=1000
	\|description=Global delay in ms. Sets the duration each image will be displayed for in a loop iteration unless specified otherwise in the <code>--logo-file</code> option		\|description=Global delay in [[wiktionary:ms#Translingual\|ms]]. Sets the duration each image will be displayed for in a loop iteration unless specified otherwise in the <code>--logo-file</code> option.
	}}		}}
	{{Option		{{Option
Line 47:		Line 47:
	\|value=integer		\|value=integer
	\|default=-1		\|default=-1
	\|description=Number of loops for the logo animation. -1 for continuous, 0 to disable		\|description=Number of loops for the logo animation. -1 for continuous, 0 to disable.
	}}</onlyinclude>		}}</onlyinclude>
			{{Clear}}

			== Video output filter ==
			{{Module\|name=logo\|type=Video output filter\|description=Logo video filter\|sc=logo}}
			{{Clear}}

	== Examples ==		== Examples ==
Line 60:		Line 65:
	* {{VLCSourceFile\|modules/spu/logo.c}}		* {{VLCSourceFile\|modules/spu/logo.c}}

	{{Documentation ~~footer~~}}		== Appendix ==
			<span id="appendix_logo-position"></span>
			For option --[[#logo-position\|logo-position]]
			{{Alignment mapping}}

			{{Documentation}}

DoesItReallyMatter: Remove {{Stub}}

2019-04-08T05:37:40Z

Remove {{Stub}}

← Older revision		Revision as of 05:37, 8 April 2019
Line 59:		Line 59:
	== Source code ==		== Source code ==
	* {{VLCSourceFile\|modules/spu/logo.c}}		* {{VLCSourceFile\|modules/spu/logo.c}}

	~~{{Stub}}~~

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

DoesItReallyMatter: Prepare for transclusion

2019-04-04T06:11:06Z

Prepare for transclusion

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

	== Options ==		== Options ==
			<onlyinclude>{{Option
	{{Option
	\|name=logo-file		\|name=logo-file
	\|value=string		\|value=string
Line 49:		Line 48:
	\|default=-1		\|default=-1
	\|description=Number of loops for the logo animation. -1 for continuous, 0 to disable		\|description=Number of loops for the logo animation. -1 for continuous, 0 to disable
	}}		}}</onlyinclude>

	== Examples ==		== Examples ==

DoesItReallyMatter: /* Examples */ "transparency=128" is incorrect; "opacity=128" is correct

2019-04-03T05:25:31Z

Examples: "transparency=128" is incorrect; "opacity=128" is correct

← Older revision		Revision as of 05:25, 3 April 2019
Line 52:		Line 52:

	== Examples ==		== Examples ==
	{{%}} '''vlc --video-filter "logo{file=cone.png,~~transparency~~=128}" somevideo.avi'''		{{%}} '''vlc --video-filter "logo{file=cone.png,opacity=128}" somevideo.avi'''
	: This command will display image cone.png in the video's upper right corner with 50% transparency.		: This command will display image cone.png in the video's upper right corner with 50% transparency.

DoesItReallyMatter: Misc.

2019-04-03T05:13:26Z

Misc.

← Older revision		Revision as of 05:13, 3 April 2019
Line 4:		Line 4:
	{{Module\|name=logo\|type=Video output filter\|description=Overlays a logo on the video}}		{{Module\|name=logo\|type=Video output filter\|description=Overlays a logo on the video}}

	The logo filter can be used to add a logo on the video. This logo can be a static image or series of ~~image~~ which will be displayed alternatively. When used as a video output filter, you can move the logo with the mouse.		The logo filter can be used to add a logo on the video. This logo can be a static image or series of images which will be displayed alternatively. When used as a video output filter, you can move the logo with the mouse.

	== Options ==		== Options ==
Line 11:		Line 11:
	\|name=logo-file		\|name=logo-file
	\|value=string		\|value=string
	\|description=Image to display. The full format is <image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]}}		\|description=Image to display. The full format is <code><nowiki><image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]</nowiki></code>}}
	{{Option		{{Option
	\|name=logo-x		\|name=logo-x
Line 34:		Line 34:
	\|value=integer		\|value=integer
	\|default=255		\|default=255
	\|description=Logo opacity. 0 is transparent, 255 is fully opaque.		\|min=0
			\|max=255
			\|description=Logo opacity. 0 is transparent, 255 is fully opaque
	}}		}}
	{{Option		{{Option
Line 40:		Line 42:
	\|value=integer		\|value=integer
	\|default=1000		\|default=1000
	\|description=Global delay in ms. Sets the duration each image will be displayed for in a loop iteration unless specified otherwise in the --logo-file option.		\|description=Global delay in ms. Sets the duration each image will be displayed for in a loop iteration unless specified otherwise in the <code>--logo-file</code> option
	}}		}}
	{{Option		{{Option
Line 46:		Line 48:
	\|value=integer		\|value=integer
	\|default=-1		\|default=-1
	\|description=Number of loops for the logo animation. -1 for continuous, 0 to disable.		\|description=Number of loops for the logo animation. -1 for continuous, 0 to disable
	}}		}}

DoesItReallyMatter: Remove line breaks between {{Option}} instances -- it is interpreted in the rendered HTML as separate lists of one item each

2019-04-03T05:03:33Z

Remove line breaks between {{Option}} instances -- it is interpreted in the rendered HTML as separate lists of one item each

← Older revision		Revision as of 05:03, 3 April 2019
Line 12:		Line 12:
	\|value=string		\|value=string
	\|description=Image to display. The full format is <image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]}}		\|description=Image to display. The full format is <image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]}}

	{{Option		{{Option
	\|name=logo-x		\|name=logo-x
Line 19:		Line 18:
	\|description=X offset from upper left corner. (0.8.6d and prior: This is only if both logo-x and logo-y are positive)		\|description=X offset from upper left corner. (0.8.6d and prior: This is only if both logo-x and logo-y are positive)
	}}		}}

	{{Option		{{Option
	\|name=logo-y		\|name=logo-y
Line 26:		Line 24:
	\|description=Y offset from upper left corner. (0.8.6d and prior: This is only if both logo-x and logo-y are positive)		\|description=Y offset from upper left corner. (0.8.6d and prior: This is only if both logo-x and logo-y are positive)
	}}		}}

	{{Option		{{Option
	\|name=logo-position		\|name=logo-position
Line 33:		Line 30:
	\|description=Logo 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 logo-x or logo-y are negative)		\|description=Logo 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 logo-x or logo-y are negative)
	}}		}}

	{{Option		{{Option
	\|name=logo-opacity		\|name=logo-opacity
Line 40:		Line 36:
	\|description=Logo opacity. 0 is transparent, 255 is fully opaque.		\|description=Logo opacity. 0 is transparent, 255 is fully opaque.
	}}		}}

	{{Option		{{Option
	\|name=logo-delay		\|name=logo-delay
Line 47:		Line 42:
	\|description=Global delay in ms. Sets the duration each image will be displayed for in a loop iteration unless specified otherwise in the --logo-file option.		\|description=Global delay in ms. Sets the duration each image will be displayed for in a loop iteration unless specified otherwise in the --logo-file option.
	}}		}}

	{{Option		{{Option
	\|name=logo-repeat		\|name=logo-repeat

DoesItReallyMatter: /* Examples */ I don't think anyone uses 0.8.6d anymore

2019-03-22T09:02:49Z

Examples: I don't think anyone uses 0.8.6d anymore

← Older revision		Revision as of 09:02, 22 March 2019
Line 56:		Line 56:

	== Examples ==		== Examples ==

	~~Example command line use '''(VLC 0.9.0 and above)''':~~
	{{%}} '''vlc --video-filter "logo{file=cone.png,transparency=128}" somevideo.avi'''		{{%}} '''vlc --video-filter "logo{file=cone.png,transparency=128}" somevideo.avi'''
	: This command will display image cone.png in the video's upper right corner with 50% transparency.		: This command will display image cone.png in the video's upper right corner with 50% transparency.
Line 63:		Line 61:
	{{%}} '''vlc --video-filter "logo{file='cone1.png,2000,128;cone2.png,3000'}" somevideo.avi'''		{{%}} '''vlc --video-filter "logo{file='cone1.png,2000,128;cone2.png,3000'}" somevideo.avi'''
	: This command will display image cone1.png for 2 seconds with 50% transparency followed by image cone2.png for 3 seconds at default transparency and loop.		: This command will display image cone1.png for 2 seconds with 50% transparency followed by image cone2.png for 3 seconds at default transparency and loop.

	~~Example command line '''(All versions including VLC 8.6d and prior)''':~~
	~~{{%}} '''vlc --sub-filter=logo --logo-file=cone.png --logo-transparency=128 somevideo.avi'''~~

	== Source code ==		== Source code ==

DoesItReallyMatter: Fix broken examples, new section /* Source code */

2019-03-22T09:01:13Z

Fix broken examples, new section Source code

← Older revision		Revision as of 09:01, 22 March 2019
Line 58:		Line 58:

	Example command line use '''(VLC 0.9.0 and above)''':		Example command line use '''(VLC 0.9.0 and above)''':
	{{%}} '''vlc --~~sub~~-filter "logo{file=cone.png,transparency=128}" somevideo.avi'''		{{%}} '''vlc --video-filter "logo{file=cone.png,transparency=128}" somevideo.avi'''
	: This command will display image cone.png in the video's upper right corner with 50% transparency.		: This command will display image cone.png in the video's upper right corner with 50% transparency.

	{{%}} '''vlc --~~sub~~-filter "logo{file='cone1.png,2000,128;cone2.png,3000'}" somevideo.avi'''		{{%}} '''vlc --video-filter "logo{file='cone1.png,2000,128;cone2.png,3000'}" somevideo.avi'''
	: This command will display image cone1.png for 2 seconds with 50% transparency followed by image cone2.png for 3 seconds at default transparency and loop.		: This command will display image cone1.png for 2 seconds with 50% transparency followed by image cone2.png for 3 seconds at default transparency and loop.

	Example command line '''(All versions including VLC 8.6d and prior)''':		Example command line '''(All versions including VLC 8.6d and prior)''':
	{{%}} '''vlc --sub-filter=logo --logo-file=cone.png --logo-transparency=128 somevideo.avi'''		{{%}} '''vlc --sub-filter=logo --logo-file=cone.png --logo-transparency=128 somevideo.avi'''

			== Source code ==
			* {{VLCSourceFile\|modules/spu/logo.c}}

	{{Stub}}		{{Stub}}

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

DoesItReallyMatter: Combine Template:See also instances

2019-03-14T03:26:28Z

Combine Template:See also instances

← Older revision		Revision as of 03:26, 14 March 2019
Line 1:		Line 1:
	{{See also\|Documentation:Modules/erase}}		{{See also\|Documentation:Modules/erase\|VLC HowTo/Add a logo}}
	~~{{See also~~\|VLC HowTo/Add a logo}}

	{{Module\|name=logo\|type=Video subfilter\|description=Overlays a logo on the video}}		{{Module\|name=logo\|type=Video subfilter\|description=Overlays a logo on the video}}

← Older revision		Revision as of 03:26, 14 March 2019
Line 1:		Line 1:
	{{See also\|Documentation:Modules/erase}}		{{See also\|Documentation:Modules/erase\|VLC HowTo/Add a logo}}
	~~{{See also~~\|VLC HowTo/Add a logo}}

	{{Module\|name=logo\|type=Video subfilter\|description=Overlays a logo on the video}}		{{Module\|name=logo\|type=Video subfilter\|description=Overlays a logo on the video}}