Difference between revisions of "Documentation:Modules/mosaic-bridge"

From VideoLAN Wiki
Jump to navigation Jump to search
m (Add options, add source code link)
m (Expand, copy-edit)
Line 1: Line 1:
{{Module|name=mosaic-bridge|type=Stream output|first_version=0.8.2|description=send a picture to the 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.
  
 
== Options ==
 
== Options ==
Line 8: Line 8:
 
|value=string
 
|value=string
 
|default="Id"
 
|default="Id"
|description=The picture's Id. Used by clients of the mosaic framework to identify the picture's source.
+
|description=Specify an identifier string for this subpicture. Used by clients of the mosaic framework to identify the picture's source.
 
}}
 
}}
 
{{Option
 
{{Option
Line 14: Line 14:
 
|value=integer
 
|value=integer
 
|default=0
 
|default=0
|description=Resize video to this width if value is non null. Make sure to use the '''mosaic-keep-picture''' option to prevent the mosaic filter from resizing a second time.
+
|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
Line 20: Line 20:
 
|value=integer
 
|value=integer
 
|default=0
 
|default=0
|description=Resize video to this height if value is non null. Make sure to use the '''mosaic-keep-picture''' option to prevent the mosaic filter from resizing a second time.
+
|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
Line 31: Line 31:
 
|name=sout-mosaic-bridge-chroma
 
|name=sout-mosaic-bridge-chroma
 
|value=string
 
|value=string
|default=""
+
|default="[[I420]]"
|description=Convert to the specified [[chroma]]. [[I420]] will be used if nothing is specified.
+
|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
Line 52: Line 52:
 
|value=integer
 
|value=integer
 
|default=-1
 
|default=-1
|description=X coordinate of the upper left corner in the mosaic if non negative.
+
|description=X coordinate of the upper left corner in the mosaic if non-negative.
 
}}
 
}}
 
{{Option
 
{{Option
Line 58: Line 58:
 
|value=integer
 
|value=integer
 
|default=-1
 
|default=-1
|description=Y coordinate of the upper left corner in the mosaic if non negative.
+
|description=Y coordinate of the upper left corner in the mosaic if non-negative.
 
}}
 
}}
  

Revision as of 06:58, 31 May 2019

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.

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

See also

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.