Difference between revisions of "Interfaces"

From VideoLAN Wiki
Jump to navigation Jump to search
m (added missing space)
m (Tweaks)
 
(28 intermediate revisions by 10 users not shown)
Line 1: Line 1:
−
Interfaces are the way you tell VLC what to do. VLC has 4 main Interfaces:
+
{{See also|Category:Interfaces|Category:Control VLC}}
−
* The [[wxWidgets Interface]] (wx) is the default interface on Linux and Windows.
 
−
* The [[Skins|skins2 Interface]] is an interface where you can choose how VLC player looks (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.
 
  
 +
Interfaces are the way you interact with {{VLC}}. Like anything else in VLC, they are modules, which allows for their interchangeability ([[#Using|see below]]).
  
−
The full list of interfaces is
+
== 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 [[macOS Interface]] is the default (and only) graphical interface on [[macOS]].
 +
* 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 [https://www.qt.io/ Qt4] interface on [[Linux]] and [[Windows]].
 +
|-
 
|'''wx'''
 
|'''wx'''
−
| Default [http://www.wxwidgets.org/ wxWidgets] interface on Linux and Windows
+
| Previous (<0.9.0) default [http://www.wxwidgets.org/ wxWidgets] interface on [[Linux]] and [[Windows]].
 
|-
 
|-
 
|'''skins2'''
 
|'''skins2'''
−
| Load VLC with a [[Skins|skin]]. (Linux and Windows only)
+
| Load VLC with a [[skin]]. (Linux and Windows only)
 
|-
 
|-
 
|'''macosx'''
 
|'''macosx'''
−
| Default Mac OS X interface
+
| Default [[Mac OS X]] interface.
 +
|-
 +
|'''minimal_macosx'''
 +
| Minimal [[Mac OS X]] interface.
 
|-
 
|-
 
|'''beos'''
 
|'''beos'''
−
| Default BeOS interface
+
| Default [[BeOS]] interface.
 
|-
 
|-
 
| '''http'''
 
| '''http'''
−
| [[Web Interface]], used for controlling VLC from over a network
+
| [[Web Interface]], used for controlling VLC from over a network.
 
|-
 
|-
 
| '''gestures'''
 
| '''gestures'''
−
| [[Mouse Gestures]], where you can control vlc by moving the mouse
+
| [[Mouse Gestures]], where you can control VLC by moving the mouse
 
|-
 
|-
 
| '''rc''', '''ncurses''', '''telnet'''
 
| '''rc''', '''ncurses''', '''telnet'''
−
| [[Console|Console Interfaces]], a non-graphical interface.
+
| [[Console|Console Interfaces]], non-graphical interfaces.
 
|-
 
|-
 
| '''showintf'''
 
| '''showintf'''
−
| Show Intefaces module
+
| Show interfaces module.
 
|-
 
|-
 
| '''hotkeys''' and '''joystick'''
 
| '''hotkeys''' and '''joystick'''
−
| Control VLC with the keyboard/joystick
+
| Control VLC with the keyboard/joystick (see [[HotKeys]]).
 
|-
 
|-
 
| '''dummy'''
 
| '''dummy'''
−
| Don't use an interface
+
| Don't use an interface ([[HotKeys]] still available).
 
|}
 
|}
  
−
There are some other interfaces, you can view the list by running VLC with the -l option:
+
== Listing the available interfaces ==
−
  vlc -l
+
 
−
This also displays the [[muxers]] and [[encoders]]/[[decoders]]. On linux, run
+
To get a list of available interfaces, running VLC with the <code>-l</code> option:
−
  vlc -l | grep -i interface
+
  {{%}} vlc -l
 +
This also displays the [[muxers]] and [[encoders]]/[[decoders]] and puts it in a file called <code>vlc-help.txt</code>. On Linux, run
 +
  {{%}} vlc -l | grep -iF interface
 
to display the interfaces.
 
to display the interfaces.
 +
 +
== <span id="Using"></span> Using an interface ==
  
 
To run VLC with a different primary interface, use the following command:
 
To run VLC with a different primary interface, use the following command:
−
  vlc --intf ''name''
+
  {{%}} vlc --intf ''name''
 
You can also use
 
You can also use
−
  vlc -I ''name''
+
  {{%}} vlc -I ''name''
 
You can also change the default in the [[Preferences]].
 
You can also change the default in the [[Preferences]].
  
−
However you can also launch more than one interface:
+
However, you can also launch more than one interface:
−
  vlc --intf wx --extraintf sap,telnet,http
+
  {{%}} vlc --intf qt --extraintf sap,telnet,http
−
This will launch VLC with the default wxWidgets interface, but will also launch the sap, telnet and web interface in addition to the wxWidgets one. The default for this can also be changed in the Preferences.
+
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 <kbd>Ctrl+C</kbd>; or use <code>vlc://quit</code> as the last item on the playlist.
  
−
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.
+
[[Category:Control VLC|*]]
 +
[[Category:Interfaces|*]]

Latest revision as of 18:15, 6 March 2019

See also: Category:Interfaces and Category:Control VLC

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

Main interfaces

VLC has four main graphical interfaces:

Used to be wxWidgets Interface (wx) before.

Full list

Besides the above main interfaces, VLC contains many more:

qt Current (>=0.9.0) default Qt4 interface on Linux and Windows.
wx Previous (<0.9.0) default wxWidgets interface on Linux and Windows.
skins2 Load VLC with a skin. (Linux and Windows only)
macosx Default Mac OS X interface.
minimal_macosx Minimal 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 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 -iF 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.

Retrieved from "https://wiki.videolan.org/index.php?title=Interfaces&oldid=59042"