Difference between revisions of "Documentation:Advanced Use of VLC"

From VideoLAN Wiki
Jump to navigation Jump to search
 
(58 intermediate revisions by 23 users not shown)
Line 1: Line 1:
−
{{RightMenu|documentation play howto toc}}
+
{{RightMenu|Documentation TOC}}
  
−
==Use the command line==
+
== Use the command line ==
 +
'''TODO: completely outdated'''
 +
{{Outdated}}
  
−
'''TODO: completely outdated'''
+
All standard operations of VLC should be available from the GUI. However, some complex operations can only be done from the command line and there are situations in which you don't need or want a GUI. Here is the complete description of VLC's command line and how to use it.
  
−
All standard operations of VLC should be available from the GUI. However, some complex operations can only be done from the command line and there are situations in which you don't need or want a GUI. Here is the complete description of VLC's command line and how to use it.
+
You need to be quite comfortable with [[command line]] usage to use this.  
  
−
You need to be quite comfortable with command line usage to use this.
+
Note: Windows users have to use the ''--option-name="value"'' syntax instead of the ''--option-name value'' syntax.
  
−
Note: Windows users have to use the ''--option-name="value"'' syntax instead of the ''--option-name value'' syntax.
+
=== Getting help ===
 +
 
 +
VLC uses a modular structure. The core mainly manages communication between modules. All the multimedia processing is done by modules. There are input modules, [[demultiplex]]ers, decoders, video output modules, ...  
  
−
===Getting help===
+
This chapter will only describe the "general" options, i.e. the core options. Each module adds new options. For example, the HTTP input module will add options for caching, proxy, authentication, ...
  
−
VLC uses a modular structure. The core mainly manages communication between modules. All the multimedia processing is done by modules. There are input modules, demultiplexers, decoders, video output modules, ...
+
By using '''vlc --help''', you will get the basic core options. '''vlc --longhelp''' will give all the basic options (core + modules). Adding '''--advanced''' will give the "advanced options" (for advanced users). So '''vlc --longhelp --advanced''' will give you all options. You can also append '''--help-verbose''' if you want more detailed help.  
  
−
This chapter will only describe the "general" options, i.e. the core options. Each module adds new options. For example, the HTTP input module will add options for caching, proxy, authentication, ...
+
Also, you might want to get debug information. To do this, use '''-v''' or '''-vv''' (this will show lower severity messages). If your console supports it, you can add '''--color to get messages in color.'''
  
−
By using '''vlc --help''', you will get the basic core options. '''vlc --longhelp''' will give all the basic options (core + modules). Adding '''--advanced''' will give the "advanced options" (for advanced users). So '''vlc --longhelp --advanced''' will give you all options. You can also append '''--help-verbose''' if you want more detailed help.
+
=== Opening streams ===
  
−
Also, you might want to get debug informations. To do this, use '''-v''' or '''-vv''' (this will show lower severity messages). If your console supports it, you can add '''--color to get messages in color.
+
The following commands start VLC and start reading the given element(s):
  
−
===Opening streams===
+
==== Opening a file ====
  
−
The following commands start VLC and start reading the given element(s)
+
Start VLC with:
  
−
====Opening a file====
+
{{%}} '''vlc my_file'''
  
−
Start VLC with:
+
VLC should be able to recognize the file type. If it does not, you can force demultiplexer and decoder (see below).
  
−
% '''vlc my_file'''
+
A list of all video and audio codecs supported by VLC check the [https://www.videolan.org/vlc/features.html VLC features list].
  
−
VLC should be able to recognize the file type. If it does not, you can force demultiplexer and decoder (see below).
+
==== Opening a DVD or VCD, or an audio CD ====
  
−
A list of all video and audio codecs supported by VLC is available on the [http://www.videolan.org/vlc/features.html VLC features list].
+
Start VLC with:  
  
−
====Opening a DVD or VCD, or an audio CD====
+
For a DVD with menus:
  
−
Start VLC with:
+
{{%}} '''vlc dvd://[device][@raw_device][@[title][:[chapter][:angle]]]'''
  
−
For a DVD with menus:
+
In most cases, '''vlc dvd://''' or '''vlc dvd://[device]''' will do. [device] is for example '''/dev/dvd''' on GNU/Linux or '''D:''' on Windows (complete path to your DVD drive).
−
% '''vlc dvd://[device][@raw_device][@[title][:[chapter][:angle]]]'''
 
  
−
In most cases, '''vlc dvd://''' or '''vlc dvd://[device]''' will do. [device] is for example '''/dev/dvd''' on GNU/Linux or '''D:''' on Windows (complete path to your DVD drive).
+
or  
  
−
or
+
(DVD without menus):
  
−
(DVD without menus):
+
{{%}} '''vlc dvdsimple://[device][@raw_device][@[title][:[chapter][:angle]]]'''
  
−
% '''vlc dvdsimple://[device][@raw_device][@[title][:[chapter][:angle]]]'''
+
or
  
−
or
+
(VCD):
  
−
(VCD):
+
{{%}} '''vlc vcd://[device][@{E|P|E|T|S}[number]]'''
  
−
% '''vlc vcd://[device][@{E|P|E|T|S}[number]]'''
+
or
  
−
or
+
(Audio CD):
  
−
(Audio CD):
+
{{%}} '''vlc cdda://[device][@[track]]'''
  
−
% '''vlc cdda://[device][@[track]]'''
+
==== Receiving a network stream ====
  
−
====Receiving a network stream====
+
To receive an [[unicast]] [[RTP]]/[[UDP]] stream (sent by VLC's stream output), start VLC with:
  
−
To receive an unicast RTP/UDP stream (sent by VLC's stream output), start VLC with:
+
{{%}} '''vlc rtp://@:5004'''
  
−
% '''vlc rtp://@:5004'''
+
If 5004 is the [[port]] to which packets are sent. 1234 is another commonly used port number. you use the default port (1234), '''vlc rtp://''' will do. For more information, look at the Streaming Howto.
  
−
If 5004 is the port to which packets are sent. 1234 is another commonly used port number. you use the default port (1234), '''vlc rtp://''' will do.
+
To receive an multicast UDP/RTP stream (sent by VLC's stream output), start VLC with:  
−
For more information, look at the Streaming Howto.
 
  
−
To receive an multicast UDP/RTP stream (sent by VLC's stream output), start VLC with:
+
{{%}} '''vlc rtp://@multicast_address:port'''
  
−
% '''vlc rtp://@multicast_address:port'''
+
To receive a [[SSM]] (source specific multicast) stream, you can use:  
  
−
To receive a SSM (source specific multicast) stream, you can use:
+
{{%}} '''vlc rtp://server_address@multicast_address:port'''
  
−
% '''vlc rtp://server_address@multicast_address:port'''
+
This only works on [[Operating system]]s that support SSM (Windows XP and Linux).
  
−
This only works on OSs that support SSM (Windows XP and Linux).
+
To receive a HTTP stream, start VLC with:
  
−
To receive a HTTP stream, start VLC with:
+
{{%}} '''vlc <nowiki>http://www.example.org/your_file.mpg</nowiki>'''
  
−
% '''vlc http://www.example.org/your_file.mpg'''
+
To receive a [[RTSP]] stream, start VLC with:&lt;/para&gt;
  
−
To receive a RTSP stream, start VLC with:</para>
+
{{%}} '''vlc rtsp://www.example.org/your_stream'''
  
−
% '''vlc rtsp://www.example.org/your_stream'''
+
=== Modules selection ===
  
−
===Modules selection===
+
VLC always tries to select the most appropriate interface, input and output modules, among the ones available on the system, according to the stream it is given to read. However, you may wish to force the use of a specific module with the following options.
  
−
VLC always try to select the most appropriate interface, input and output modules, among the ones available on the system, according to the stream it is given to read. However, you may wish to force the use of a specific module with the following options.
+
*'''--intf &lt;module&gt;''' allows you to select the interface module.
 +
*'''--extraintf &lt;module&gt;''' allows you to select extra interface modules that will be launched in addition to the main one. This is mainly useful for special ''control'' interfaces, like HTTP, RC (Remote Control), ... (see below)
 +
*'''--aout &lt;module&gt;''' allows you to select the audio output module.
 +
*'''--vout &lt;module&gt;''' allows you to select the video output module.  
 +
*'''--memcpy &lt;module&gt;''' allows you to choose a memory copy module. You should probably never touch that.
  
−
*'''--intf  <module>''' allows you to select the interface module.
+
You can get a listing of the available modules by using '''vlc -l'''  
−
*'''--extraintf  <module>''' allows you to select extra interface modules that will be launched in addition to the main one. This is mainly useful for special ''control'' interfaces, like HTTP, RC (Remote Control), ... (see below)
 
−
*'''--aout  <module>''' allows you to select the audio output module.
 
−
*'''--vout  <module>''' allows you to select the video output module.
 
−
*'''--memcpy  <module>''' allows you to choose a memory copy module. You should probably never touch that.
 
  
−
You can get a listing of the available modules by using '''vlc -l'''
+
=== Stream Output ===
  
 +
The Stream output system allows vlc to become a streaming server.
  
−
===Stream Output===
+
For more details on the stream output system, please have a look at the [[Documentation:Streaming HowTo|Streaming HowTo]].
  
−
The Stream output system allows vlc to become a streaming server.
+
<br>
  
−
For more details on the stream output system, please have a look at the [[Documentation:Streaming HowTo|Streaming HowTo]].
+
=== Other Options ===
  
 +
==== Audio options ====
  
−
===Other Options===
+
*'''--noaudio''' disables audio output. Note that if you are streaming (ex: to a file) this has no effect (streaming copies the audio verbatim). Use --sout-xxx instead (ex: --no-sout-audio)
 +
*'''--mono''' forces VLC to treat the stream in mono audio.
 +
*'''--volume &lt;[[integer]]&gt;''' sets the level of audio output (between 0 and 1024). Also only applies to local playback (like --noaudio).
 +
*'''--aout-rate &lt;[[integer]]&gt;''' sets the audio output frequency (Hz). By default, VLC will try to autodetect this.
 +
*'''--desync &lt;[[integer]]&gt;''' compensates desynchronization of audio (ms). (If audio and video streams are not synchronized, use this setting to delay the audio stream)
 +
*'''--audio-filter &lt;[[string]]&gt;''' adds audio filters to the processing chain. Available filters are visual (visualizer with spectrum analyzer and oscilloscope), headphone (virtual headphone patialization) and normalizer (volume normalizer)
  
−
====Audio options====
+
==== Video options ====
  
−
*'''--noaudio''' disables audio output.
+
*'''--no-video''' disables video output.  
−
*'''--mono''' forces VLC to treat the stream in mono audio.
+
*'''--grayscale''' turns video output into grayscale mode.  
−
*'''--volume <integer>''' sets the level of audio output (between 0 and 1024).
+
*'''--fullscreen''' ( or '''-f''') sets fullscreen video.
−
*'''--aout-rate <integer>''' sets the audio output frequency (Hz). By default, VLC will try to autodetect this.
+
*'''--nooverlay''' disables [[hardware acceleration]] for the video output.  
−
*'''--desync <integer>''' compensates desynchronization of audio (ms). (If audio and video streams are not synchronized, use this setting to delay the audio stream)
+
*'''--width, --height &lt;[[integer]]&gt;''' sets the video window dimensions. By default, the video window size will be adjusted to match the video dimensions.  
−
*'''--audio-filter <string>''' adds audio filters to the processing chain. Available filters are visual (visualizer with spectrum analyzer and oscilloscope), headphone (virtual headphone  patialization) and normalizer (volume normalizer)
+
*'''--start-time &lt;[[integer]]&gt;''' starts the video here; the integer is the number of seconds from the beginning (e.g. 1:30 is written as 90)  
 +
*'''--stop-time &lt;[[integer]]&gt;''' stops the video here; the integer is the number of seconds from the beginning (e.g. 1:30 is written as 90)
 +
*'''--zoom &lt;[[float]]&gt;''' adds a zoom factor.
 +
*'''--aspect-ratio &lt;mode&gt;''' forces source aspect ratio. Modes are 4x3, 16x9, ...
 +
*'''--spumargin &lt;[[integer]]&gt;''' forces SPU subtitles position.
 +
*'''--video-filter &lt;[[string]]&gt;''' adds video filters to the processing chain. You can add several filters, separated by commas
 +
*'''--sub-filter &lt;[[string]]&gt;''' adds video subpictures filter to the processing chain.
  
−
====Video options====
+
==== Desktop/Screen grab options ====
  
−
*'''--novideo''' disables video output.
+
You can see the various options for "grabbing the desktop" (VLC's built-in screen grabber capture device) by using the GUI. See https://forum.videolan.org/viewtopic.php?f=4&amp;t=46971
−
*'''--grayscale''' turns video output into grayscale mode.
 
−
*'''--fullscreen''' ( or '''-f''') sets fullscreen video.
 
−
*'''--nooverlay''' disables hardware acceleration for the video output.
 
−
*'''--width, --height <integer>''' sets the video window dimensions. By default, the video window size will be adjusted to match the video dimensions.
 
−
*'''--zoom <float>''' adds a zoom factor.
 
−
*'''--aspect-ratio <mode>''' forces source aspect ratio. Modes are 4x3, 16x9, ...
 
−
*'''--spumargin  <integer>''' forces SPU subtitles postion.
 
−
*'''--filter <string>''' adds video filters to the processing chain. You can add several filters, separated by commas
 
−
*'''--sub-filter <string>''' adds video subpictures filter to the processing chain.
 
  
−
====Playlist options====
+
==== Playlist options ====
  
−
*'''--random''' plays files randomly forever.
+
*'''--random''' plays files randomly forever.  
−
*'''--loop''' loops playlist on end.
+
*'''--loop''' loops playlist on end.  
−
*'''--repeat''' repeats current item until another item is forced
+
*'''--repeat''' repeats current item until another item is forced  
 
*'''--play-and-stop''' stops the playlist after each played item.
 
*'''--play-and-stop''' stops the playlist after each played item.
  
−
====Network options====
+
==== Network options ====
  
−
*'''--server-port <integer>''' sets server port.
+
*'''--server-port &lt;[[integer]]&gt;''' sets server port.  
−
*'''--iface <string>''' specifies the network interface to use.
+
*'''--iface &lt;[[string]]&gt;''' specifies the network interface to use.  
−
*'''--iface-addr <string>''' specifies your network interface IP address.
+
*'''--iface-addr &lt;[[string]]&gt;''' specifies your network interface IP address.  
−
*'''--mtu <integer>''' specifies the MTU of the network interface.
+
*'''--mtu &lt;[[integer]]&gt;''' specifies the MTU of the network interface.  
−
*'''--ipv6''' forces IPv6.
+
*'''--ipv6''' forces IPv6.  
 
*'''--ipv4''' forces IPv4.
 
*'''--ipv4''' forces IPv4.
  
−
====CPU options====
+
==== CPU options ====
  
−
You should probably not touch these options unless you know what you are doing.
+
You should probably not touch these options unless you know what you are doing.  
  
−
*'''--nommx''' disables the use of MMX CPU extensions.
+
*'''--nommx''' disables the use of MMX CPU extensions.  
−
*'''--no3dn''' disables the use of 3D Now! CPU extensions.
+
*'''--no3dn''' disables the use of 3D Now! CPU extensions.  
−
*'''--nommxext''' disables the use of MMX Ext CPU extensions.
+
*'''--nommxext''' disables the use of MMX Ext CPU extensions.  
−
*'''--nosse''' disables the use of SSE CPU extensions.
+
*'''--nosse''' disables the use of SSE CPU extensions.  
 
*'''--noaltivec''' disables the use of Altivec CPU extensions.
 
*'''--noaltivec''' disables the use of Altivec CPU extensions.
  
−
====Miscellaneous options====
+
==== Miscellaneous options ====
  
−
*'''--quiet''' deactivates all console messages.
+
*'''--quiet''' deactivates all console messages.  
−
*'''--color''' displays color messages.
+
*'''--color''' displays color messages.  
−
*'''--search-path <string>''' specifies interface default search path.
+
*'''--search-path &lt;[[string]]&gt;''' specifies interface default search path.  
−
*'''--plugin-path <string>''' specifies plugin search path.
+
*'''--plugin-path &lt;[[string]]&gt;''' specifies plugin search path.  
−
*'''--no-plugins-cache''' disables the plugin cache (plugins cache speeds up startup)
+
*'''--no-plugins-cache''' disables the plugin cache (plugins cache speeds up startup)  
−
*'''--dvd <string>''' specifies the default DVD device.
+
*'''--dvd &lt;[[string]]&gt;''' specifies the default DVD device.  
−
*'''--vcd <string>''' specifies the default VCD device.
+
*'''--vcd &lt;[[string]]&gt;''' specifies the default VCD device.  
−
*'''--program <integer>''' specifies program (SID) (for streams with several programs, like satellite ones).
+
*'''--program &lt;[[integer]]&gt;''' specifies program (SID) (for streams with several programs, like satellite ones).  
−
*'''--audio-type <integer>''' specifies the default audio type to use with dvds.
+
*'''--audio-type &lt;[[integer]]&gt;''' specifies the default audio type to use with dvds.  
−
*'''--audio-channel <integer>''' specifies the default audio channel to use with dvds.
+
*'''--audio-channel &lt;[[integer]]&gt;''' specifies the default audio channel to use with dvds.  
−
*'''--spu-channel <integer>''' specifies the default subtitle channel to use with dvds.
+
*'''--spu-channel &lt;[[integer]]&gt;''' specifies the default subtitle channel to use with dvds.  
−
*'''--version''' gives you information about the current VLC version.
+
*'''--version''' gives you information about the current VLC version.  
−
*'''--module <module> ''' displays help about specified module. (Shortcut: '''-p''')
+
*'''--module &lt;module&gt; ''' displays help about specified module. (Shortcut: '''-p''')
  
−
===Item-specific options===
+
=== Item-specific options ===
  
−
There are many options that are related to items (like '''--novideo''', '''--codec''', '''--fullscreen''').
+
There are many options that are related to items (like '''--novideo''', '''--codec''', '''--fullscreen''').  
  
−
For all of these, you have the possibility to make them item-specific, using ":" instead of "--" and putting the option just after the concerned item.
+
For all of these, you have the possibility to make them item-specific, using ":" instead of "--" and putting the option just after the concerned item.  
  
−
Examples:
+
Examples:  
  
−
  % '''vlc file1.mpg :fullscreen file2.mpg'''
+
  {{%}} '''vlc file1.mpg&nbsp;:fullscreen file2.mpg'''
−
will play file1.mpg in fullscreen mode and file2.mpg in the default mode (which is generally no fullscreen), whereas
 
−
% '''vlc --fullscreen file1.mpg file2.mpg'''
 
−
will play both files in fullscreen mode
 
  
−
% '''vlc --fullscreen file1.mpg :sub-file=file1.srt :no-fullscreen file2.mpg :filter=distort'''
+
will play file1.mpg in fullscreen mode and file2.mpg in the default mode (which is generally no fullscreen), whereas
−
will play file1.mpg in windowed (no-fullscreen) mode with the subtitles file file1.srt and will play file2.mpg with video filter distort enabled in fullscreen mode (item-specific options override global options)
 
  
−
==Advanced use of filters==
+
{{%}} '''vlc --fullscreen file1.mpg file2.mpg'''
  
−
===Filters===
+
will play both files in fullscreen mode
  
−
These are the old style VLC filters. They only apply to on screen display and thus cannot be streamed.
+
{{%}} '''vlc --fullscreen file1.mpg&nbsp;:sub-file=file1.srt&nbsp;:no-fullscreen file2.mpg&nbsp;:filter=distort'''
  
−
====Deinterlacing video filter====
+
will play file1.mpg in windowed (no-fullscreen) mode with the subtitles file file1.srt and will play file2.mpg with video filter distort enabled in fullscreen mode (item-specific options override global options).
  
−
Module name: '''deinterlace'''
+
== Advanced use of filters ==
  
−
*'''--deinterlace-mode {discard,blend,mean,bob,linear}''' choose a deinterlacing mode.
+
=== Filters ===
  
−
====Invert video filter====
+
These are the old style VLC filters. They only apply to on screen display and thus cannot be streamed. However, on version 1.1.11 you are still able to apply these filters in ''transcode'' module using parameter ''vfilter''. More information can be found on [[Documentation:Streaming HowTo/Advanced Streaming Using the Command Line#vfilter]].
  
−
Module name: '''invert'''
+
==== Deinterlacing video filter ====
  
−
====Image properties filter====
+
Module name: '''deinterlace'''
  
−
Module name: '''adjust'''
+
*'''--deinterlace-mode {discard,blend,mean,bob,linear,x,yadif,yadif (2x),phosophor,ivtc}''' choose a [[deinterlacing]] mode.
  
−
*'''--contrast <float>''' Image contrast in the 0-2 range.
+
==== Invert video filter ====
−
*'''--brightness <float>''' Image brightness in the 0-2 range.
 
−
*'''--hue <integer>''' Image hue in the 0-360 range.
 
−
*'''--saturation <float>''' Image saturation in the 0-3 range.
 
−
*'''-gamma <float>''' Image gamma in the 0-10 range.
 
  
−
====Wall video filter====
+
Module name: '''invert'''
  
−
Module name: '''wall'''
+
==== Image properties filter ====
  
−
This filter splits the output in several windows.
+
Module name: '''adjust'''
 +
{{Transcluded|Documentation:Modules/adjust}}
 +
{{:Documentation:Modules/adjust}}
  
−
*'''--wall-cols <integer>''' Number of columns.
+
==== Wall video filter ====
−
*'''--wall-rows <integer>''' Number of rows.
 
−
*'''--wall-active <string>''' Select the windows you want to display. To select windows 2 and 4 you would write '''--wall-active 2,4'''. When this option isn't specified, all windows are displayed.
 
  
−
====Video transformation filter====
+
Module name: '''wall'''
 +
This filter splits the output in several windows.
 +
{{Transcluded|Documentation:Modules/wall}}
 +
{{:Documentation:Modules/wall}}
  
−
Module name: '''transform'''
+
==== Video transformation filter ====
  
−
*'''--transform-type {90,180,270,hflip,vflip}''' Select rotation angle or symmetry.
+
Module name: '''transform'''  
 +
{{Transcluded|Documentation:Modules/transform}}
 +
{{:Documentation:Modules/transform}}
  
−
====Distort video filter====
+
==== Distort video filter ====
  
−
Module name: '''distort'''
+
Module name: '''distort'''  
 +
{{See|Documentation:Modules/distort}}
  
−
====Clone video filter====
+
==== Clone video filter ====
  
−
This filter clones the output window.
+
This filter clones the output window.  
  
−
Module name: '''clone'''
+
Module name: '''clone'''  
 +
{{Transcluded|Documentation:Modules/clone}}
 +
{{:Documentation:Modules/clone}}
  
−
*'''--clone-count <integer>''' Number of clones.
+
==== Croppadd video filter ====
−
*'''--clone-vout-list <string>''' Comma separated string of video output modules.
 
  
−
====Crop video filter====
+
Module name: '''croppadd'''
 +
{{Transcluded|Documentation:Modules/croppadd}}
 +
{{:Documentation:Modules/croppadd}}
  
−
Module name: '''crop'''
+
==== Motion blur filter ====
  
−
*'''--crop-geometry <string>''' Set the geometry of the zone to crop. This is set as <width> x <height> + <left offset> + <top offset>.
+
Module name: '''motionblur'''  
−
*'''--autocrop''' Enable automatic black border cropping.
+
{{Transcluded|Documentation:Modules/motionblur}}
 +
{{:Documentation:Modules/motionblur}}
  
−
====Motion blur filter====
+
==== Video pictures blending ====
  
−
Module name: '''motionblur'''
+
Module name: '''blend'''  
  
−
*'''blur-factor <integer>''' Blur factor in the 1-127 range.
+
==== Video scaling filter ====
  
−
====Video pictures blending====
+
Module name: '''scale'''
  
−
Module name: '''blend'''
+
<br>
  
−
====Video scaling filter====
+
=== Subpictures Filters ===
  
−
Module name: '''scale'''
+
These are the new VLC filters. They can be streamed.
  
 +
==== Marquee display sub filter ====
  
−
===Subpictures Filters===
+
Module name: '''marq'''
 +
{{Transcluded|Documentation:Modules/marq}}
 +
{{:Documentation:Modules/marq}}
  
−
These are the new VLC filters. They can be streamed.
+
==== Logo video filter ====
  
−
====Time display sub filter====
+
Module name: '''logo'''
 +
{{Transcluded|Documentation:Modules/logo}}
 +
{{:Documentation:Modules/logo}}
  
−
Module name: '''time'''
+
This filter can be used both as an old style filter or a subpictures filter.
  
−
*'''--time-format <string>''' Time format string. You can use the following special characters %Y = year, %m = month, %d = day, %H = hour, %M = minute, %S = second.
+
Note: You can move the logo by left-clicking on it.  
−
*'''--time-x <integer>''' X offset from the left in pixels.
 
−
*'''--time-y <integer>''' Y offset from the top in pixels.
 
  
−
====Marquee display sub filter====
+
<br>
  
−
Module name: '''marq'''
+
== The HTTP interface ==
  
−
*'''--marq-marquee <string>''' Marquee text to display.
+
VLC ships with a little [[HTTP interface|HTTP server integrated]]. It is used both to stream using [[HTTP]], and for the HTTP remote control interface.  
−
*'''--marq-x <integer>''' X offset from the left in pixels.
 
−
*'''--marq-y <integer>''' Y offset from the top in pixels.
 
−
*'''--marq-timeout <timeout>''' Defines the time the marquee must remain displayed in milliseconds. Default value is 0 (remain forever).
 
  
−
====Logo video filter====
+
To start VLC with the HTTP interface, use:
  
−
Module name: '''logo'''
+
{{%}} '''vlc -I http [--http-src /directory/] [--http-host host:port]'''
  
−
This filter can be used both as an old style filter or a subpictures filter.
+
If you want to have both the "normal" interface and the HTTP interface, use '''vlc --extraintf http'''.  
  
−
*'''--logo-file <string>''' Full path of the PNG file to use.
+
The HTTP interface will start listening at host:port (&lt;all interfaces&gt;:8080 if omitted), and will reproduce the structure of /directory at <code><nowiki>http://host:port/</nowiki></code> ( vlc_source_path/share/http if omitted ).  
−
*'''--logo-x <integer>''' X offset from the left in pixels.
 
−
*'''--logo-y <integer>''' Y offset from the top in pixels.
 
−
*'''--logo-transparency <integer>''' You can set the logo transparency value here (from 0 for full transparency to 255 for full opacity).
 
  
−
Note: You can move the logo by left-clicking on it.
+
Use a browser to go to <code><nowiki>http://your_host_machine:port</nowiki></code>. You should be taken to the main page.  
  
 +
VLC is shipped with a set of files that should be enough for generic needs. It is also possible to customize pages. See [[Documentation:Play HowTo/Building Pages for the HTTP Interface]].
  
 +
Available pages for 1.0.3&nbsp;:
  
−
==The HTTP interface==
+
*<nowiki>http://host:port</nowiki> - Main Interface
 +
*<nowiki>http://host:port/vlm.html</nowiki> - VLM Interface
 +
*<nowiki>http://host:port/mosaic.html</nowiki> - Mosaic Wizard
 +
*<nowiki>http://host:port/flash.html</nowiki> - Flash based remote playback
  
−
VLC ships with a little HTTP server integrated. It is used both to stream using HTTP, and for the HTTP remote control interface.
 
  
−
To start VLC with the HTTP interface, use:
+
== Other control interfaces ==
−
% '''vlc -I http [--http-src /directory/] [--http-host host:port]'''
 
  
−
If you want to have both the "normal" interface and the HTTP interface, use '''vlc --extraintf http'''.
+
VLC includes a number of so-called interfaces that are not really interfaces, but means of [[Category:Control VLC|controlling VLC]]. Nevertheless, they are enabled by setting them as interface or extra interface, either in the Preferences, in General/Interface, or using '''-I''' or '''--extraintf''' on the command line.  
  
−
The HTTP interface will start listening at host:port (<all interfaces>:8080 if omitted), and will reproduce the structure of /directory at http://host:port/ ( vlc_source_path/share/http if omitted ).
+
=== Hotkeys ===
  
−
Use a browser to go to http://your_host_machine:port. You should be taken to the main page.
+
This module allows you to control VLC and playback via hotkeys. It is always enabled by default. You can use hotkeys in the video output window, you can't in the audio dummy interface.  
  
−
VLC is shipped with a set of files that should be enough for generic needs. It is also possible to customize pages. See [[Documentation:Play_HowTo/Building_Pages_for_the_HTTP_Interface]].
+
Hotkeys can be hacked by:  
  
−
Available pages are:
+
{{%}} '''vlc --key-&lt;function&gt; &lt;code&gt;'''
−
* '''list was obsolete'''
 
  
 +
Code is composed by modifiers keys (Alt, Shift, Ctrl, Meta,Command) separated by a dash (-) and terminated by a key (a...z, +, =, -, ',', +, &lt;, &gt;, `, /,&nbsp;;, ', \, [, ], *, Left, Right, Up, Down, Space, Enter, F1...F12, Home, End, Menu, Esc, Page Up, Page Down, Tab, Backspace, Mouse Wheel Up and Mouse Wheel Down). Main controls are available from hotkeys, such as&nbsp;: fullscreen, play-pause, faster, slower, next, prev, stop, quit, vol-up, etc. (use the '''--longhelp''' option for full list of functions). For example, for binding fullscreen to Ctrl-f, run:
  
−
==Other control interfaces==
+
{{%}} '''vlc --key-fullscreen 'Ctrl-f' '''
  
−
VLC includes a number of so-called interfaces that are not really interfaces, but means of controlling VLC. Nevertheless, they are enabled by setting them as interface or extra interface, either in the Preferences, in General/Interface, or using '''-I''' or '''--extraintf''' on the command line.
+
The list of the default hotkeys is available [[HotKeys|here]].  
  
−
===Hotkeys===
+
=== RC and RTCI ===
  
−
This module allows you to control VLC and playback via hotkeys. It is always enabled by default. You can use hotkeys in the video output window.
+
These two interfaces allow you to control VLC from a command shell (possibly using a remote connexion or a Unix socket).  
  
−
Hotkeys can be hacked by:
+
Start VLC with '''-I rc''' or '''--extraintf rc'''. When you get the '''Remote control interface initialized, `h' for help''' message, press h and Enter to get help about available commands.
−
% '''vlc --key-<function> &lt;code&gt;'''
 
  
−
Code is composed by modifiers keys (Alt, Shift, Ctrl, Meta,Command) separated by a dash (-) and terminated by a key (a...z, +, =, -, ',', +, &lt;, &gt;, `, /, ;, ', \, [, ], *, Left, Right, Up, Down, Space, Enter, F1...F12, Home, End, Menu, Esc, Page Up, Page Down, Tab, Backspace, Mouse Wheel Up and Mouse Wheel Down). Main controls are available from hotkeys, such as : fullscreen, play-pause, faster, slower, next, prev, stop, quit, vol-up, etc. (use the '''--longhelp''' option for full list of functions).
+
To be able to remote connect to your VLC using a TCP socket (telnet-like connexion), use '''--rc-host your_host:port'''. Then, by connecting (using telnet or netcat) to the host on the given port, you will get the command shell.
−
For example, for binding fullscreen to Ctrl-f, run:
 
−
% '''vlc --key-fullscreen 'Ctrl-f' '''
 
  
−
===RC and RTCI===
+
To use a UNIX socket (local socket, this does not work for Windows), use '''--rc-unix /path/to/socket'''. Commands can then be passed using this UNIX socket.
  
−
These two interfaces allow you to control VLC from a command shell (possibly using a remote connexion or a Unix socket).
+
The RTCI interface gives you more advanced options, such as marquee control for the marquee subpicture filter (See filter section).  
  
−
Start VLC with '''-I rc''' or '''--extraintf rc'''. When you get the '''Remote control interface initialized, `h' for help''' message, press h and Enter to get help about available commands.
+
<br>
  
−
To be able to remote connect to your VLC using a TCP socket (telnet-like connexion), use '''--rc-host your_host:port'''. Then, by connecting (using telnet or netcat) to the host on the given port, you will get the command shell.
+
=== Ncurses ===
  
−
To use a UNIX socket (local socket, this does not work for Windows), use '''--rc-unix /path/to/socket'''. Commands can then be passed using this UNIX socket.
+
This is a text interface, using ncurses library.  
  
−
The RTCI interface gives you more advanced options, such as marquee control for the marquee subpicture filter (See filter section).
+
Start VLC with '''-I ncurses''' or '''--extraintf ncurses'''.
  
  
−
===Ncurses===
+
The ncurses interface
  
−
This is a text interface, using ncurses library.
+
Press h to get the list of all available commands, with a short description.  
−
 
 
−
Start VLC with '''-I ncurses''' or '''--extraintf ncurses'''. You will then get something like that:
 
−
 
 
−
http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-ncurses-playlist.jpg The ncurses interface
 
−
 
 
−
Press h to get the list of all available commands, with a short description.
 
  
 
There is also a filebrowser available for the ncurses interface in order to add playlist items. Press 'B' to use it.
 
There is also a filebrowser available for the ncurses interface in order to add playlist items. Press 'B' to use it.
  
−
http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-ncurses-filebrowser.jpg The ncurses filebrowser
+
The ncurses filebrowser  
−
 
 
−
You can set the filebrowser starting point by launching vlc with the '''--browse-dir''' option:
 
  
−
% '''vlc -I ncurses --browse-dir /filebrowser/starting/point/'''
+
You can set the filebrowser starting point by launching vlc with the '''--browse-dir''' option:
  
 +
{{%}} '''vlc -I ncurses --browse-dir /filebrowser/starting/point/'''
  
−
===Gestures===
+
<br>
  
−
Gestures provide a simple mouse gestures control. TODO
+
=== Gestures ===
  
 +
Gestures provide a simple [[mouse gestures]] control. TODO
  
 +
<br>
  
−
==The Mozilla plugin==
+
== The Mozilla plugin ==
  
−
VLC can also be embedded in a web browser! The following browsers are supported [http://www.mozilla.org/ Mozilla], [http://www.mozilla.org/products/firefox/ Firefox] and [http://www.apple.com/macosx/features/safari Safari].
+
VLC can also be embedded in a web browser! The following browsers are supported: [https://www.mozilla.org/products/firefox/ Firefox] and [https://www.apple.com/macosx/features/safari Safari].  
  
−
===Install the plugin===
+
=== Install the plugin ===
  
−
====GNU/Linux Debian====
+
==== GNU/Linux Debian, Ubuntu, etc. ====
  
−
Install the ''mozilla-plugin-vlc'' package:
+
Install the ''mozilla-plugin-vlc'' package using your preferred package manager. For example, at the command line enter:  
  
 
  # '''apt-get update'''
 
  # '''apt-get update'''
 
  # '''apt-get install mozilla-plugin-vlc'''
 
  # '''apt-get install mozilla-plugin-vlc'''
  
−
====Windows====
+
==== Windows ====
  
−
Quit Firefox or Mozilla.
+
Quit Firefox or Mozilla.  
  
−
Copy the two files in '''VLC_Installation_folder\mozilla''' (usually '''C:\Program Files\VideoLAN\VLC\mozilla''') to your mozilla plugins directory (Usually '''C:\Program Files\Mozilla\plugins''' or '''C:\Program Files\Mozilla
+
Select the Mozilla Plugin option when installing VLC Media Player. The installer will then automatically detect your browser and install the plugin.  
−
Firefox\plugins''').
 
  
 
Restart Firefox or Mozilla.
 
Restart Firefox or Mozilla.
  
−
====MacOS X====
+
===== Manual Install =====
−
 
+
In [http://kb.mozillazine.org/Installation_directory "Mozilla Firefox\plugins"]  
−
''The Mozilla/Safari plugin for MacOS X is only available from vlc version 0.8.5.1 and onwards.''
 
−
 
 
−
Quit Safari browser.
 
−
 
 
−
Download the Mozilla/safari plugin package from [http://www.videolan.org/vlc/download-macosx.html MacOS X download page].
 
−
 
 
−
Run the installer from the dmg image.
 
−
 
 
−
 
 
−
====Compile the sources yourself====
 
−
 
 
−
Please look at the [http://developers.videolan.org developers page] for information on how to do this.
 
−
 
 
−
 
 
−
===Use the mozilla plugin===
 
−
 
 
−
If you open a link to a video file handled by the VLC plugin (To get the list of handled types, browse to '''about:plugins''') or a page with an embedded video, the plugin should open and read the
 
−
video.
 
−
 
 
−
===Build HTML pages that use the plugin (VLC version up to 0.8.5)===
 
−
 
 
−
'''WARNING:''' the APIs described in this section are '''deprecated''', do not use,
 
−
 
 
−
The following API description is only valid uptill version 0.8.5 of the mozilla plugin.
 
−
 
 
−
Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the
 
−
plugin.
 
−
 
 
−
The vlc plugin supports the following function calls:
 
−
*'''play()''': Start playing media in the plugin.
 
−
*'''pause()''': Pause playback.
 
−
*'''stop()''': Stop media playback.
 
−
*'''fullscreen()''': Switch the video to full screen.
 
−
*'''set_volume(vol)''': Set the volume. '''vol''' has to be an int in the 0-200 range.
 
−
*'''get_volume()''': Get the current volume setting.
 
−
*'''mute()''': Toggle volume muting.
 
−
*'''set_int_variable(var_name, value)''':
 
−
*'''set_bool_variable(var_name, value)''':
 
−
*'''set_str_variable(var_name, value)''':
 
−
*'''get_int_variable(var_name)''':
 
−
*'''get_bool_variable(var_name)''':
 
−
*'''get_str_variable(var_name)''':
 
−
*'''clear_playlist()''': Clear the playlist.
 
−
*'''add_item(mrl)''': Append an item whose location is given by the [[media resource locator]] to the playlist.
 
−
*'''next()'''
 
−
*'''previous()'''
 
−
*'''isplaying()''': return true if the plugin is playing something.
 
−
*'''get_length()''': Get the media's length in seconds.
 
−
*'''get_position()''': Get the current position in the media in percent.
 
−
*'''get_time()''': Get the current position in the media in seconds.
 
−
*'''seek(seconds,is_relative)''': If is_relative is true, seek relatively to current time, else seek from beginning of the stream. Seek time is specified in seconds.
 
−
 
 
−
 
 
−
Here are a few examples of HTML pages that use the
 
−
Mozilla plugin.
 
−
 
 
−
====Example 1====
 
−
 
 
−
In this example, the plugin will read an HTTP stream inside the web page. If the user goes fullscreen, he will have to press ''f'' or double-click on the video to go back in normal view.
 
−
 
 
−
&lt;html&gt;
 
−
&lt;head&gt;&lt;title&gt;Demo of VLC mozilla plugin&lt;/title&gt;&lt;/head&gt;
 
−
 
 
−
&lt;body&gt;
 
−
 
 
−
&lt;h1&gt;Demo of VLC mozilla plugin - Example 1&lt;/h1&gt;
 
−
 
 
−
&lt;embed type="application/x-vlc-plugin"
 
−
          name="video1"
 
−
          autoplay="no" loop="yes" width="400" height="300"
 
−
          target="http://server.example.org/video1.vob" /&gt;
 
−
&lt;br /&gt;
 
−
  &lt;a href="javascript:;" onclick='document.video1.play()'&gt;Play video1&lt;/a&gt;
 
−
  &lt;a href="javascript:;" onclick='document.video1.pause()'&gt;Pause video1&lt;/a&gt;
 
−
  &lt;a href="javascript:;" onclick='document.video1.stop()'&gt;Stop video1&lt;/a&gt;
 
−
  &lt;a href="javascript:;" onclick='document.video1.fullscreen()'&gt;Fullscreen&lt;/a&gt;
 
−
 
 
−
&lt;/body&gt;
 
−
&lt;/html&gt;
 
−
 
 
−
====Example 2====
 
−
 
 
−
In this example, the plugin will read a multicast UDP/RTP stream in a dedicated video output window.
 
−
 
 
−
&lt;html&gt;
 
−
&lt;head&gt;&lt;title&gt;Demo of VLC mozilla plugin&lt;/title&gt;&lt;/head&gt;
 
−
 
 
−
&lt;body&gt;
 
−
 
 
−
&lt;h1&gt;Demo of VLC mozilla plugin - Example 2&lt;/h1&gt;
 
−
 
 
−
&lt;embed type="application/x-vlc-plugin"
 
−
          name="video2"
 
−
          autoplay="no" loop="no" hidden="yes"
 
−
          target="rtp://@239.255.12.42:5004" /&gt;
 
−
&lt;br /&gt;
 
−
  &lt;a href="javascript:;" onclick='document.video2.play()'&gt;Play video2&lt;/a&gt;
 
−
  &lt;a href="javascript:;" onclick='document.video2.stop()'&gt;Stop video2&lt;/a&gt;
 
−
  &lt;a href="javascript:;" onclick='document.video2.fullscreen()'&gt;Fullscreen&lt;/a&gt;
 
−
 
 
−
&lt;/body&gt;
 
−
&lt;/html&gt;
 
−
 
 
−
==Building HTML pages for Mozilla/Firefox/Internet Explorer/Safari (VLC version 0.8.6 and above)==
 
−
 
 
−
The following description works for any of the browsers VLC supports. The JavaScript API has been unified between Mozilla/Firefox/IE (ActiveX) and Safari, thus targetting at all of the major OS out there. This is only valid for VLC version 0.8.6 and above.
 
−
 
 
−
Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the
 
−
plugin.
 
−
 
 
−
The vlc plugin exports serveral objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.
 
−
 
 
−
The vlc plugin knows the following objects:
 
−
 
 
−
*'''audio''': Access audio properties.
 
−
*'''input''': Access input properties.
 
−
*'''playlist''': Access playlist properties.
 
−
*'''subtitle''': Access subtitle properties.
 
−
*'''video''': Access video properties.
 
−
*'''log''': Access log properties.
 
−
*'''messages''': Access to log message properties.
 
−
*'''iterator''': Access to log iterator properties.
 
−
 
 
−
The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.
 
−
 
 
−
&lt;html&gt;
 
−
&lt;title&gt;VLC Mozilla plugin test page&lt;/title&gt;
 
−
&lt;body&gt;
 
−
&lt;embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" version="VideoLAN.VLCPlugin.2"
 
−
    width="640"
 
−
    height="480"
 
−
    id="vlc"&gt;
 
−
&lt;/embed&gt;
 
−
&lt;script language="Javascript"&gt;
 
−
&lt;!--
 
−
var vlc = document.getElementById("vlc");
 
−
vlc.audio.toggleMute();
 
−
!--&gt;
 
−
&lt;/script&gt;
 
−
&lt;/body&gt;
 
−
&lt;/html&gt;
 
−
 
 
−
====Root object====
 
−
 
 
−
readonly properties
 
−
*'''VersionInfo''': returns version information string
 
−
 
 
−
read/write properties
 
−
*''none''
 
−
 
 
−
methods
 
−
*'''vlc.versionInfo()''': returns version information string (same as VersionInfo)
 
−
 
 
−
====Audio object====
 
−
 
 
−
readonly properties
 
−
*'''vlc.audio.count''': (supported in vlc version >= 1.1.0) returns the number of audio track available.
 
−
 
 
−
read/write properties
 
−
*'''vlc.audio.mute''': boolean value to mute and ummute the audio.
 
−
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
 
−
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [1-65535] which indicates the audio track to play or that is playing. a value of 0 means the audio is/will be disabled.
 
−
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.
 
−
 
 
−
Audio Channel:
 
−
<SELECT readonly onChange='doAudioChannel(this.value)'>
 
−
    <OPTION value=1>Stereo</OPTION>
 
−
    <OPTION value=2>Reverse stereo</OPTION>
 
−
    <OPTION value=3>Left</OPTION>
 
−
    <OPTION value=4>Right</OPTION>
 
−
    <OPTION value=5>Dolby</OPTION>
 
−
</SELECT>
 
−
 
 
−
<SCRIPT language="javascript">
 
−
&lt;!--
 
−
function doAudioChannel(value)
 
−
{
 
−
    var vlc = getVLC("vlc");
 
−
    vlc.audio.channel = parseInt(value);
 
−
    alert(vlc.audio.channel);
 
−
};
 
−
--&gt;
 
−
 
 
−
methods
 
−
*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state.
 
−
*'''vlc.audio.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th audio track name. 0 corresponds to disable and 1 to the first audio track.
 
−
 
 
−
====Input object====
 
−
 
 
−
readonly properties
 
−
*'''vlc.input.length''': length of the input file in number of milliseconds. 0 is returned for 'live' streams or clips whose length cannot be determined by VLC. It returns -1 if no input is playing.
 
−
*'''vlc.input.fps''': frames per second returned as a float (typically 60.0, 50.0, 23.976, etc...)
 
−
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed
 
−
 
 
−
read/write properties
 
−
*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
 
−
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream
 
−
&lt;!-- absolute seek in stream !--&gt;
 
−
vlc.input.time = &lt;absolute seek&gt;
 
−
&lt;!-- relative seek in stream !--&gt;
 
−
vlc.input.time = vlc.input.time + &lt;relative seek&gt;
 
−
*'''vlc.input.state''': current state of the input chain given as enumeration (IDLE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, STOPPING=5, ENDED=6, ERROR=7). Note: Test for ENDED=6 to catch end of playback. Checking for STOPPING=5 is NOT ENOUGH.
 
−
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.).
 
−
rate &gt; 1              : is fastforward
 
−
rate &gt; 0 and rate &lt; 1 : is slow motion
 
−
rate &lt; 0              : is rewind
 
−
 
 
−
methods
 
−
*''none''
 
−
 
 
−
====Playlist object====
 
−
 
 
−
readonly properties
 
−
*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist ('''deprecated''', do not use, see [[#Playlist_items_object| Playlist items]])
 
−
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing
 
−
*'''vlc.playlist.items''': return the playlist items collection, see [[#Playlist_items_object| Playlist items]]
 
−
 
 
−
read/write properties
 
−
*''none''
 
−
 
 
−
methods
 
−
*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string. Returns a number as an item identifier in playlist (this is not a position  in playlist).
 
−
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. options are text arguments which can be provided either as a single string containing space separated values, akin to VLC command line, or as an array of string values. Returns a number as an item identifier in playlist (this is not a position in playlist).
 
−
  var options = new Array(":aspect-ratio=4:3", "--rtsp-tcp");
 
−
  var id = vlc.playlist.add("rtsp://servername/item/to/play", "fancy name", options);
 
−
  vlc.playlist.playItem(id);
 
−
*'''vlc.playlist.play()''': start playing the current playlist item
 
−
*'''vlc.playlist.playItem(number)''': start playing the item whose identifier is number
 
−
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
 
−
*'''vlc.playlist.stop()''': stop playing the current playlist item
 
−
*'''vlc.playlist.next()''': iterate to the next playlist item
 
−
*'''vlc.playlist.prev()''': iterate to the previous playlist item
 
−
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object| Playlist items]])
 
−
*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number <!-- (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() ) --> ('''deprecated''', do not use, see [[#Playlist_items_object| Playlist items]])
 
−
 
 
−
====Playlist items object====
 
−
 
 
−
readonly properties
 
−
*'''vlc.playlist.items.count''': number of items currently in the playlist
 
−
 
 
−
read/write properties
 
−
*''none''
 
−
 
 
−
methods
 
−
*'''vlc.playlist.items.clear()''': empty the current playlist, all items will be deleted from the playlist. If a movie is playing, it stop. Note that when this method returns, playlist may not have been entirely been cleared as this operation is performed asynchronously; use the ''count'' property to verify/wait until the playlist is empty.
 
−
*'''vlc.playlist.items.remove(number)''': remove the item whose identifier is number from playlist. (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() )
 
−
 
 
−
====Subtitle object====
 
−
 
 
−
readonly properties
 
−
 
 
−
*'''vlc.subtitle.count''': (supported in vlc version >= 1.1.0) returns the number of subtitle available.
 
  
−
read/write properties
+
Create the directory if it doesn't exist.
  
−
*'''vlc.subtitle.track''': (supported in vlc version >= 1.1.0) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
+
'''Folders''' to copy:
 +
* osdmenu
 +
* plugins
  
−
methods
+
'''Files''' to copy:
 +
*    vlc.exe
 +
*    vlc.exe.manifest
 +
*    vlc-cache-gen.exe
 +
*    npvlc.dll.manifest
 +
*    npvlc.dll
 +
*    libvlccore.dll
 +
*    libvlc.dll
 +
*    libvlc.dll.manifest
 +
*    axvlc.dll
 +
*    axvlc.dll.manifest
  
−
*'''vlc.subtitle.description(int i)''': (supported in vlc version >= 1.1.0) give the i-th subtitle name. 0 correspond to disable and 1 to the first subtitle.
+
==== macOS ====
  
−
====Video object====
+
''The Mozilla/Safari plugin for [[macOS]] is only available from vlc version 0.8.5.1 and onwards.''
  
−
readonly properties
+
Quit Safari browser.  
−
*'''vlc.video.width''': returns the horizontal size of the video
 
−
*'''vlc.video.height''': returns the vertical size of the video
 
  
−
read/write properties
+
Download the Mozilla/safari plugin package from [https://www.videolan.org/vlc/download-macosx.html macOS download page].  
−
*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
 
−
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
 
−
*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
 
−
*'''vlc.video.teletext''': (supported in vlc version >= 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..999] for indicating the teletext page to view, setting the value to 0 means hide teletext. On error it will return -1 and display an error message.
 
  
−
methods
+
Run the installer from the dmg image.  
−
*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting
 
−
*'''vlc.video.toggleTeletext()''': (supported in vlc version >= 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting
 
  
−
====Log object====
+
<br>
−
: '''CAUTION''': For security concern, VLC 1.0.0-rc1 is probably the latest (near-to-stable) version in which this object and its children are supported.
 
  
 +
==== Compile the sources yourself ====
  
−
This object allows accessing VLC main message logging queue. Typically this queue capacity is very small (no nore than 256 entries) and can easily overflow, therefore messages should be read and cleared as often as possible.
+
Please look at the [https://www.videolan.org/developers developers page] for information on how to do this.  
  
−
readonly properties
+
<br>
−
*'''vlc.log.messages''': returns the message collection, see [[#Messages object|Messages object]]
 
  
−
read/write properties
+
=== Use the Mozilla plugin ===
−
*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages; messages whose verbosity is higher than set will be not be logged in the queue. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.
 
  
−
methods
+
If in the browser you open a link to an audio or video URL handled by the VLC plugin, or if a web page has HTML code that embeds audio or video handled by the VLC plugin, then the plugin should start and play the audio/video.
−
*''none''
+
Note the plugin (as of version 1.1.9) does not present any user interface — it has no default control panel and no keyboard shortcuts.
  
−
====Messages object====
+
To get the list of the media types handled by the VLC plugin, browse to '''about:plugins'''.
 +
Conflicts will arise if you have more than one plugin installed that supports the same media type.
  
−
readonly properties
+
See the [[Documentation:WebPlugin|Web plugin documentation]] to create HTML pages that use JavaScript to control the plugin.
−
*'''messages.count''': returns number of messages in the log
 
  
−
read/write properties
+
== Snapshot Tool ==
−
*''none''
 
  
−
methods
+
Did you know you can use special codes to automatically generate filenames in the [[Snapshot Tool]]?
−
*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the message queue. Call this method after the log messages of interest are read.
 
−
*'''messages.iterator()''': creates and returns an iterator object, used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''
 
  
−
====Messages Iterator object====
 
  
−
readonly properties
+
== Specifying Streaming Options ==
−
*'''iterator.hasNext''': returns a boolean that indicates whether ''vlc.log.messages.next()'' will return the next message.
+
{{Further|Documentation:Streaming HowTo New}}
  
−
read/write properties
+
== Audio Bar Graph over Video ==
−
*''none''
 
  
−
methods
+
This section specifies how to enable the audiobargraph audio filter and video overlay, (mostly) via the [[GUI]].  This displays an audio meter overlaid on the video.
−
*'''iterator.next()''': returns the next message object in the log, see [[Message object]]
 
  
−
====Message object====
+
There are three parts - an audio filter, which sends it's output via [[TCP]] to the Remote Control (RC) Interface.  This information is then picked up and displayed by the Audio Bar Graph video subpicture filter (OSD).
  
−
*'''message.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
+
To enable this, VLC needs to be started with the '''--rc-host''' command-line switch - e.g.
−
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
+
{{%}} '''"C:\Program Files\VideoLAN\VLC\vlc.exe" --rc-host localhost:12345'''
−
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
 
−
*'''message.message''': the message text
 
  
 +
In the GUI, set the following (this example from VLC v1.1.9 on Windows 7):
 +
* Preferences:Show settings:All
 +
* Audio/Filters > Enable "Audio part of the BarGraph function"
 +
* Audio/Filters/audiobargraph > use defaults, change "Sends the barGraph information every n audio packets" to 1 to enable see a more accurate display
 +
* Interface/Main interfaces > Enable "Remote control interface"
 +
* Interface/Main interfaces/RC > Enable "Do not open a DOS command box interface"
 +
* Video/Subtitles-OSD > Enable "Audio Bar Graph Video sub filter"
 +
* Video/Subtitles-OSD/Audio Bar Graph > Set the following settings:
 +
** "Value of the audio channels levels" = 0 (setting this to 0:1 crashes VLC v1.1.9)
 +
** "X coordinate" = 0
 +
** "Y coordinate" = 0 (this doesn't seem to affect anything)
 +
** "Transparency of the bargraph" = 128 for 50% transparency which looks ok
 +
** "Bargraph position" = Left (seems to only work Left,Center,Right - can't go top or bottom)
 +
** "Alarm" = 1 (enables the silence alarm - puts a red border around the bargraph if silent for too long)
 +
** "Bar width in pixel" = 10 (20 if you want it to be really visible)
  
 
{{Documentation}}
 
{{Documentation}}
 +
[[Category:Proposed deletion]]

Latest revision as of 07:04, 7 April 2019

VLC User Guide

Quick Start Guide
Installing VLC
History
Usage
Interface
Open Media
Audio
Video
Playback
Playlist
Subtitles
Video and Audio Filters
Snapshots
Hotkeys
Uninstalling VLC
Troubleshooting
Advanced usage
Using VLC inside a webpage
Command line
Alternative Interfaces
Misc

Appendix
Building Pages for the HTTP Interface
Format String
Building Lua Playlist Scripts
View this alone

Use the command line

TODO: completely outdated

This page is outdated and information might be incorrect.
Create an account to start editing, and then click here to update this article.

All standard operations of VLC should be available from the GUI. However, some complex operations can only be done from the command line and there are situations in which you don't need or want a GUI. Here is the complete description of VLC's command line and how to use it.

You need to be quite comfortable with command line usage to use this. 

Note: Windows users have to use the --option-name="value" syntax instead of the --option-name value syntax.

Getting help

VLC uses a modular structure. The core mainly manages communication between modules. All the multimedia processing is done by modules. There are input modules, demultiplexers, decoders, video output modules, ...

This chapter will only describe the "general" options, i.e. the core options. Each module adds new options. For example, the HTTP input module will add options for caching, proxy, authentication, ...

By using vlc --help, you will get the basic core options. vlc --longhelp will give all the basic options (core + modules). Adding --advanced will give the "advanced options" (for advanced users). So vlc --longhelp --advanced will give you all options. You can also append --help-verbose if you want more detailed help.

Also, you might want to get debug information. To do this, use -v or -vv (this will show lower severity messages). If your console supports it, you can add --color to get messages in color.

Opening streams

The following commands start VLC and start reading the given element(s):

Opening a file

Start VLC with: 

% vlc my_file

VLC should be able to recognize the file type. If it does not, you can force demultiplexer and decoder (see below).

A list of all video and audio codecs supported by VLC check the VLC features list.

Opening a DVD or VCD, or an audio CD

Start VLC with:

For a DVD with menus: 

% vlc dvd://[device][@raw_device][@[title][:[chapter][:angle]]]

In most cases, vlc dvd:// or vlc dvd://[device] will do. [device] is for example /dev/dvd on GNU/Linux or D: on Windows (complete path to your DVD drive).

or

(DVD without menus): 

% vlc dvdsimple://[device][@raw_device][@[title][:[chapter][:angle]]]

or

(VCD): 

% vlc vcd://[device][@{E|P|E|T|S}[number]]

or

(Audio CD): 

% vlc cdda://[device][@[track]]

Receiving a network stream

To receive an unicast RTP/UDP stream (sent by VLC's stream output), start VLC with: 

% vlc rtp://@:5004

If 5004 is the port to which packets are sent. 1234 is another commonly used port number. you use the default port (1234), vlc rtp:// will do. For more information, look at the Streaming Howto.

To receive an multicast UDP/RTP stream (sent by VLC's stream output), start VLC with: 

% vlc rtp://@multicast_address:port

To receive a SSM (source specific multicast) stream, you can use: 

% vlc rtp://server_address@multicast_address:port

This only works on Operating systems that support SSM (Windows XP and Linux).

To receive a HTTP stream, start VLC with: 

% vlc http://www.example.org/your_file.mpg

To receive a RTSP stream, start VLC with:</para> 

% vlc rtsp://www.example.org/your_stream

Modules selection

VLC always tries to select the most appropriate interface, input and output modules, among the ones available on the system, according to the stream it is given to read. However, you may wish to force the use of a specific module with the following options.

  • --intf <module> allows you to select the interface module.
  • --extraintf <module> allows you to select extra interface modules that will be launched in addition to the main one. This is mainly useful for special control interfaces, like HTTP, RC (Remote Control), ... (see below)
  • --aout <module> allows you to select the audio output module.
  • --vout <module> allows you to select the video output module.
  • --memcpy <module> allows you to choose a memory copy module. You should probably never touch that.

You can get a listing of the available modules by using vlc -l

Stream Output

The Stream output system allows vlc to become a streaming server.

For more details on the stream output system, please have a look at the Streaming HowTo.


Other Options

Audio options

  • --noaudio disables audio output. Note that if you are streaming (ex: to a file) this has no effect (streaming copies the audio verbatim). Use --sout-xxx instead (ex: --no-sout-audio)
  • --mono forces VLC to treat the stream in mono audio.
  • --volume <integer> sets the level of audio output (between 0 and 1024). Also only applies to local playback (like --noaudio).
  • --aout-rate <integer> sets the audio output frequency (Hz). By default, VLC will try to autodetect this.
  • --desync <integer> compensates desynchronization of audio (ms). (If audio and video streams are not synchronized, use this setting to delay the audio stream)
  • --audio-filter <string> adds audio filters to the processing chain. Available filters are visual (visualizer with spectrum analyzer and oscilloscope), headphone (virtual headphone patialization) and normalizer (volume normalizer)

Video options

  • --no-video disables video output.
  • --grayscale turns video output into grayscale mode.
  • --fullscreen ( or -f) sets fullscreen video.
  • --nooverlay disables hardware acceleration for the video output.
  • --width, --height <integer> sets the video window dimensions. By default, the video window size will be adjusted to match the video dimensions.
  • --start-time <integer> starts the video here; the integer is the number of seconds from the beginning (e.g. 1:30 is written as 90)
  • --stop-time <integer> stops the video here; the integer is the number of seconds from the beginning (e.g. 1:30 is written as 90)
  • --zoom <float> adds a zoom factor.
  • --aspect-ratio <mode> forces source aspect ratio. Modes are 4x3, 16x9, ...
  • --spumargin <integer> forces SPU subtitles position.
  • --video-filter <string> adds video filters to the processing chain. You can add several filters, separated by commas
  • --sub-filter <string> adds video subpictures filter to the processing chain.

Desktop/Screen grab options

You can see the various options for "grabbing the desktop" (VLC's built-in screen grabber capture device) by using the GUI. See https://forum.videolan.org/viewtopic.php?f=4&t=46971

Playlist options

  • --random plays files randomly forever.
  • --loop loops playlist on end.
  • --repeat repeats current item until another item is forced
  • --play-and-stop stops the playlist after each played item.

Network options

  • --server-port <integer> sets server port.
  • --iface <string> specifies the network interface to use.
  • --iface-addr <string> specifies your network interface IP address.
  • --mtu <integer> specifies the MTU of the network interface.
  • --ipv6 forces IPv6.
  • --ipv4 forces IPv4.

CPU options

You should probably not touch these options unless you know what you are doing.

  • --nommx disables the use of MMX CPU extensions.
  • --no3dn disables the use of 3D Now! CPU extensions.
  • --nommxext disables the use of MMX Ext CPU extensions.
  • --nosse disables the use of SSE CPU extensions.
  • --noaltivec disables the use of Altivec CPU extensions.

Miscellaneous options

  • --quiet deactivates all console messages.
  • --color displays color messages.
  • --search-path <string> specifies interface default search path.
  • --plugin-path <string> specifies plugin search path.
  • --no-plugins-cache disables the plugin cache (plugins cache speeds up startup)
  • --dvd <string> specifies the default DVD device.
  • --vcd <string> specifies the default VCD device.
  • --program <integer> specifies program (SID) (for streams with several programs, like satellite ones).
  • --audio-type <integer> specifies the default audio type to use with dvds.
  • --audio-channel <integer> specifies the default audio channel to use with dvds.
  • --spu-channel <integer> specifies the default subtitle channel to use with dvds.
  • --version gives you information about the current VLC version.
  • --module <module> displays help about specified module. (Shortcut: -p)

Item-specific options

There are many options that are related to items (like --novideo, --codec, --fullscreen).

For all of these, you have the possibility to make them item-specific, using ":" instead of "--" and putting the option just after the concerned item.

Examples: 

% vlc file1.mpg :fullscreen file2.mpg

will play file1.mpg in fullscreen mode and file2.mpg in the default mode (which is generally no fullscreen), whereas 

% vlc --fullscreen file1.mpg file2.mpg

will play both files in fullscreen mode 

% vlc --fullscreen file1.mpg :sub-file=file1.srt :no-fullscreen file2.mpg :filter=distort

will play file1.mpg in windowed (no-fullscreen) mode with the subtitles file file1.srt and will play file2.mpg with video filter distort enabled in fullscreen mode (item-specific options override global options).

Advanced use of filters

Filters

These are the old style VLC filters. They only apply to on screen display and thus cannot be streamed. However, on version 1.1.11 you are still able to apply these filters in transcode module using parameter vfilter. More information can be found on Documentation:Streaming HowTo/Advanced Streaming Using the Command Line#vfilter.

Deinterlacing video filter

Module name: deinterlace

  • --deinterlace-mode {discard,blend,mean,bob,linear,x,yadif,yadif (2x),phosophor,ivtc} choose a deinterlacing mode.

Invert video filter

Module name: invert

Image properties filter

Module name: adjust

Transcluded from Documentation:Modules/adjust
  • contrast <float [0.0 .. 2.0]> : Contrast default value: 1.0
  • brightness <float [0.0 .. 2.0]> : Brightness default value: 1.0
  • hue <float [-180 .. 180]> : Hue default value: 0
  • saturation <float [0.0 .. 3.0]> : Saturation default value: 1.0
  • gamma <float [0.01 .. 10.0]> : Gamma default value: 1.0
  • brightness-threshold <boolean> : When this mode is enabled, pixels will be shown as black or white. Also may invert the brightness value. The threshold value will be the brightness defined below default value: disabled

Wall video filter

Module name: wall This filter splits the output in several windows.

Transcluded from Documentation:Modules/wall
  • wall-cols <integer [1 .. 15]> : Number of horizontal windows in which to split the video default value: 3
  • wall-rows <integer [1 .. 15]> : Number of vertical windows in which to split the video default value: 3
  • wall-active <string> : Comma-separated list of active windows, defaults to all default value: NULL
  • wall-element-aspect <string> : Aspect ratio of the individual displays building the wall default value: 4:3

Video transformation filter

Module name: transform

Transcluded from Documentation:Modules/transform
  • transform-type <string> { "90", "180", "270", "hflip", "vflip", "transpose", "antitranspose" } : Transformation type default value: "90"

Distort video filter

Module name: distort

See Documentation:Modules/distort

Clone video filter

This filter clones the output window.

Module name: clone

Transcluded from Documentation:Modules/clone
  • clone-count <integer> : Number of video windows in which to clone the video. default value: 2
  • clone-vout-list <string> : You can use specific video output modules for the clones. Use a comma-separated list of modules. default value: ""

Croppadd video filter

Module name: croppadd

Transcluded from Documentation:Modules/croppadd
  • croppadd-croptop <integer [0 .. INT_MAX]> : Pixels to crop from top
  • croppadd-cropbottom <integer [0 .. INT_MAX]> : Pixels to crop from bottom
  • croppadd-cropleft <integer [0 .. INT_MAX]> : Pixels to crop from left
  • croppadd-cropright <integer [0 .. INT_MAX]> : Pixels to crop from right
  • croppadd-paddtop <integer [0 .. INT_MAX]> : Pixels to add to top
  • croppadd-paddbottom <integer [0 .. INT_MAX]> : Pixels to add to bottom
  • croppadd-paddleft <integer [0 .. INT_MAX]> : Pixels to add to left
  • croppadd-paddright <integer [0 .. INT_MAX]> : Pixels to add to right

Motion blur filter

Module name: motionblur

Transcluded from Documentation:Modules/motionblur
  • motionblur-factor <integer [1 .. 127]> : The bluring factor (1 to 127). Higher values mean more blurring default value: 80

Video pictures blending

Module name: blend

Video scaling filter

Module name: scale


Subpictures Filters

These are the new VLC filters. They can be streamed.

Marquee display sub filter

Module name: marq

Transcluded from Documentation:Modules/marq
  • marq-marquee <string> : Marquee text to display. default value: VLC
  • marq-file <string> : File to read the marquee text from. default value: NULL
  • marq-x <integer> : X offset, from the left screen edge. default value: 0
  • marq-y <integer> : Y offset, down from the top. default value: 0
  • marq-position <integer> : Marquee position: 0=center, 1=left, 2=right, 4=top, 8=bottom, you can also use combinations of these values, eg 6 = top-right. default value: -1
  • marq-opacity <integer [0 .. 255]> : Opacity (inverse of transparency) of overlaid text. 0 = transparent, 255 = totally opaque. default value: 255
  • marq-color <integer> { 0x000000, 0x808080, 0xC0C0C0, 0xFFFFFF, 0x800000, 0xFF0000, 0xFF00FF, 0xFFFF00, 0x808000, 0x008000, 0x008080, 0x00FF00, 0x800080, 0x000080, 0x0000FF, 0x00FFFF } : Color of the text that will be rendered on the video. This must be an hexadecimal (like HTML colors). The first two chars are for red, then green, then blue. default value: 0xFFFFFF
  • marq-size <integer [0 .. 4096]> : Font size, in pixels. 0 uses the default font size. default value: 0
  • marq-timeout <integer> : Number of milliseconds the marquee must remain displayed. 0 means forever. default value: 0
  • marq-refresh <integer> : Number of milliseconds between string updates. This is mainly useful when using meta data or time format string sequences. default value: 1000

Logo video filter

Module name: logo

Transcluded from Documentation:Modules/logo
  • logo-file <string> : Image to display. The full format is <image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...].
  • logo-x <integer> : X offset from upper left corner. default value: 0
  • logo-y <integer> : Y offset from upper left corner. default value: 0
  • logo-position <integer> { 0, 1, 2, 4, 8, 5, 6, 9, 10 } : Logo position. default value: 5
  • logo-opacity <integer [0 .. 255]> : Logo opacity. 0 is transparent, 255 is fully opaque. default value: 255
  • logo-delay <integer> : Global delay in ms. Sets the duration each image will be displayed for in a loop iteration unless specified otherwise in the --logo-file option. default value: 1000
  • logo-repeat <integer> : Number of loops for the logo animation. -1 for continuous, 0 to disable. default value: -1

This filter can be used both as an old style filter or a subpictures filter.

Note: You can move the logo by left-clicking on it.


The HTTP interface

VLC ships with a little HTTP server integrated. It is used both to stream using HTTP, and for the HTTP remote control interface.

To start VLC with the HTTP interface, use: 

% vlc -I http [--http-src /directory/] [--http-host host:port]

If you want to have both the "normal" interface and the HTTP interface, use vlc --extraintf http.

The HTTP interface will start listening at host:port (<all interfaces>:8080 if omitted), and will reproduce the structure of /directory at http://host:port/ ( vlc_source_path/share/http if omitted ).

Use a browser to go to http://your_host_machine:port. You should be taken to the main page.

VLC is shipped with a set of files that should be enough for generic needs. It is also possible to customize pages. See Documentation:Play HowTo/Building Pages for the HTTP Interface.

Available pages for 1.0.3 :

  • http://host:port - Main Interface
  • http://host:port/vlm.html - VLM Interface
  • http://host:port/mosaic.html - Mosaic Wizard
  • http://host:port/flash.html - Flash based remote playback


Other control interfaces

VLC includes a number of so-called interfaces that are not really interfaces, but means of. Nevertheless, they are enabled by setting them as interface or extra interface, either in the Preferences, in General/Interface, or using -I or --extraintf on the command line.

Hotkeys

This module allows you to control VLC and playback via hotkeys. It is always enabled by default. You can use hotkeys in the video output window, you can't in the audio dummy interface.

Hotkeys can be hacked by: 

% vlc --key-<function> <code>

Code is composed by modifiers keys (Alt, Shift, Ctrl, Meta,Command) separated by a dash (-) and terminated by a key (a...z, +, =, -, ',', +, <, >, `, /, ;, ', \, [, ], *, Left, Right, Up, Down, Space, Enter, F1...F12, Home, End, Menu, Esc, Page Up, Page Down, Tab, Backspace, Mouse Wheel Up and Mouse Wheel Down). Main controls are available from hotkeys, such as : fullscreen, play-pause, faster, slower, next, prev, stop, quit, vol-up, etc. (use the --longhelp option for full list of functions). For example, for binding fullscreen to Ctrl-f, run: 

% vlc --key-fullscreen 'Ctrl-f'

The list of the default hotkeys is available here.

RC and RTCI

These two interfaces allow you to control VLC from a command shell (possibly using a remote connexion or a Unix socket).

Start VLC with -I rc or --extraintf rc. When you get the Remote control interface initialized, `h' for help message, press h and Enter to get help about available commands.

To be able to remote connect to your VLC using a TCP socket (telnet-like connexion), use --rc-host your_host:port. Then, by connecting (using telnet or netcat) to the host on the given port, you will get the command shell.

To use a UNIX socket (local socket, this does not work for Windows), use --rc-unix /path/to/socket. Commands can then be passed using this UNIX socket.

The RTCI interface gives you more advanced options, such as marquee control for the marquee subpicture filter (See filter section).


Ncurses

This is a text interface, using ncurses library.

Start VLC with -I ncurses or --extraintf ncurses.


The ncurses interface

Press h to get the list of all available commands, with a short description.

There is also a filebrowser available for the ncurses interface in order to add playlist items. Press 'B' to use it.

The ncurses filebrowser

You can set the filebrowser starting point by launching vlc with the --browse-dir option: 

% vlc -I ncurses --browse-dir /filebrowser/starting/point/


Gestures

Gestures provide a simple mouse gestures control. TODO


The Mozilla plugin

VLC can also be embedded in a web browser! The following browsers are supported: Firefox and Safari.

Install the plugin

GNU/Linux Debian, Ubuntu, etc.

Install the mozilla-plugin-vlc package using your preferred package manager. For example, at the command line enter: 

# apt-get update
# apt-get install mozilla-plugin-vlc

Windows

Quit Firefox or Mozilla.

Select the Mozilla Plugin option when installing VLC Media Player. The installer will then automatically detect your browser and install the plugin.

Restart Firefox or Mozilla.

Manual Install

In "Mozilla Firefox\plugins"

Create the directory if it doesn't exist.

Folders to copy:

  • osdmenu
  • plugins

Files to copy:

  • vlc.exe
  • vlc.exe.manifest
  • vlc-cache-gen.exe
  • npvlc.dll.manifest
  • npvlc.dll
  • libvlccore.dll
  • libvlc.dll
  • libvlc.dll.manifest
  • axvlc.dll
  • axvlc.dll.manifest

macOS

The Mozilla/Safari plugin for macOS is only available from vlc version 0.8.5.1 and onwards.

Quit Safari browser.

Download the Mozilla/safari plugin package from macOS download page.

Run the installer from the dmg image.


Compile the sources yourself

Please look at the developers page for information on how to do this.


Use the Mozilla plugin

If in the browser you open a link to an audio or video URL handled by the VLC plugin, or if a web page has HTML code that embeds audio or video handled by the VLC plugin, then the plugin should start and play the audio/video. Note the plugin (as of version 1.1.9) does not present any user interface — it has no default control panel and no keyboard shortcuts.

To get the list of the media types handled by the VLC plugin, browse to about:plugins. Conflicts will arise if you have more than one plugin installed that supports the same media type.

See the Web plugin documentation to create HTML pages that use JavaScript to control the plugin.

Snapshot Tool

Did you know you can use special codes to automatically generate filenames in the Snapshot Tool?


Specifying Streaming Options

Further information: Documentation:Streaming HowTo New

Audio Bar Graph over Video

This section specifies how to enable the audiobargraph audio filter and video overlay, (mostly) via the GUI. This displays an audio meter overlaid on the video.

There are three parts - an audio filter, which sends it's output via TCP to the Remote Control (RC) Interface. This information is then picked up and displayed by the Audio Bar Graph video subpicture filter (OSD).

To enable this, VLC needs to be started with the --rc-host command-line switch - e.g. 

% "C:\Program Files\VideoLAN\VLC\vlc.exe" --rc-host localhost:12345

In the GUI, set the following (this example from VLC v1.1.9 on Windows 7):

  • Preferences:Show settings:All
  • Audio/Filters > Enable "Audio part of the BarGraph function"
  • Audio/Filters/audiobargraph > use defaults, change "Sends the barGraph information every n audio packets" to 1 to enable see a more accurate display
  • Interface/Main interfaces > Enable "Remote control interface"
  • Interface/Main interfaces/RC > Enable "Do not open a DOS command box interface"
  • Video/Subtitles-OSD > Enable "Audio Bar Graph Video sub filter"
  • Video/Subtitles-OSD/Audio Bar Graph > Set the following settings:
    • "Value of the audio channels levels" = 0 (setting this to 0:1 crashes VLC v1.1.9)
    • "X coordinate" = 0
    • "Y coordinate" = 0 (this doesn't seem to affect anything)
    • "Transparency of the bargraph" = 128 for 50% transparency which looks ok
    • "Bargraph position" = Left (seems to only work Left,Center,Right - can't go top or bottom)
    • "Alarm" = 1 (enables the silence alarm - puts a red border around the bargraph if silent for too long)
    • "Bar width in pixel" = 10 (20 if you want it to be really visible)
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
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.
Retrieved from "https://wiki.videolan.org/index.php?title=Documentation:Advanced_Use_of_VLC&oldid=60680"