Documentation:Modules/mosaic
Jump to navigation
Jump to search
Mosaic framework (How-To) |
Modules: mosaic (mosaic-bridge • bridge-in • bridge-out) • alphamask • bluescreen |
Module: mosaic | |
---|---|
Type | Video sub-filter |
First VLC version | 0.8.2 |
Last VLC version | - |
Operating system(s) | all |
Description | Mosaic video sub source |
Shortcut(s) | - |
Use this filter to blend videos on top of another video. This can be used to create TV channels mosaics, setup a weather channel-like stream (with the bluescreen video filter) and lots of other fun stuff.
Since VLC 0.8.6, you can also use the HTTP interface's mosaic wizard to configure a mosaic easily.
Contents
Options
- mosaic-alpha <integer [0 .. 255]> : Alpha blending (transparency) of the mosaic foreground pictures. 0 means transparent, 255 opaque. default value: 255
- mosaic-height <integer [0 .. INT_MAX]> : Total height of the mosaic, in pixels. default value: 100
- mosaic-width <integer [0 .. INT_MAX]> : Total width of the mosaic, in pixels. default value: 100
- mosaic-align <integer> { 0, 1, 2, 4, 8, 5, 6, 9, 10 } : You can enforce the mosaic alignment on the parent video. default value: 5
- mosaic-xoffset <integer [0 .. INT_MAX]> : X Coordinate of the top-left corner of the mosaic. default value: 0
- mosaic-yoffset <integer [0 .. INT_MAX]> : Y Coordinate of the top-left corner of the mosaic. default value: 0
- mosaic-borderw <integer [0 .. INT_MAX]> : Border width between mosaic elements, in pixels. default value: 0
- mosaic-borderh <integer [0 .. INT_MAX]> : Border height between mosaic elements, in pixels. default value: 0
- mosaic-position <integer> { 0, 1, 2 } : Positioning method of the mosaic elements. Use 0 to position the elements automatically on the grid, 1 to position the elements in fixed positions on the grid (see mosaic-order) and 2 to use grid-independent offsets (see mosaic-offsets). default value: 0
- mosaic-rows <integer [1 .. INT_MAX]> : Number of image rows in the mosaic (only used if positioning method is set to "fixed"). default value: 2
- mosaic-cols <integer [1 .. INT_MAX]> : Number of image columns in the mosaic (only used if positioning method is set to "fixed"). default value: 2
- mosaic-keep-aspect-ratio <boolean> : Keep the original aspect ratio when resizing mosaic elements. default value: disabled
- mosaic-keep-picture <boolean> : Do not resize or do any other transformation on the mosaic pictures. Should be enabled when using the mosaic-bridge's resizing options. default value: disabled
- mosaic-order <string> : You can enforce the order of the elements on the mosaic. You must give a comma-separated list of picture ID(s) (For example: tf1,fr2,fr3,m6). These IDs are assigned in the mosaic-bridge module. default value: ""
- mosaic-offsets <string> : You can enforce the
(x,y)
offsets of the elements on the mosaic (only used if positioning method is set to "offsets"). You must give a comma-separated list of coordinates. For example: 10,10,150,10 if you want to position the first picture at coordinates(10,10)
and the second one at coordinates(150,10)
. default value: "" - mosaic-delay <integer> : Pictures coming from the mosaic elements will be delayed according to this value (in milliseconds). For high values you will need to raise caching at input. default value: 0
Source code
Appendix
Integer | Alignment | Comment |
---|---|---|
0 | Center | |
1 | Left | |
2 | Right | |
4 | Top | |
8 | Bottom | |
5 | Top-Left | 4 + 1 |
6 | Top-Right | 4 + 2 |
9 | Bottom-Left | 8 + 1 |
10 | Bottom-Right | 8 + 2 |
3 | n/a | contradictory |
7 | n/a | contradictory |
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.