Difference between revisions of "Template:Mux"

From VideoLAN Wiki
Jump to navigation Jump to search
m (Appearance: unknown names are not made bold, text changed from ?? to unknown)
(New feature: optional parameter "mod" allows linking to modules with different names than "id", used when "altid" would not make sense)
Line 5: Line 5:
 
Line 1: -->VLC can {{ #ifeq: {{{encoder|n}}} | y | '''encode''' and }} '''decode''' this [[container]]. {{{info|}}}<!--
 
Line 1: -->VLC can {{ #ifeq: {{{encoder|n}}} | y | '''encode''' and }} '''decode''' this [[container]]. {{{info|}}}<!--
 
Line 2: --><br />{{#if:{{{id|}}}<!--
 
Line 2: --><br />{{#if:{{{id|}}}<!--
                 -->|The [[module]] name to use at the [[command line]] is '''{{docmod|{{{id}}}}}'''<!--
+
                 -->|The [[module]] name to use at the [[command line]] is '''[[Documentation:Modules/{{{mod|{{{id}}}}}}|{{{id}}}]]'''<!--
 
                 -->{{#if:{{{altid|}}}<!--
 
                 -->{{#if:{{{altid|}}}<!--
 
                   -->|, but you can also use '''{{{altid}}}'''<!--
 
                   -->|, but you can also use '''{{{altid}}}'''<!--
Line 17: Line 17:
  
 
==Usage==
 
==Usage==
  <nowiki>{{mux|id= |encoder= |info= |altid= |altid2= }}</nowiki>
+
  <nowiki>{{mux|id= |encoder= |info= |altid= |altid2= |mod= }}</nowiki>
  
 
id is supposed to be what you'd put in the command line, like
 
id is supposed to be what you'd put in the command line, like
 
  --sout='#std{mux='''id''',url=....}'
 
  --sout='#std{mux='''id''',url=....}'
 
If there is more than one shortcut, use altid for the others.
 
If there is more than one shortcut, use altid for the others.
 +
 +
<code>mod</code> will link to a particular module while displaying the <code>id</code> given. Use this when <code>altid</code> would not make sense. For example, on the page [[MOV]] the code <code><nowiki>{{Mux|id=mov|mod=mp4}}</nowiki></code> will link to the ''mp4'' module while prominently displaying the shorcut ''mov'' in the box.
  
 
It will add it to [[:Category:Container]] (all containers) and  [[:Category:Container_Decoder]] (containers which can be decoded... which is all containers <span title="wink">;-)</span> If you think that's stupid, change it!
 
It will add it to [[:Category:Container]] (all containers) and  [[:Category:Container_Decoder]] (containers which can be decoded... which is all containers <span title="wink">;-)</span> If you think that's stupid, change it!

Revision as of 07:48, 25 March 2019

??
VLC can decode this container.
The module name to use at the command line is unknown.

Usage

{{mux|id= |encoder= |info= |altid= |altid2= |mod= }}

id is supposed to be what you'd put in the command line, like

--sout='#std{mux=id,url=....}'

If there is more than one shortcut, use altid for the others.

mod will link to a particular module while displaying the id given. Use this when altid would not make sense. For example, on the page MOV the code {{Mux|id=mov|mod=mp4}} will link to the mp4 module while prominently displaying the shorcut mov in the box.

It will add it to Category:Container (all containers) and Category:Container_Decoder (containers which can be decoded... which is all containers ;-) If you think that's stupid, change it!

If encoder is "y" then it also adds it to Category:Container_Encoder and changes the text a bit.

Info is for extra text in the box.

Examples

Example, avi

{{mux|id=avi|encoder=y}}

becomes

avi
VLC can encode and decode this container.
The module name to use at the command line is avi.


Example, asf

{{mux|id=asf|encoder=y|info=This works with mp2v, blah blah}}

becomes

asf
VLC can encode and decode this container. This works with mp2v, blah blah
The module name to use at the command line is asf.

Example, mp4

{{mux|id=mp4|encoder=y|altid=mov|altid2=3gp}}

becomes

mp4
VLC can encode and decode this container.
The module name to use at the command line is mp4, but you can also use mov, or 3gp.

See also