VideoLAN Wiki - User contributions [en]

Interfaces

2010-08-20T20:37:39Z

Grahack: Watching a video, hotkeys are available with the dummy interface.

Interfaces are the way you interact with {{VLC}}. Like anything else in VLC, they are modules, which allows for their interchangeability (see below).

== Main interfaces ==
VLC has four main graphical interfaces:
* The [[Qt Interface]] (qt) is the default interface on [[Linux]] and [[Windows]] starting with version 0.9.0.
: Used to be [[wxWidgets Interface]] (wx) before.
* The [[Skins|skins2 Interface]] is an interface where you can customize VLC's look (works on Linux and Windows).
* The [[Mac OS X Interface]] is the default (and only) graphical interface on Mac OS X.
* The [[BeOS Interface]] is the default (and only) graphical interface on BeOS.

== Full list ==
Besides the above main interfaces, VLC contains many more:
{|
|'''qt'''
| Current (>=0.9.0) default [http://www.trolltech.com/qt Qt4] interface on [[Linux]] and [[Windows]].
|-
|'''wx'''
| Previous (<0.9.0) default [http://www.wxwidgets.org/ wxWidgets] interface on [[Linux]] and [[Windows]].
|-
|'''skins2'''
| Load VLC with a [[Skins|skin]]. (Linux and Windows only)
|-
|'''macosx'''
| Default [[Mac OS X]] interface.
|-
|'''beos'''
| Default [[BeOS]] interface.
|-
| '''http'''
| [[Web Interface]], used for controlling VLC from over a network.
|-
| '''gestures'''
| [[Mouse Gestures]], where you can control VLC by moving the mouse
|-
| '''rc''', '''ncurses''', '''telnet'''
| [[Console|Console Interfaces]], non-graphical interfaces.
|-
| '''showintf'''
| Show interfaces module.
|-
| '''hotkeys''' and '''joystick'''
| Control VLC with the keyboard/joystick (see [[HotKeys]]).
|-
| '''dummy'''
| Don't use an interface ([[HotKeys]] still available).
|}

== Listing the available interfaces ==

To get a list of available interfaces, running VLC with the -l option:
vlc -l
This also displays the [[muxers]] and [[encoders]]/[[decoders]] and puts it in a file called "vlc-help.txt". On Linux, run
vlc -l | grep -i interface
to display the interfaces.

== Using an interface ==

To run VLC with a different primary interface, use the following command:
vlc --intf ''name''
You can also use
vlc -I ''name''
You can also change the default in the [[Preferences]].

However, you can also launch more than one interface:
vlc --intf qt --extraintf sap,telnet,http
This will launch VLC with the default QT interface, but will also launch the sap, telnet and web interface in addition to the QT one. The default for this can also be changed in the preferences.

Note that if you only use the dummy interface, you won't be able to tell vlc to quit (except watching a video). You may have to break it manually with Ctrl+C; or use vlc://quit as the last item on the playlist.

== See also ==
* '''See also [[:Category:Interfaces]]'''

[[Category:Interfaces]]

Documentation:Advanced Use of VLC

2010-08-20T20:33:31Z

Grahack: Added "you can't use hotkeys in the audio dummy interface"

{{RightMenu|documentation play howto toc}}

==Use the command line==

'''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.

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 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.

===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 is available on the [http://www.videolan.org/vlc/features.html 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 OSs 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 [[Documentation:Streaming HowTo|Streaming HowTo]].

===Other Options===

====Audio options====

*'''--noaudio''' disables audio output.
*'''--mono''' forces VLC to treat the stream in mono audio.
*'''--volume <integer>''' sets the level of audio output (between 0 and 1024).
*'''--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====

*'''--novideo''' 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.
*'''--zoom <float>''' adds a zoom factor.
*'''--aspect-ratio <mode>''' forces source aspect ratio. Modes are 4x3, 16x9, ...
*'''--spumargin <integer>''' forces SPU subtitles postion.
*'''--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 http://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.

====Deinterlacing video filter====

Module name: '''deinterlace'''

*'''--deinterlace-mode {discard,blend,mean,bob,linear}''' choose a deinterlacing mode.

====Invert video filter====

Module name: '''invert'''

====Image properties filter====

Module name: '''adjust'''

*'''--contrast <float>''' Image contrast in the 0-2 range.
*'''--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: '''wall'''

This filter splits the output in several windows.

*'''--wall-cols <integer>''' Number of columns.
*'''--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: '''transform'''

*'''--transform-type {90,180,270,hflip,vflip}''' Select rotation angle or symmetry.

====Distort video filter====

Module name: '''distort'''

====Clone video filter====

This filter clones the output window.

Module name: '''clone'''

*'''--clone-count <integer>''' Number of clones.
*'''--clone-vout-list <string>''' Comma separated string of video output modules.

====Crop video filter====

Module name: '''crop'''

*'''--crop-geometry <string>''' Set the geometry of the zone to crop. This is set as <width> x <height> + <left offset> + <top offset>.
*'''--autocrop''' Enable automatic black border cropping.

====Motion blur filter====

Module name: '''motionblur'''

*'''blur-factor <integer>''' Blur factor in the 1-127 range.

====Video pictures blending====

Module name: '''blend'''

====Video scaling filter====

Module name: '''scale'''

===Subpictures Filters===

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

====Time display sub filter====

Module name: '''time'''

*'''--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.
*'''--time-x <integer>''' X offset from the left in pixels.
*'''--time-y <integer>''' Y offset from the top in pixels.

====Marquee display sub filter====

Module name: '''marq'''

*'''--marq-marquee <string>''' Marquee text to display.
*'''--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====

Module name: '''logo'''

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

*'''--logo-file <string>''' Full path of the PNG file to use.
*'''--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.

==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 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.

===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 [[HotKeys|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'''. 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.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-ncurses-filebrowser.jpg 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 [http://www.mozilla.org/ Mozilla], [http://www.mozilla.org/products/firefox/ Firefox] and [http://www.apple.com/macosx/features/safari Safari].

===Install the plugin===

====GNU/Linux Debian====

Install the ''mozilla-plugin-vlc'' package:

# '''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.

====MacOS X====

''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.

See the [[Documentation:WebPlugin|documentation]] for building page for this plugin.

{{Documentation}}

=Snapshot Tool=
Did you know you can use special codes to automatically generate filenames in the [[SnapshotTool|Snaphot Tool]]?

Documentation:Advanced Use of VLC

2010-08-20T20:32:48Z

Grahack: Added links to HotKeys.

{{RightMenu|documentation play howto toc}}

==Use the command line==

'''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.

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 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.

===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 is available on the [http://www.videolan.org/vlc/features.html 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 OSs 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 [[Documentation:Streaming HowTo|Streaming HowTo]].

===Other Options===

====Audio options====

*'''--noaudio''' disables audio output.
*'''--mono''' forces VLC to treat the stream in mono audio.
*'''--volume <integer>''' sets the level of audio output (between 0 and 1024).
*'''--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====

*'''--novideo''' 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.
*'''--zoom <float>''' adds a zoom factor.
*'''--aspect-ratio <mode>''' forces source aspect ratio. Modes are 4x3, 16x9, ...
*'''--spumargin <integer>''' forces SPU subtitles postion.
*'''--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 http://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.

====Deinterlacing video filter====

Module name: '''deinterlace'''

*'''--deinterlace-mode {discard,blend,mean,bob,linear}''' choose a deinterlacing mode.

====Invert video filter====

Module name: '''invert'''

====Image properties filter====

Module name: '''adjust'''

*'''--contrast <float>''' Image contrast in the 0-2 range.
*'''--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: '''wall'''

This filter splits the output in several windows.

*'''--wall-cols <integer>''' Number of columns.
*'''--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: '''transform'''

*'''--transform-type {90,180,270,hflip,vflip}''' Select rotation angle or symmetry.

====Distort video filter====

Module name: '''distort'''

====Clone video filter====

This filter clones the output window.

Module name: '''clone'''

*'''--clone-count <integer>''' Number of clones.
*'''--clone-vout-list <string>''' Comma separated string of video output modules.

====Crop video filter====

Module name: '''crop'''

*'''--crop-geometry <string>''' Set the geometry of the zone to crop. This is set as <width> x <height> + <left offset> + <top offset>.
*'''--autocrop''' Enable automatic black border cropping.

====Motion blur filter====

Module name: '''motionblur'''

*'''blur-factor <integer>''' Blur factor in the 1-127 range.

====Video pictures blending====

Module name: '''blend'''

====Video scaling filter====

Module name: '''scale'''

===Subpictures Filters===

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

====Time display sub filter====

Module name: '''time'''

*'''--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.
*'''--time-x <integer>''' X offset from the left in pixels.
*'''--time-y <integer>''' Y offset from the top in pixels.

====Marquee display sub filter====

Module name: '''marq'''

*'''--marq-marquee <string>''' Marquee text to display.
*'''--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====

Module name: '''logo'''

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

*'''--logo-file <string>''' Full path of the PNG file to use.
*'''--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.

==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 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.

===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.

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 [[HotKeys|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'''. 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.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-ncurses-filebrowser.jpg 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 [http://www.mozilla.org/ Mozilla], [http://www.mozilla.org/products/firefox/ Firefox] and [http://www.apple.com/macosx/features/safari Safari].

===Install the plugin===

====GNU/Linux Debian====

Install the ''mozilla-plugin-vlc'' package:

# '''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.

====MacOS X====

''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.

See the [[Documentation:WebPlugin|documentation]] for building page for this plugin.

{{Documentation}}

=Snapshot Tool=
Did you know you can use special codes to automatically generate filenames in the [[SnapshotTool|Snaphot Tool]]?

Documentation:Building Lua Playlist Scripts

2010-08-19T14:26:34Z

Grahack: Fixed typo: usefull -> useful

{{RightMenu|documentation play howto toc}}

== Introduction ==

Starting with version 0.9.0, VLC gives you the possible to implement your own playlist loading modules easily. Such modules can do stuff like:
* ''URL translation'': You give it the youtube webpage URL and VLC starts playing the corresponding video;
* ''Text playlist parsing'': You use some custom text playlist format.

Lua playlist scripts shipped with VLC are stored in the following directory:
* C:\Program Files\VideoLAN\VLC\lua\playlist\ on Windows;
* VLC.app/Contents/MacOS/share/lua/playlist/ on Mac OS X;
* /usr/share/vlc/lua/playlist/ on Linux.

You can add your own Lua playlist scripts in this directory or in your VLC's preferences folder "lua/playlist" subdirectory on Windows or Mac OS X and in your local VLC shared data folder on Linux (~/.local/share/vlc/lua/playlist).

== Simple Examples ==

=== URL translation ===

==== What we want to do ====
Lets say that we want VLC to open Google Video links automatically. Google Video pages have URLs like
<nowiki>http://video.google.com/videoplay?docid=-5784010886294950089</nowiki>
to the URL of the corresponding Google Video Playlist file which is
<nowiki>http://video.google.com/videogvp?docid=-5784010886294950089</nowiki>

==== Probe ====
The Lua script is going to be made of 2 functions. The first one is the '''probe()''' function. This function tells VLC if the Lua script should be used (function returns true) or not (function returns false). Here it would look like:
function probe()
if vlc.access ~= "http"
then
return false
end
if string.match( vlc.path, "video.google.com/videoplay" )
then
return true
else
return false
end
end

Lets analyse that function step by step. First we check that VLC is using HTTP. If it isn't (for example it's reading a file off your hard drive or a DVD), we don't want to trigger the Google Video URL translation. The '''vlc''' Lua object provides '''vlc.access''' which should be equal to string '''"http"'''. Then we check that the URL is a Google Video page. This is easily done by trying to find the '''"video.google.com/videoplay"''' string in '''vlc.path'''.

Note that the same function can be written as
function probe()
return vlc.access == "http" and string.match( vlc.path, "video.google.com/videoplay" )
end

==== Parse ====
If the '''probe()''' function returns true, VLC will use the '''parse()''' to ask for the new playlist item(s) which need to be added.
function parse()
item = {}
item.path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" )
item.name = "Some Google video playlist"
return { item }
end

We create a new playlist item (a Lua table). We set the item's path to the appropriate string: 1/ we prepend "http://" since the '''vlc.path''' string doesn't include that part of the original URL and 2/ we replace "videoplay" by "videogvp".

We also set the new playlist item's name to "Some Google video playlist".

We then return the new playlist to VLC (a Lua table which basically represents a list of items).

A shorter version would be:
function parse()
return { { path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" ); name = "Some Google video playlist" } }
end

==== Saving that to a file ====
To make that script available to VLC, simply create a new something.lua file in one of the directories listed in the introduction (You should also remove the googlevideo.lua file shipped with VLC to make sure that it isn't used instead of your new script).

=== Text Playlist Parsing ===

In the previous example we translated a URL to another URL. This new URL redirects VLC to a Google Video Playlist which is basically a text file. This file needs to be read to get the final video's true URL. Here's what such a file would look like if you were to open it with a text editor:
<pre>
# download the free Google Video Player from http://video.google.com/
gvp_version:1.1
url:http://vp.video.google.com/videodownload?version=0&secureurl=uQAAAAznrU3q0BdxTkn_lLSpVJQ4a4JBDFAc5V8lB5OXXPqJ6Dts-Hq5Ll-2dIgeBIDGN1ZAMv65MMP0Zu5cwbIrgAhinWRNl-UtZCU4CgPpnYrR5IwLCk-sEXjs4o89dTT8MQxWcSo3lFPKulC0_TT9L0EW_IyANloBjyoEld5KGkcXdUTtXvj1TmaRh5Yvq4zIfxmYPQ4fehJY6rucnqMQLm8NTD32NvVpSp1bJ06ub_YJgDz4Nic-_qpW0rnFReSyrQ&sigh=zy8gMs8AhAM0Hv3N1PR7djz3m2I&begin=0&len=72640&docid=-5784010886294950089
docid:-5784010886294950089
duration:72640
title:Penguins go for a stroll
description:African penguins caught a breath of fresh air as they were out for a stroll through Tokyo's aquarium. Ikebukuro Sunshine Aquarium offer spectators a chance to get a closer encounter with penguins as they are taken for a walk through the aquariums compound.
description:
description:During the parade the penguins were separated from spectators, mainly children, by portable fences on wheels which were pushed by the zookeepers. The fence ensures they don't run away and also prevents them from biting spectators.
description:
description:"I came up with this idea to let people get a close look at penguins walking." said Keeper Masahiro Tomiyama, adding only penguins born and raised at the aquarium can walk outside their cage without feeling stressed by all the attention.
description:
description:Reuters 16094/06
description:Keywords: animals, cute, sweet, funny, ITN Source.
</pre>

==== Probe ====
The first thing we need to worry about is making sure that the file we're playing is a Google Video Playlist (GVP) file. We could rely on the URL, but that would prevent playing GVP files from our hard drive. Fortunately, the file's contents, especially the "gvp_version:" string seem specific to GVP files. We'll thus try reading a bunch of characters from the begining of the file and look for the "gvp_version:" string.
function probe()
return string.match( vlc.peek( 512 ), "gvp_version:" )
end

The '''vlc.peek(''' ''<number of chars>'' ''')''' function asks VLC to return the first <number of chars> characters. If the string "gvp_version:" isn't found in a file's first 512 characters, we're almost 100% sure that it's not a valid GVP file.

==== Parse ====
We now need to read information from the file to create our new playlist item. A simple version would only fetch the URL:
function parse()
item = {}
while true
do
line = vlc.readline()
if not line
then
break
end
if string.match( line, "^url:" )
then
item.path = string.sub( line, 5 )
end
end
return { item }
end

We read all the file's lines using the '''vlc.readline()''' function. If we encounter the line starting with '''"url:"''' (''string.match( line, "url:" )'' would match lines containing "url:", while ''string.match( line, "^url:" )'' only matches those starting with "url:"), we use that as our new item's path.

If vlc.readline() returns nil, this means that we've finished reading the file so we break out of the while loop and return our new playlist.

This simple '''parse()''' function unfortunately discards all the other usefull meta information available in the GVP file. Lets try to use it:
function parse()
item = {}
while true
do
line = vlc.readline()
if not line
then
break
end
if string.match( line, "^url:" )
then
item.path = string.sub( line, 5 )
elseif string.match( line, "^title:" )
then
item.name = string.sub( line, 7 )
elseif string.match( line, "^duration:" )
then
item.duration = string.sub( line, 10 ) / 1000
elseif string.match( line, "^description:" )
then
if item.description
then
item.description = item.description .. "\n" .. string.sub( line, 13 )
else
item.description = string.sub( line, 13 )
end
end
end
return { item }
end

Getting the video's title works like the URL parameter.
The duration is a bit more tricky. GVP uses times in miliseconds while VLC wants a time in seconds. We thus have to divide it by 1000.
For the description, it works like the URL and title parameters except that a GVP file can have more than one description parameter. If we read more than one parameter we thus concatenate the different description lines.

== Reference ==

Information about the VLC Lua scripts is available in your VLC installation in the lua subdirectory.

* [http://www.videolan.org/developers/vlc/share/lua/README.txt Global VLC Lua README]
* [http://www.videolan.org/developers/vlc/share/lua/playlist/README.txt Playlist script specific README]

== Scripts shipped with VLC ==

Scripts for popular playlist formats and video websites are available in the default VLC installer:
* dailymotion.lua: URL translation for Daily Motion video pages;
* googlevideo.lua: URL translation for Google Video video pages;
* metacafe.lua: URL translation for metacafe video pages and flash player;
* youtube.lua: URL translation for YouTube video pages and flash player (including fullscreen video URLs);
* youtube_hompage.lua: Parse YouTube homepage and browse page.

== Useful links ==
* [http://www.lua.org/manual/5.1/ Lua 5.1 reference manual]
* [http://lua-users.org/wiki/TutorialDirectory Lua tutorials]

Hotkeys table

2010-08-19T14:15:13Z

Grahack: Fixed the category markup.

== Hotkeys table ==

{|
! Command !! Code !! Hotkey
|-
| Fullscreen || key-toggle-fullscreen || f
|-
| Leave fullscreen || key-leave-fullscreen || Esc
|-
| Play/Pause || key-play-pause || Space
|-
| Pause only || key-pause || Unset
|-
| Play only || key-play || Unset
|-
| Faster || key-faster || +
|-
| Slower || key-slower || -
|-
| Normal rate || key-rate-normal || =
|-
| Faster (fine) || key-rate-faster-fine || ]
|-
| Slower (fine) || key-rate-slower-fine || [
|-
| Next || key-next || n
|-
| Previous || key-prev || p
|-
| Stop || key-stop || s
|-
| Position || key-position || t
|-
| Very short backwards jump || key-jump-extrashort || Shift-Left
|-
| Very short forward jump || key-jump+extrashort || Shift-Right
|-
| Short backwards jump || key-jump-short || Alt-Left
|-
| Short forward jump || key-jump+short || Alt-Right
|-
| Medium backwards jump || key-jump-medium || Ctrl-Left
|-
| Medium forward jump || key-jump+medium || Ctrl-Right
|-
| Long backwards jump || key-jump-long || Alt-Ctrl-Left
|-
| Long forward jump || key-jump+long || Alt-Ctrl-Right
|-
| Next frame || key-frame-next || e
|-
| Activate || key-nav-activate || Enter
|-
| Navigate up || key-nav-up || Up
|-
| Navigate down || key-nav-down || Down
|-
| Navigate left || key-nav-left || Left
|-
| Navigate right || key-nav-right || Right
|-
| Go to the DVD menu || key-disc-menu || Shift-m
|-
| Select previous DVD title || key-title-prev || Shift-o
|-
| Select next DVD title || key-title-next || Shift-b
|-
| Select prev DVD chapter || key-chapter-prev || Shift-p
|-
| Select next DVD chapter || key-chapter-next || Shift-n
|-
| Quit || key-quit || Ctrl-q
|-
| Volume up || key-vol-up || Ctrl-Up
|-
| Volume down || key-vol-down || Ctrl-Down
|-
| Mute || key-vol-mute || m
|-
| Subtitle delay up || key-subdelay-up || h
|-
| Subtitle delay down || key-subdelay-down || g
|-
| Audio delay up || key-audiodelay-up || k
|-
| Audio delay down || key-audiodelay-down || j
|-
| Cycle audio track || key-audio-track || b
|-
| Cycle through audio devices || key-audiodevice-cycle || Shift-a
|-
| Cycle subtitle track || key-subtitle-track || v
|-
| Cycle source aspect ratio || key-aspect-ratio || a
|-
| Cycle video crop || key-crop || c
|-
| Toggle autoscaling || key-toggle-autoscale || o
|-
| Increase scale factor || key-incr-scalefactor || Alt-o
|-
| Decrease scale factor || key-decr-scalefactor || Alt-Shift-o
|-
| Cycle deinterlace modes || key-deinterlace || d
|-
| Show interface || key-intf-show || i
|-
| Hide interface || key-intf-hide || Shift-i
|-
| Take video snapshot || key-snapshot || Shift-s
|-
| Go back in browsing history || key-history-back || Shift-g
|-
| Go forward in browsing history || key-history-forward || Shift-h
|-
| Record || key-record || Shift-r
|-
| Dump || key-dump || Shift-d
|-
| Zoom || key-zoom || z
|-
| Un-Zoom || key-unzoom || Shift-z
|-
| Toggle wallpaper mode || key-wallpaper || w
|-
| Display OSD menu on top || key-menu-on || Alt-Shift-m
|-
| Do not display OSD menu || key-menu-off || Alt-Ctrl-m
|-
| Highlight widget on the right || key-menu-right || Alt-Shift-Right
|-
| Highlight widget on the left || key-menu-left || Alt-Shift-Left
|-
| Highlight widget on top || key-menu-up || Alt-Shift-Up
|-
| Highlight widget below || key-menu-down || Alt-Shift-Down
|-
| Select current widget || key-menu-select || Alt-Shift-Enter
|-
| Crop one pixel from the top || key-crop-top || Alt-r
|-
| Uncrop one pixel from the top || key-uncrop-top || Alt-Shift-r
|-
| Crop one pixel from the left || key-crop-left || Alt-d
|-
| Uncrop one pixel from the left || key-uncrop-left || Alt-Shift-d
|-
| Crop one pixel from the bottom || key-crop-bottom || Alt-c
|-
| Uncrop one pixel from the bottom || key-uncrop-bottom || Alt-Shift-c
|-
| Crop one pixel from the right || key-crop-right || Alt-f
|-
| Uncrop one pixel from the right || key-uncrop-right || Alt-Shift-f
|-
| Random || key-random || r
|-
| Normal/Repeat/Loop || key-loop || l
|-
| 1:4 Quarter || key-zoom-quarter || Ctrl-1
|-
| 1:2 Half || key-zoom-half || Ctrl-2
|-
| 1:1 Original || key-zoom-original || Ctrl-3
|-
| 2:1 Double || key-zoom-double || Ctrl-4
|-
| Very short jump length (integer) || extrashort-jump-size || 3
|-
| Set playlist bookmark 1 || key-set-bookmark1 || Ctrl-F1
|-
| Set playlist bookmark 2 || key-set-bookmark2 || Ctrl-F2
|-
| Set playlist bookmark 3 || key-set-bookmark3 || Ctrl-F3
|-
| Set playlist bookmark 4 || key-set-bookmark4 || Ctrl-F4
|-
| Set playlist bookmark 5 || key-set-bookmark5 || Ctrl-F5
|-
| Set playlist bookmark 6 || key-set-bookmark6 || Ctrl-F6
|-
| Set playlist bookmark 7 || key-set-bookmark7 || Ctrl-F7
|-
| Set playlist bookmark 8 || key-set-bookmark8 || Ctrl-F8
|-
| Set playlist bookmark 9 || key-set-bookmark9 || Ctrl-F9
|-
| Set playlist bookmark 10 || key-set-bookmark10 || Ctrl-F10
|-
| Play playlist bookmark 1 || key-play-bookmark1 || F1
|-
| Play playlist bookmark 2 || key-play-bookmark2 || F2
|-
| Play playlist bookmark 3 || key-play-bookmark3 || F3
|-
| Play playlist bookmark 4 || key-play-bookmark4 || F4
|-
| Play playlist bookmark 5 || key-play-bookmark5 || F5
|-
| Play playlist bookmark 6 || key-play-bookmark6 || F6
|-
| Play playlist bookmark 7 || key-play-bookmark7 || F7
|-
| Play playlist bookmark 8 || key-play-bookmark8 || F8
|-
| Play playlist bookmark 9 || key-play-bookmark9 || F9
|-
| Play playlist bookmark 10 || key-play-bookmark10 || F10
|}

[[Category:Interfaces]]

Hotkeys table

2010-08-19T14:12:34Z

Grahack: Creation of the HotKeys page.

Interfaces

2010-08-19T13:44:43Z

Grahack: Added links to HotKeys.

Interfaces are the way you interact with {{VLC}}. Like anything else in VLC, they are modules, which allows for their interchangeability (see below).

== Main interfaces ==
VLC has four main graphical interfaces:
* The [[Qt Interface]] (qt) is the default interface on [[Linux]] and [[Windows]] starting with version 0.9.0.
: Used to be [[wxWidgets Interface]] (wx) before.
* The [[Skins|skins2 Interface]] is an interface where you can customize VLC's look (works on Linux and Windows).
* The [[Mac OS X Interface]] is the default (and only) graphical interface on Mac OS X.
* The [[BeOS Interface]] is the default (and only) graphical interface on BeOS.

== Full list ==
Besides the above main interfaces, VLC contains many more:
{|
|'''qt'''
| Current (>=0.9.0) default [http://www.trolltech.com/qt Qt4] interface on [[Linux]] and [[Windows]].
|-
|'''wx'''
| Previous (<0.9.0) default [http://www.wxwidgets.org/ wxWidgets] interface on [[Linux]] and [[Windows]].
|-
|'''skins2'''
| Load VLC with a [[Skins|skin]]. (Linux and Windows only)
|-
|'''macosx'''
| Default [[Mac OS X]] interface.
|-
|'''beos'''
| Default [[BeOS]] interface.
|-
| '''http'''
| [[Web Interface]], used for controlling VLC from over a network.
|-
| '''gestures'''
| [[Mouse Gestures]], where you can control VLC by moving the mouse
|-
| '''rc''', '''ncurses''', '''telnet'''
| [[Console|Console Interfaces]], non-graphical interfaces.
|-
| '''showintf'''
| Show interfaces module.
|-
| '''hotkeys''' and '''joystick'''
| Control VLC with the keyboard/joystick (see [[HotKeys]]).
|-
| '''dummy'''
| Don't use an interface ([[HotKeys]] still available).
|}

== Listing the available interfaces ==

To get a list of available interfaces, running VLC with the -l option:
vlc -l
This also displays the [[muxers]] and [[encoders]]/[[decoders]] and puts it in a file called "vlc-help.txt". On Linux, run
vlc -l | grep -i interface
to display the interfaces.

== Using an interface ==

To run VLC with a different primary interface, use the following command:
vlc --intf ''name''
You can also use
vlc -I ''name''
You can also change the default in the [[Preferences]].

However, you can also launch more than one interface:
vlc --intf qt --extraintf sap,telnet,http
This will launch VLC with the default QT interface, but will also launch the sap, telnet and web interface in addition to the QT one. The default for this can also be changed in the preferences.

Note that if you only use the dummy interface, you won't be able to tell vlc to quit - you may have to break it manually with Ctrl+C; or use vlc://quit as the last item on the playlist.

== See also ==
* '''See also [[:Category:Interfaces]]'''

[[Category:Interfaces]]