Difference between revisions of "Documentation:Modules/dummy"

From VideoLAN Wiki
Jump to navigation Jump to search
(Framework for page, +GPL)
(Expand)
Line 1: Line 1:
 
Dummy modules are the VLC equivalent of <code>/dev/null</code> on GNU/Linux: they represent doing nothing.
 
Dummy modules are the VLC equivalent of <code>/dev/null</code> on GNU/Linux: they represent doing nothing.
  
 +
== List ==
 
<!-- Editors: category wikicode must be entered manually. -->
 
<!-- Editors: category wikicode must be entered manually. -->
 
{| class="wikitable sortable cellpadding-3px"
 
{| class="wikitable sortable cellpadding-3px"
 
|+ Overview of dummy modules
 
|+ Overview of dummy modules
! scope="col" | Type !! scope="col" | Description
+
! scope="col" | Type !! scope="col" | Description !! scope="col" | Shortcut(s)
 
|-
 
|-
| Stream output [[Category:Stream output]] || dummy stream output
+
| Access [[Category:Accesses]] || Dummy input || dummy, vlc
 +
|-
 +
| Access output [[Category:Access output]] || Dummy stream output || dummy
 +
|-
 +
| Audio output [[Category:Audio output]] || Dummy audio output || dummy
 +
|-
 +
| Decoder [[Category:Codecs]] || Dummy decoder || dummy, dump
 +
|-
 +
| Encoder || Dummy encoder || dummy
 +
|-
 +
| Control interface [[Category:Interfaces]] [[Category:Control VLC]] || Dummy interface || (none)
 +
|-
 +
| Muxer [[Category:Muxers]] || Dummy/Raw muxer || dummy, raw, es
 +
|-
 +
| Stream output [[Category:Stream output]] || Dummy stream output || dummy, drop
 +
|-
 +
| Text renderer || Dummy font renderer || (none)
 +
|-
 +
| Video output [[Category:Video output]] || Dummy video output || dummy, stats
 +
|-
 +
| Video output (legacy video plugins) [[Category:Video output]] || Dummy window || dummy
 
|}
 
|}
  
 
== Types ==
 
== Types ==
 +
=== Dummy decoder ===
 +
{{Module|name=Dummy|type=Decoder|description=Dummy decoder|sc=dummy|sc2=dump}}
 +
{{Option
 +
|name=dummy-save-es
 +
|value=boolean
 +
|default=disabled
 +
|description=Save the raw codec data if you have selected/forced the dummy decoder in the main options.
 +
}}
 +
{{Clear}}
 +
 
=== Stream output ===
 
=== Stream output ===
 
Doesn't do anything. Can be used to test other stream output chain modules without actually streaming anything.
 
Doesn't do anything. Can be used to test other stream output chain modules without actually streaming anything.
 +
 +
=== Video output ===
 +
{{Module|name=Dummy|type=Video output|description=Dummy video output, Statistics video output sub-module|sc=dummy}}
 +
{{Option
 +
|name=dummy-chroma
 +
|value=string
 +
|default=NULL
 +
|description=Force the dummy video output to create images using a specific [[chroma]] format instead of trying to improve performances by using the most efficient one.
 +
}}
  
 
{{Stub}}
 
{{Stub}}
  
 
{{Documentation}}
 
{{Documentation}}

Revision as of 18:31, 29 May 2019

Dummy modules are the VLC equivalent of /dev/null on GNU/Linux: they represent doing nothing.

List

Overview of dummy modules
Type Description Shortcut(s)
Access Dummy input dummy, vlc
Access output Dummy stream output dummy
Audio output Dummy audio output dummy
Decoder Dummy decoder dummy, dump
Encoder Dummy encoder dummy
Control interface Dummy interface (none)
Muxer Dummy/Raw muxer dummy, raw, es
Stream output Dummy stream output dummy, drop
Text renderer Dummy font renderer (none)
Video output Dummy video output dummy, stats
Video output (legacy video plugins) Dummy window dummy

Types

Dummy decoder

Module: Dummy
Type Decoder
First VLC version -
Last VLC version -
Operating system(s) all
Description Dummy decoder
Shortcut(s) dummy, dump
  • dummy-save-es <boolean> : Save the raw codec data if you have selected/forced the dummy decoder in the main options. default value: disabled

Stream output

Doesn't do anything. Can be used to test other stream output chain modules without actually streaming anything.

Video output

Module: Dummy
Type Video output
First VLC version -
Last VLC version -
Operating system(s) all
Description Dummy video output, Statistics video output sub-module
Shortcut(s) dummy
  • dummy-chroma <string> : Force the dummy video output to create images using a specific chroma format instead of trying to improve performances by using the most efficient one. default value: NULL
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.