View source for Documentation:Modules/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 image which will be displayed alternatively. When used as a video output filter, you can move the logo with the mouse.

== Options ==

{{Option
|name=logo-file
|value=string
|description=Image to display. The full format is <image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]}}

{{Option
|name=logo-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 logo-x and logo-y are positive)
}}

{{Option
|name=logo-y
|value=integer
|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)
}}

{{Option
|name=logo-position
|value=integer
|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)
}}

{{Option
|name=logo-opacity
|value=integer
|default=255
|description=Logo opacity. 0 is transparent, 255 is fully opaque.
}}

{{Option
|name=logo-delay
|value=integer
|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.
}}

{{Option
|name=logo-repeat
|value=integer
|default=-1
|description=Number of loops for the logo animation. -1 for continuous, 0 to disable.
}}

== Examples ==

Example command line use '''(VLC 0.9.0 and above)''':
 % '''vlc --sub-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.

 % '''vlc --sub-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.

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

See also [[How to add a logo]]

{{Stub}}

{{Documentation footer}}

[[Category:Video Filters]]