Difference between revisions of "Documentation:Modules/logo"
Jump to navigation
Jump to search
(→Examples: I don't think anyone uses 0.8.6d anymore) |
m (Remove line breaks between {{Option}} instances -- it is interpreted in the rendered HTML as separate lists of one item each) |
||
| 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 | ||
Revision as of 05:03, 3 April 2019
See also: Documentation:Modules/erase and VLC HowTo/Add a logo
| 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 image 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> : 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,transparency=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
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.
