Difference between revisions of "Documentation:Modules/mosaic-bridge"
Jump to navigation
Jump to search
(New page: {{Module|name=mosaic-bridge|type=Stream output|first_version=0.8.2|description=send a picture to the mosaic framework}} Use this filter to send a picture to the mosaic framework. Processi...) |
m (__TOC__) |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Module|name=mosaic-bridge|type=Stream output|first_version=0.8.2|description= | + | {{Mosaic framework}} |
| + | {{Module|name=mosaic-bridge|type=Stream output|first_version=0.8.2|description=Send a picture to the mosaic framework|sc=mosaic-bridge}} | ||
| − | Use this filter to send a picture to the mosaic framework. Processing can be applied before sending the picture, such as resizing, chroma conversion and video filters. | + | Use this filter to send a picture to the mosaic framework. Processing can be applied before sending the picture, such as resizing, [[chroma]] conversion and video filters. |
| + | __TOC__ | ||
| + | {{Clear}} | ||
== Options == | == Options == | ||
| Line 8: | Line 11: | ||
|value=string | |value=string | ||
|default="Id" | |default="Id" | ||
| − | |description= | + | |description=Specify an identifier string for this subpicture. Used by clients of the mosaic framework to identify the picture's source. |
}} | }} | ||
| − | |||
{{Option | {{Option | ||
|name=sout-mosaic-bridge-width | |name=sout-mosaic-bridge-width | ||
|value=integer | |value=integer | ||
|default=0 | |default=0 | ||
| − | |description=Resize video to this width if value is non | + | |description=Resize video to this width if value is non-zero. Make sure to use the '''mosaic-keep-picture''' option to prevent the mosaic filter from resizing a second time. |
}} | }} | ||
| − | |||
{{Option | {{Option | ||
|name=sout-mosaic-bridge-height | |name=sout-mosaic-bridge-height | ||
|value=integer | |value=integer | ||
|default=0 | |default=0 | ||
| − | |description=Resize video to this height if value is non | + | |description=Resize video to this height if value is non-zero. Make sure to use the '''mosaic-keep-picture''' option to prevent the mosaic filter from resizing a second time. |
}} | }} | ||
| − | |||
{{Option | {{Option | ||
|name=sout-mosaic-bridge-sar | |name=sout-mosaic-bridge-sar | ||
|value=string | |value=string | ||
|default="1:1" | |default="1:1" | ||
| − | |description=Sample aspect ratio of the destination. | + | |description=Sample [[aspect ratio]] of the destination. |
}} | }} | ||
| − | |||
{{Option | {{Option | ||
|name=sout-mosaic-bridge-chroma | |name=sout-mosaic-bridge-chroma | ||
|value=string | |value=string | ||
| − | |default="" | + | |default="[[I420]]" |
| − | |description= | + | |description=Force the use of a specific [[chroma]]. Use [[YUVA]] if you're planning to use the {{docmod|alphamask}} or {{docmod|bluescreen}} video filter. |
}} | }} | ||
| − | |||
{{Option | {{Option | ||
|name=sout-mosaic-bridge-vfilter | |name=sout-mosaic-bridge-vfilter | ||
| Line 45: | Line 43: | ||
|description=Video filter chain to apply after resizing and chroma conversion. | |description=Video filter chain to apply after resizing and chroma conversion. | ||
}} | }} | ||
| + | {{Option | ||
| + | |name=sout-mosaic-bridge-alpha | ||
| + | |value=integer | ||
| + | |default=255 | ||
| + | |min=0 | ||
| + | |max=255 | ||
| + | |description=Transparency of the mosaic picture. | ||
| + | }} | ||
| + | {{Option | ||
| + | |name=sout-mosaic-bridge-x | ||
| + | |value=integer | ||
| + | |default=-1 | ||
| + | |description=X coordinate of the upper left corner in the mosaic if non-negative. | ||
| + | }} | ||
| + | {{Option | ||
| + | |name=sout-mosaic-bridge-y | ||
| + | |value=integer | ||
| + | |default=-1 | ||
| + | |description=Y coordinate of the upper left corner in the mosaic if non-negative. | ||
| + | }} | ||
| + | |||
| + | == Source code == | ||
| + | * {{VLCSourceFile|modules/stream_out/mosaic-bridge.c}} | ||
| − | + | {{Documentation footer}} | |
| − | |||
| − | |||
Latest revision as of 08:16, 31 May 2019
| Mosaic framework (How-To) |
| Modules: mosaic (mosaic-bridge • bridge-in • bridge-out) • alphamask • bluescreen |
| Module: mosaic-bridge | |
|---|---|
| Type | Stream output |
| First VLC version | 0.8.2 |
| Last VLC version | - |
| Operating system(s) | all |
| Description | Send a picture to the mosaic framework |
| Shortcut(s) | mosaic-bridge
|
Use this filter to send a picture to the mosaic framework. Processing can be applied before sending the picture, such as resizing, chroma conversion and video filters.
Contents
Options
- sout-mosaic-bridge-id <string> : Specify an identifier string for this subpicture. Used by clients of the mosaic framework to identify the picture's source. default value: "Id"
- sout-mosaic-bridge-width <integer> : Resize video to this width if value is non-zero. Make sure to use the mosaic-keep-picture option to prevent the mosaic filter from resizing a second time. default value: 0
- sout-mosaic-bridge-height <integer> : Resize video to this height if value is non-zero. Make sure to use the mosaic-keep-picture option to prevent the mosaic filter from resizing a second time. default value: 0
- sout-mosaic-bridge-sar <string> : Sample aspect ratio of the destination. default value: "1:1"
- sout-mosaic-bridge-chroma <string> : Force the use of a specific chroma. Use YUVA if you're planning to use the alphamask or bluescreen video filter. default value: "I420"
- sout-mosaic-bridge-vfilter <string> : Video filter chain to apply after resizing and chroma conversion. default value: ""
- sout-mosaic-bridge-alpha <integer [0 .. 255]> : Transparency of the mosaic picture. default value: 255
- sout-mosaic-bridge-x <integer> : X coordinate of the upper left corner in the mosaic if non-negative. default value: -1
- sout-mosaic-bridge-y <integer> : Y coordinate of the upper left corner in the mosaic if non-negative. default value: -1
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.
