Difference between revisions of "Documentation:Modules/display"

From VideoLAN Wiki
Jump to navigation Jump to search
(New page: {{Module|name=display|type=Stream output|description=display a stream}} == Options == {{Option |name=sout-display-audio |default=enabled |description=Enable audio rendering }} {{Option |n...)
 
(Confirmed uncertain text that --sout-display-delay is in milliseconds, expand, copy-edit)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Module|name=display|type=Stream output|description=display a stream}}
+
{{Module|name=display|type=Stream output|description=Display stream output|sc=display}}
  
 
== Options ==
 
== Options ==
 
{{Option
 
{{Option
 
|name=sout-display-audio
 
|name=sout-display-audio
 +
|value=boolean
 
|default=enabled
 
|default=enabled
|description=Enable audio rendering
+
|description=Enable audio rendering.
 
}}
 
}}
 
{{Option
 
{{Option
 
|name=sout-display-video
 
|name=sout-display-video
 +
|value=boolean
 
|default=enabled
 
|default=enabled
|description=Enable video rendering
+
|description=Enable video rendering.
 
}}
 
}}
 
{{Option
 
{{Option
Line 16: Line 18:
 
|value=integer
 
|value=integer
 
|default=100
 
|default=100
|description=Introduces a delay in the stream (in ms?)
+
|description=Introduces a delay (ms) in the display of the stream.
 
}}
 
}}
  
== Example ==
+
== Examples ==
Transcode and stream a file while displaying it localy.
+
[[Transcode]] and stream a file while displaying it locally.<br />
 
This will display the transcoded version:
 
This will display the transcoded version:
 
  % '''vlc somevideo.avi --sout "#transcode{vcodec=mp2v,vb=2048,acodec=mpga,ab=96}:duplicate{dst=std{access=udp,mux=ts{ttl=12},url=239.255.1.1},dst=display}"'''
 
  % '''vlc somevideo.avi --sout "#transcode{vcodec=mp2v,vb=2048,acodec=mpga,ab=96}:duplicate{dst=std{access=udp,mux=ts{ttl=12},url=239.255.1.1},dst=display}"'''
 
This will display the original version:
 
This will display the original version:
 
  % '''vlc somevideo.avi --sout "#duplicate{dst='transcode{vcodec=mp2v,vb=2048,acodec=mpga,ab=96}:std{access=udp,mux=ts{ttl=12},url=239.255.1.1}',dst=display}"'''
 
  % '''vlc somevideo.avi --sout "#duplicate{dst='transcode{vcodec=mp2v,vb=2048,acodec=mpga,ab=96}:std{access=udp,mux=ts{ttl=12},url=239.255.1.1}',dst=display}"'''
 +
 +
== Source code ==
 +
* {{VLCSourceFile|modules/stream_out/display.c}}
  
 
== See also ==
 
== See also ==
 
* [[Documentation:Modules/duplicate]]
 
* [[Documentation:Modules/duplicate]]
  
{{Documentation}}
+
{{Documentation footer}}

Latest revision as of 06:05, 31 May 2019

Module: display
Type Stream output
First VLC version -
Last VLC version -
Operating system(s) all
Description Display stream output
Shortcut(s) display

Options

  • sout-display-audio <boolean> : Enable audio rendering. default value: enabled
  • sout-display-video <boolean> : Enable video rendering. default value: enabled
  • sout-display-delay <integer> : Introduces a delay (ms) in the display of the stream. default value: 100

Examples

Transcode and stream a file while displaying it locally.
This will display the transcoded version:

% vlc somevideo.avi --sout "#transcode{vcodec=mp2v,vb=2048,acodec=mpga,ab=96}:duplicate{dst=std{access=udp,mux=ts{ttl=12},url=239.255.1.1},dst=display}"

This will display the original version:

% vlc somevideo.avi --sout "#duplicate{dst='transcode{vcodec=mp2v,vb=2048,acodec=mpga,ab=96}:std{access=udp,mux=ts{ttl=12},url=239.255.1.1}',dst=display}"

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.