Difference between revisions of "Documentation:Modules/logo"

From VideoLAN Wiki
Jump to navigation Jump to search
(→‎Examples: "transparency=128" is incorrect; "opacity=128" is correct)
m (Prepare for transclusion)
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 ==

Revision as of 06:11, 4 April 2019

Module: logo
Type Video sub-filter
First VLC version -
Last VLC version -
Operating system(s) all
Description Overlays a logo on the video
Shortcut(s) -
Module: logo
Type Video output filter
First VLC version -
Last VLC version -
Operating system(s) all
Description Overlays a logo on the video
Shortcut(s) -

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

  • logo-file <string> : Image to display. The full format is <image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]
  • logo-x <integer> : X offset from upper left corner. (0.8.6d and prior: This is only if both logo-x and logo-y are positive) default value: 0 (0.8.6d and prior: -1)
  • logo-y <integer> : Y offset from upper left corner. (0.8.6d and prior: This is only if both logo-x and logo-y are positive) default value: 0
  • logo-position <integer> : 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) default value: 5
  • logo-opacity <integer [0 .. 255]> : Logo opacity. 0 is transparent, 255 is fully opaque default value: 255
  • logo-delay <integer> : 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 default value: 1000
  • logo-repeat <integer> : Number of loops for the logo animation. -1 for continuous, 0 to disable default value: -1

Examples

% 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.
% 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.

Source code

Help VideoLAN by adding to this page!
Create an account to start editing, and then click here to add to this article.
This page is part of official VLC media player Documentation (User GuideStreaming HowToHacker GuideModules)
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.