VideoLAN Wiki - User contributions [en]

ActiveX/HTML

2007-04-18T15:21:13Z

Hogi: New Infos how to solve the Problem. Is clsid:E23FE9C6-778E-49D4-B537-38FCDE4887D8 outdated?

{{howto| use the [[ActiveX]] control within a webpage}}

==Embedding Activex using Javascript==

You can insert the [[ActiveX]] control in your HTML pages like this :

Attention, this ClassID seems outdated! --[[User:Hogi|Hogi]] 17:21, 18 April 2007 (CEST)
<OBJECT classid="clsid:E23FE9C6-778E-49D4-B537-38FCDE4887D8"
codebase="http://downloads.videolan.org/pub/videolan/vlc/latest/win32/axvlc.cab"
width="640" height="480" id="vlc" events="True">
<param name="Src" value="" />
<param name="ShowDisplay" value="True" />
<param name="AutoLoop" value="False" />
<param name="AutoPlay" value="False" />
</OBJECT>

The Sourcecode above doesn't work always, exspecially with Windows 2000 and Internet Explorer 6. That's why you'd better use this code:

<OBJECT classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921"
codebase="http://downloads.videolan.org/pub/videolan/vlc/latest/win32/axvlc.cab#Version=0,8,6,0"
width="640" height="480" id="vlc" events="True">
<param name="Src" value="" />
<param name="ShowDisplay" value="True" />
<param name="AutoLoop" value="False" />
<param name="AutoPlay" value="False" />
</OBJECT>

Then, using Javascript, you can select another source, or change the audio track :

document.vlc.playlistClear();
var options=[":audio-track=5"]; // select audio track 5 (=6th, 1st is 0)
document.vlc.addTarget("...",options,2,0); // replace entry 0
document.vlc.play();

See http://people.videolan.org/~damienf/plugin-0.8.6.html for a complete demo.

==Embedding ActiveX using m3u Playlists==
Maybe a better to show VLC in an HTML Website is to use m3u Playlists. It has got the advantage that users with turned-off Javascript can also use this plugin, since document.vlc.addTarget won't work with javascript turned off.

* Step 1: Create the HTML website with the VLC-Object linked to the m3u playlist
* Step 2: Create your m3u playlist with all options, save and upload it to your webspace.
* Step 3 (optional): Create buttons and other objects to control VLC (like document.vlc.play();)

'''Step 1: Creating the website to embed ActiveX Control'''
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
<HTML>
<BODY marginwidth="0" marginheight="0" topmargin="0" leftmargin="0">
<OBJECT classid="clsid:E23FE9C6-778E-49D4-B537-38FCDE4887D8"
codebase="http://downloads.videolan.org/pub/videolan/vlc/latest/win32/axvlc.cab"
width="400" height="300" id="vlc" events="True">
<param name="Src" value="myplaylist.m3u" />
<param name="ShowDisplay" value="True" />
<param name="AutoLoop" value="True" />
<param name="AutoPlay" value="True" />
<param name="Volume" value="100">
</OBJECT>
</BODY>
</HTML>
You should modify the values of width, height and volume (0-100) fitting to your desires. If you don't know them, simply delete them (e.g. remove ''width="640"'' from the code).

'''Step 2: Creating the m3u playlist'''

Open Notepad, create your playlist and save it as 'myplaylist.m3u' for this example.
#EXTM3U // Required to identify this file as m3u file
#EXTVLCOPT--input-repeat=-1 // repeat the following file/playlist
#EXTVLCOPT--http-reconnect=true // required for a streaming-client to enable repeat
#EXTVLCOPT--any further parameter goes here // see also [[VLC command-line help]]
#EXTINF:0, Test Description // set the title for the following file shown in your playlist
video.mpg // the actual file to be displayed

'''Annotations:'''
* For actual looping of the entire playlist, the user has to have check 'Repeat all' under Preferences --> Playlist --> General
* Mind that options have different names if you play a file locally or if you want to stream it (--sub-filter --> --s-filter)

'''Mind the different Options-styles:'''
--option A global option that is set for the duration of the program.
-option A single letter version of a global --option.
:option An option that only applies to the playlistitem directly before it
and that overrides previous settings.

==Known Problems and how to solve them==

'''Problem'''

A know problem is, that the VLC-Plugin won't be displayed. Instead, you are asked whether you want to install the VLC-ActiveX-Component. "Don't install" cancels the installation and nothing happens. "Install" runs the usual VLC-Setup (mind to install the ActiveX-Plugin), but after reopening an HTML-page with the VLC-Plugin, it's the same situation as before.

'''Solution'''

* Use the "other" ClassID in your HTML-Source as shown above:
<OBJECT classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921" ...

* You have to lower the security settings on your PC. '''Do this at your own risk! Use [http://www.getfirefox.com Firefox] to browse the web!'''

* In Internet Explorer select [Tools], [Internet Options]. The "Internet Options" window opens. Select the Tab "Advanced". Scroll down until you see the main point "Security".

* Check the following entries:
** Allow active content to CDs to run on My Computer
** Allow active content to run in files on My Computer
** Allow software to run or install even if the signature is invalid

* Instead of lowering security level, you can add the website address to the right security area.

==See also==
* [[ActiveX/Delphi|Delphi Implementation]]
* [[ActiveX|ActiveX Description]]

[[Category:Embedded]]

ActiveX/HTML

2007-04-18T15:15:15Z

Hogi: /* Embedding Activex using Javascript */ ClassID changed for ActiveX

{{howto| use the [[ActiveX]] control within a webpage}}

==Embedding Activex using Javascript==

You can insert the [[ActiveX]] control in your HTML pages like this :

<OBJECT classid="clsid:E23FE9C6-778E-49D4-B537-38FCDE4887D8"
codebase="http://downloads.videolan.org/pub/videolan/vlc/latest/win32/axvlc.cab"
width="640" height="480" id="vlc" events="True">
<param name="Src" value="" />
<param name="ShowDisplay" value="True" />
<param name="AutoLoop" value="False" />
<param name="AutoPlay" value="False" />
</OBJECT>

The Sourcecode above doesn't work always, exspecially with Windows 2000 and Internet Explorer 6. That's why you'd better use this code:

<OBJECT classid="clsid:9BE31822-FDAD-461B-AD51-BE1D1C159921"
codebase="http://downloads.videolan.org/pub/videolan/vlc/latest/win32/axvlc.cab#Version=0,8,6,0"
width="640" height="480" id="vlc" events="True">
<param name="Src" value="" />
<param name="ShowDisplay" value="True" />
<param name="AutoLoop" value="False" />
<param name="AutoPlay" value="False" />
</OBJECT>

Then, using Javascript, you can select another source, or change the audio track :

document.vlc.playlistClear();
var options=[":audio-track=5"]; // select audio track 5 (=6th, 1st is 0)
document.vlc.addTarget("...",options,2,0); // replace entry 0
document.vlc.play();

See http://people.videolan.org/~damienf/plugin-0.8.6.html for a complete demo.

==Embedding ActiveX using m3u Playlists==
Maybe a better to show VLC in an HTML Website is to use m3u Playlists. It has got the advantage that users with turned-off Javascript can also use this plugin, since document.vlc.addTarget won't work with javascript turned off.

* Step 1: Create the HTML website with the VLC-Object linked to the m3u playlist
* Step 2: Create your m3u playlist with all options, save and upload it to your webspace.
* Step 3 (optional): Create buttons and other objects to control VLC (like document.vlc.play();)

'''Step 1: Creating the website to embed ActiveX Control'''
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
<HTML>
<BODY marginwidth="0" marginheight="0" topmargin="0" leftmargin="0">
<OBJECT classid="clsid:E23FE9C6-778E-49D4-B537-38FCDE4887D8"
codebase="http://downloads.videolan.org/pub/videolan/vlc/latest/win32/axvlc.cab"
width="400" height="300" id="vlc" events="True">
<param name="Src" value="myplaylist.m3u" />
<param name="ShowDisplay" value="True" />
<param name="AutoLoop" value="True" />
<param name="AutoPlay" value="True" />
<param name="Volume" value="100">
</OBJECT>
</BODY>
</HTML>
You should modify the values of width, height and volume (0-100) fitting to your desires. If you don't know them, simply delete them (e.g. remove ''width="640"'' from the code).

'''Step 2: Creating the m3u playlist'''

Open Notepad, create your playlist and save it as 'myplaylist.m3u' for this example.
#EXTM3U // Required to identify this file as m3u file
#EXTVLCOPT--input-repeat=-1 // repeat the following file/playlist
#EXTVLCOPT--http-reconnect=true // required for a streaming-client to enable repeat
#EXTVLCOPT--any further parameter goes here // see also [[VLC command-line help]]
#EXTINF:0, Test Description // set the title for the following file shown in your playlist
video.mpg // the actual file to be displayed

'''Annotations:'''
* For actual looping of the entire playlist, the user has to have check 'Repeat all' under Preferences --> Playlist --> General
* Mind that options have different names if you play a file locally or if you want to stream it (--sub-filter --> --s-filter)

'''Mind the different Options-styles:'''
--option A global option that is set for the duration of the program.
-option A single letter version of a global --option.
:option An option that only applies to the playlistitem directly before it
and that overrides previous settings.

==Known Problems and how to solve them==

'''Problem'''

A know problem is, that the VLC-Plugin won't be displayed. Instead, you are asked whether you want to install the VLC-ActiveX-Component. "Don't install" cancels the installation and nothing happens. "Install" runs the usual VLC-Setup (mind to install the ActiveX-Plugin), but after reopening an HTML-page with the VLC-Plugin, it's the same situation as before.

'''Solution'''

You have to lower the security settings on your PC. '''Do this at your own risk! Use [http://www.getfirefox.com Firefox] to browse the web!'''

In Internet Explorer select [Tools], [Internet Options]. The "Internet Options" window opens. Select the Tab "Advanced". Scroll down until you see the main point "Security".

Check the following entries:
* Allow active content to CDs to run on My Computer
* Allow active content to run in files on My Computer
* Allow software to run or install even if the signature is invalid

'''Solution 2'''
Instead of lowering security level, you can add the website address to the right security area.

==See also==
* [[ActiveX/Delphi|Delphi Implementation]]
* [[ActiveX|ActiveX Description]]

[[Category:Embedded]]

Talk:ActiveX/Delphi

2007-02-08T23:01:52Z

Hogi: How to stream with Delphi

== Thanks to the article's author ==

I would like to extend my deepest thanks to the author of this article for simplifying the process of integrating VLC into the Delphi mainstream.

I find the tips in this article most helpful, and love the VideoLAN system immensley.

Simon

== To author: ==

Thank you for your time and effort. Would it be too much to ask you to give us guidelines how to stream files using Delphi and ActiveX component?
: ''(unsigned by [[Derran]])''

You can start streaming any time by modifying the MRL.
VLCPlugin1.addTarget('C:\video.mpg', null, VLCPlayListInsert, 0);
// you can use any MRL with parameters instead of 'c:\video.mpg' here

See http://www.videolan.org/doc/streaming-howto/en/streaming-howto-en.html to create the MRL fitting to your desires.

You can also create a playliste-file (like .m3u) and embedd the streaming parameters to this file.
--[[User:Hogi|Hogi]] 00:01, 9 February 2007 (CET)

== VLC and Delphi ==

Delphi can also use the [[ExternalAPI]] like in [http://tothpaul.free.fr/sources.php?dprgrp.vld VideoLAN for Delphi] :D

{ val:TValue }
val.AsInteger := IntToStr(Panel1.Width);
VLCLib.VLC_VariableSet('conf::width',val);
val.AsInteger := inttostr(Panel1.Height);
VLCLib.VLC_VariableSet('conf::height',val);

== Controlling the size and client panel ==

The ActiveX runs like a champ, but it wants to create its own window to display. I need it to show on a panel (or anything else to set size and position) within an application. I was able to set the size by:
val := inttostr(Panel1.Width);
VLCPlugin1.setVariable('conf::width',val);
val := inttostr(Panel1.Height);
VLCPlugin1.setVariable('conf::height',val);

But this results in no display:
val := inttostr(Panel1.Handle);
VLCPlugin1.setVariable('drawable',val);

You can hear the sound when you continue with:
VLCPlugin1.addTarget(OpenDialog.FileName, null, $1, 0);
VLCPlugin1.play;

The 'drawable' variable is evidently not right, but it doesn't kick a compile error.
What is the correct variable? Or is there a whole different way I should be doing this?
Thanks.

ActiveX/HTML

2006-05-28T16:09:50Z

Hogi: Solution for ActiveX-Problem concerning Internet Explorer

==Embedding Activex using Javascript==

You can insert the [[ActiveX]] control in your HTML pages like this :

<OBJECT classid="clsid:E23FE9C6-778E-49D4-B537-38FCDE4887D8"
codebase="http://downloads.videolan.org/pub/videolan/vlc/latest/win32/axvlc.cab"
width="640" height="480" id="vlc" events="True">
<param name="Src" value="" />
<param name="ShowDisplay" value="True" />
<param name="AutoLoop" value="False" />
<param name="AutoPlay" value="False" />
</OBJECT>

Then, using Javascript, you can select another source, or change the audio track :

document.vlc.playlistClear();
var options=[":audio-track=5"]; // select audio track 5 (=6th, 1st is 0)
document.vlc.addTarget("...",options,2,0); // replace entry 0
document.vlc.play();

==Embedding ActiveX using m3u Playlists==
Maybe a better to show VLC in an HTML Website is to use m3u Playlists. It has got the advantage that users with turned-off Javascript can also use this plugin, since document.vlc.addTarget won't work with javascript turned off.

* Step 1: Create the HTML website with the VLC-Object linked to the m3u playlist
* Step 2: Create your m3u playlist with all options, save and upload it to your webspace.
* Step 3 (optional): Create buttons and other objects to control VLC (like document.vlc.play();)

'''Step 1: Creating the website to embed ActiveX Control'''
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
<HTML>
<BODY marginwidth="0" marginheight="0" topmargin="0" leftmargin="0">
<OBJECT classid="clsid:E23FE9C6-778E-49D4-B537-38FCDE4887D8"
codebase="http://downloads.videolan.org/pub/videolan/vlc/latest/win32/axvlc.cab"
width="400" height="300" id="vlc" events="True">
<param name="Src" value="myplaylist.m3u" />
<param name="ShowDisplay" value="True" />
<param name="AutoLoop" value="True" />
<param name="AutoPlay" value="True" />
<param name="Volume" value="100">
</OBJECT>
</BODY>
</HTML>
You should modify the values of width, height and volume (0-100) fitting to your desires. If you don't know them, simply delete them (e.g. remove ''width="640"'' from the code).

'''Step 2: Creating the m3u playlist'''

Open Notepad, create your playlist and save it as 'myplaylist.m3u' for this example.
#EXTM3U // Required to identify this file as m3u file
#EXTVLCOPT--input-repeat=-1 // repeat the following file/playlist
#EXTVLCOPT--http-reconnect=true // required for a streaming-client to enable repeat
#EXTVLCOPT--any further parameter goes here // see also [[VLC command-line help]]
#EXTINF:0, Test Description // set the title for the following file shown in your playlist
video.mpg // the actual file to be displayed

'''Annotations:'''
* For actual looping of the entire playlist, the user has to have check 'Repeat all' under Preferences --> Playlist --> General
* Mind that options have different names if you play a file locally or if you want to stream it (--sub-filter --> --s-filter)

'''Mind the different Options-styles:'''
--option A global option that is set for the duration of the program.
-option A single letter version of a global --option.
:option An option that only applies to the playlistitem directly before it
and that overrides previous settings.

==Known Problems and how to solve them==

'''Problem'''

A know problem is, that the VLC-Plugin won't be displayed. Instead, you are ask whether you want to install the VLC-ActiveX-Component. "Don't install" cancels the installation and nothing happens. "Install" runs the usual VLC-Setup (mind to install the ActiveX-Plugin), but after reopening an HTML-page with the VLC-Plugin, it's the same situation as before.

'''Solution'''

You have to lower the security settings on your PC. '''Do this at your own risk! Use [http://www.getfirefox.com Firefox] to browse the web!'''

In Internet Explorer select [Tools], [Internet Options]. The "Internet Options" window opens. Select the Tab "Advanced". Scroll down until you see the main point "Security".

Check the following entries:
* Allow active content to CDs to run on My Computer
* Allow active content to run in files on My Computer
* Allow software to run or install even if the signature is invalid
--[[User:Hogi|Hogi]] 18:09, 28 May 2006 (CEST)

==See also==
* [[ActiveX/Delphi|Delphi Implementation]]

* [[ActiveX|ActiveX Description]]

VLC command-line help

2006-05-22T13:26:52Z

Hogi: start-time=<integer>

As you may have noticed, the command ''vlc --help'' is not very useful due to to the non-scrollable pop-up window that opened.

If you look for help, on a particular module, use ''vlc -p module --advanced''

So here's the output of ''vlc --longhelp --advanced --help-verbose'' for the 0.8.5-test1 (2006/03/27) version in Windows.

<nowiki>
Usage: vlc.exe [options] [playlistitems] ...
You can specify multiple playlistitems on the commandline. They will be enqueued in the playlist.
The first item specified will be played first.

Options-styles:
--option A global option that is set for the duration of the program.
-option A single letter version of a global --option.
:option An option that only applies to the playlistitem directly before it
and that overrides previous settings.

Playlistitem MRL syntax:
[[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]

Many of the global --options can also be used as MRL specific :options.
Multiple :option=value pairs can be specified.

URL syntax:
[file://]filename Plain media file
http://ip:port/file HTTP URL
ftp://ip:port/file FTP URL
mms://ip:port/file MMS URL
screen:// Screen capture
[dvd://][device][@raw_device] DVD device
[vcd://][device] VCD device
[cdda://][device] Audio CD device
udp:[[<source address>]@[<bind address>][:<bind port>]]
UDP stream sent by a streaming server
vlc:pause:<seconds> Special item to pause the playlist for a certain time
vlc:quit Special item to quit VLC

Help options
-h, --help Afficher l’aide de VLC (peut être combiné
avec --advanced)
-H, --longhelp Afficher l’aide de VLC et de ses modules
(peut être combiné avec --advanced)
--advanced Afficher l’aide pour les options avancées
--help-verbose Afficher plus de détails dans l’aide
-l, --list Affiche la liste des modules disponibles
-p, --module <string> Afficher l’aide d'un module spécifique
(peut être combiné avec --advanced)
--save-config Enregistre les options de la ligne de
commande actuelle dans la configuration
--reset-config Remet à zéro la configuration
--config <string> Utilise un autre fichier de configuration
--reset-plugins-cache Remet à zéro le cache des modules
--version Affiche le numéro de version

Audio
--audio, --no-audio Enable audio (default enabled)
You can completely disable the audio output.
In this case, the audio decoding stage will
not take place, thus saving some processing
power. (default enabled)
--volume <integer> Default audio volume
You can set the default audio output volume
here, in a range from 0 to 1024.
--spdif, --no-spdif Use the S/PDIF audio output when available
(default disabled)
This option allows you to use the S/PDIF
audio output by default when your hardware
supports it as well as the audio stream being
played. (default disabled)
--force-dolby-surround {0 (Auto), 1 (On), 2 (Off)}
Force detection of Dolby Surround
Use this when you know your stream is (or is
not) encoded with Dolby Surround but fails to
be detected as such. And even if the stream
is not actually encoded with Dolby Surround,
turning on this option might enhance your
experience, especially when combined with the
Headphone Channel Mixer.
--audio-filter <string> Audio filters
This allows you to add audio post processing
filters, to modify the sound
--audio-visual <string> Audio visualizations
This allows you to add visualization modules
(spectrum analyzer, etc.).

Video
-f, --fullscreen, --no-fullscreen
Fullscreen video output (default disabled)
If this option is enabled, VLC will always
start a video in fullscreen mode. (default
disabled)
--overlay, --no-overlay Overlay video output (default enabled)
If enabled, VLC will try to take advantage of
the overlay capabilities of your graphics
card (hardware acceleration). (default
enabled)
--video-on-top, --no-video-on-top
Always on top (default disabled)
Always place the video window on top of other
windows. (default disabled)
--snapshot-path <string> Video snapshot directory
Allows you to specify the directory where the
video snapshots will be stored.
--snapshot-format {png,jpg}
Video snapshot format
Allows you to specify the image format in
which the video snapshots will be stored.
--snapshot-preview, --no-snapshot-preview
Display video snapshot preview (default
enabled)
Enable / disable displaying the snapshot
preview in the screen's to left corner.
(default enabled)
--crop <string> Video cropping
This will force the cropping of the source
video. Accepted formats are x:y (4:3, 16:9,
etc.) expressing the global image aspect.
--aspect-ratio <string> Source aspect ratio
This will force the source aspect ratio. For
instance, some DVDs claim to be 16:9 while
they are actually 4:3. This can also be used
as a hint for VLC when a movie does not have
aspect ratio information. Accepted formats
are x:y (4:3, 16:9, etc.) expressing the
global image aspect, or a float value (1.25,
1.3333, etc.) expressing pixel squareness.
--vout-filter <string> Video filter module
This will allow you to add a post-processing
filter to enhance the picture quality, for
instance deinterlacing, or to clone or
distort the video window.

Subpictures
--osd, --no-osd On Screen Display (default enabled)
VLC can display messages on the video. This
is called OSD (On Screen Display). You can
disable this feature here. (default enabled)
--sub-file <string> Use subtitle file
Load this subtitle file. To be used when
autodetect cannot detect your subtitle file.
--sub-autodetect-file, --no-sub-autodetect-file
Autodetect subtitle files (default enabled)
Automatically detect a subtitle file, if no
subtitle filename is specified. (default
enabled)
--sub-filter <string> Subpictures filter module
This will allow you to add a subpictures
filter for instance to overlay a logo.
--audio-language <string> Audio language
Give the language of the audio track you want
to use (comma separted, two or three letter
country code).
--sub-language <string> Subtitle language
Give the language of the subtitle track you
want to use (comma separted, two or tree
letter country code).
--input-repeat <integer> Input repetitions
Number of time the same input will be repeated
--dvd <string> DVD device
This is the default DVD drive (or file) to
use. Don't forget the colon after the drive
letter (eg. D:)
--vcd <string> VCD device
This is the default VCD device to use.
--cd-audio <string> Audio CD device
This is the default Audio CD device to use.
--server-port <integer> UDP port
This is the port used for UDP streams. 1234
by default.
-6, --ipv6, --no-ipv6 Force IPv6 (default disabled)
If you check this box, IPv6 will be used by
default for all UDP and HTTP connections.
(default disabled)
-4, --ipv4, --no-ipv4 Force IPv4 (default disabled)
If you check this box, IPv4 will be used by
default for all UDP and HTTP connections.
(default disabled)

Input
--access-filter <string> Access filter module
This is a legacy entry to let you configure
access filter modules.
--high-priority, --no-high-priority
Increase the priority of the process (default
disabled)
Increasing the priority of the process will
very likely improve your playing experience
as it allows VLC not to be disturbed by other
applications that could otherwise take too
much processor time. However be advised that
in certain circumstances (bugs) VLC could
take all the processor time and render the
whole system unresponsive which might require
a reboot of your machine. (default disabled)

Playlist
-Z, --random, --no-random Play files randomly forever (default disabled)
When selected, VLC will randomly play files
in the playlist until interrupted. (default
disabled)
-L, --loop, --no-loop Repeat all (default disabled)
If you want VLC to keep playing the playlist
indefinitely then enable this option.
(default disabled)
-R, --repeat, --no-repeat Repeat current item (default disabled)
When this is active, VLC will keep playing
the current playlist item over and over
again. (default disabled)
--play-and-stop, --no-play-and-stop
Play and stop (default disabled)
Stop the playlist after each played playlist
item. (default disabled)
--open <string> Default stream
This option allows you to always open a
default stream on start-up.
--auto-preparse, --no-auto-preparse
Automatically preparse files (default enabled)
This option enables automatic preparsing of
files added to the playlist (to retrieve some
metadata). (default enabled)
-S, --services-discovery <string>
Services discovery modules
Specifies the services discovery modules to
load, separated by semi-colons. Typical
values are sap, hal, ...
--extraintf <string> Extra interface modules
This option allows you to select additional
interfaces used by VLC. They will be launched
in the background in addition to the default
interface. Use a comma separated list of
interface modules. (common values are logger,
gestures, sap, rc, http or screensaver)
-v, --verbose <integer> Verbosity (0,1,2)
This option sets the verbosity level (0=only
errors and standard messages, 1=warnings,
2=debug).
--language {auto,en,en_GB,ca,da,de,es,fr,it,ja,ka,ko,nl,oc,pt_BR,ro,ru,tr,zh_CN,zh_TW}
Language
This option allows you to set the language of
the interface. The system language is
auto-detected if "auto" is specified here.
--advanced, --no-advanced Show advanced options (default enabled)
When this option is turned on, the
preferences and/or interfaces will show all
the available options, including those that
most users should never touch. (default
enabled)
--show-intf, --no-show-intf
Show interface with mouse (default disabled)
If this enabled, the interface will be shown
when you move the mouse to the edge of the
screen in fullscreen mode. (default disabled)
-I, --intf <string> Interface module
This option allows you to select the
interface used by VLC. The default behavior
is to automatically select the best module
available.
--control <string> Control interfaces
This option allows you to select control
interfaces.
-start-time=<integer>
This option allows you to select the
start-time of your file. The parameter
has to be in seconds.

Hot keys
--key-fullscreen <integer> Fullscreen
Select the hotkey to use to swap fullscreen
state.
--key-play-pause <integer> Play/Pause
Select the hotkey to use to swap paused state.
--key-faster <integer> Faster
Select the hotkey to use for fast forward
playback.
--key-slower <integer> Slower
Select the hotkey to use for slow motion
playback.
--key-next <integer> Next
Select the hotkey to use to skip to the next
item in the playlist.
--key-prev <integer> Previous
Select the hotkey to use to skip to the
previous item in the playlist.
--key-stop <integer> Stop
Select the hotkey to stop the playback.
--key-jump-extrashort <integer>
Very short backwards jump
Select the hotkey to make a very short
backwards jump.
--key-jump+extrashort <integer>
Very short forward jump
Select the hotkey to make a very short
forward jump.
--key-jump-short <integer> Short backwards jump
Select the hotkey to make a short backwards
jump.
--key-jump+short <integer> Short forward jump
Select the hotkey to make a short forward
jump.
--key-jump-medium <integer>
Medium backwards jump
Select the hotkey to make a medium backwards
jump.
--key-jump+medium <integer>
Medium forward jump
Select the hotkey to make a medium forward
jump.
--key-jump-long <integer> Long backwards jump
Select the hotkey to make a long backwards
jump.
--key-jump+long <integer> Long forward jump
Select the hotkey to make a long forward jump.
--key-quit <integer> Quit
Select the hotkey to quit the application.
--key-vol-up <integer> Volume up
Select the key to increase audio volume.
--key-vol-down <integer> Volume down
Select the key to decrease audio volume.
--key-vol-mute <integer> Mute
Select the key to turn off audio volume.
--key-audio-track <integer>
Cycle audio track
Cycle through the available audio
tracks(languages)
--key-subtitle-track <integer>
Cycle subtitle track
Cycle through the available subtitle tracks
--key-aspect-ratio <integer>
Cycle source aspect ratio
Cycle through a predefined list of source
aspect ratios
--key-crop <integer> Cycle video crop
Cycle through a predefined list of crop
formats
--key-deinterlace <integer>
Cycle deinterlace modes
Cycle through all the deinterlace modes
--extrashort-jump-size <integer>
Very short jump size
Very short jump "size", in seconds
--short-jump-size <integer>
Short jump size
Short jump "size", in seconds
--medium-jump-size <integer>
Medium jump size
Medium jump "size", in seconds
--long-jump-size <integer> Long jump size
Long jump "size", in seconds
--bookmark1 <string> Playlist bookmark 1
This option allows you to define playlist
bookmarks.
--bookmark2 <string> Playlist bookmark 2
This option allows you to define playlist
bookmarks.
--bookmark3 <string> Playlist bookmark 3
This option allows you to define playlist
bookmarks.
--bookmark4 <string> Playlist bookmark 4
This option allows you to define playlist
bookmarks.
--bookmark5 <string> Playlist bookmark 5
This option allows you to define playlist
bookmarks.
--bookmark6 <string> Playlist bookmark 6
This option allows you to define playlist
bookmarks.
--bookmark7 <string> Playlist bookmark 7
This option allows you to define playlist
bookmarks.
--bookmark8 <string> Playlist bookmark 8
This option allows you to define playlist
bookmarks.
--bookmark9 <string> Playlist bookmark 9
This option allows you to define playlist
bookmarks.
--bookmark10 <string> Playlist bookmark 10
This option allows you to define playlist
bookmarks.

ffmpeg audio/video decoder/encoder ((MS)MPEG4,SVQ1,H263,WMV,WMA)
--ffmpeg-workaround-bugs <integer>
Workaround bugs
Try to fix some bugs
1 autodetect
2 old
msmpeg4
4 xvid interlaced
8 ump4
16 no
padding
32 ac vlc
64 Qpel chroma
--ffmpeg-hurry-up, --no-ffmpeg-hurry-up
Hurry up (default disabled)
Allow the decoder to partially decode or skip
frame(s) when there is not enough time. It's
useful with low CPU power but it can produce
distorted pictures. (default disabled)
--ffmpeg-pp-q <integer> Post processing quality
Quality of post processing. Valid range is 0
to 6
Higher levels require considerable more
CPU power, but produce better looking
pictures.
--sout-ffmpeg-hq {rd,bits,simple}
Quality level
Allows you to specify the quality level for
the encoding of motions vectors (this can
slow down the encoding very much).
--sout-ffmpeg-keyint <integer>
Ratio of key frames
Allows you to specify the number of frames
that will be coded for one key frame.
--sout-ffmpeg-bframes <integer>
Ratio of B frames
Allows you to specify the number of B frames
that will be coded between two reference
frames.
--sout-ffmpeg-hurry-up, --no-sout-ffmpeg-hurry-up
Hurry up (default disabled)
Allows you to specify if the encoder should
make on-the-fly quality tradeoffs if your CPU
can't keep up with the encoding rate. It will
disable trellis quantization, then the rate
distortion of motion vectors (hq), and raise
the noise reduction threshold to ease the
encoder's task. (default disabled)

MPEG2 video switcher stream output
--sout-switcher-files <string>
Files
Full paths of the files separated by colons.
--sout-switcher-sizes <string>
Sizes
List of sizes separated by colons
(720x576:480x576).
--sout-switcher-aspect-ratio <string>
Aspect ratio
Aspect ratio (4:3, 16:9).

ATSC A/52 (AC-3) audio decoder
--a52-dynrng, --no-a52-dynrng
A/52 dynamic range compression (default
enabled)
Dynamic range compression makes the loud
sounds softer, and the soft sounds louder, so
you can more easily listen to the stream in a
noisy environment without disturbing anyone.
If you disable the dynamic range compression
the playback will be more adapted to a movie
theater or a listening room. (default enabled)

Standard filesystem directory input
--recursive {none,collapse,expand}
Subdirectory behavior
Select whether subdirectories must be
expanded.
none: subdirectories do not appear
in the playlist.
collapse: subdirectories
appear but are expanded on first
play.
expand: all subdirectories are
expanded.

--ignore-filetypes <string>
Ignore files with these extensions
Specify a comma seperated list of file
extensions. Files with these extensions will
not be added to playlist when opening a
directory. This is useful if you add
directories that contain mp3 albums for
instance.

Timeshift
--timeshift-dir <string> Timeshift directory
Directory used to store the timeshift
temporary files.

FTP input
--ftp-user <string> FTP user name
Allows you to modify the user name that will
be used for the connection.
--ftp-pwd <string> FTP password
Allows you to modify the password that will
be used for the connection.
--ftp-account <string> FTP account
Allows you to modify the account that will be
used for the connection.

HTTP input
--http-proxy <string> HTTP proxy
You can specify an HTTP proxy to use. It must
be of the form http://[user[:pass]@]myproxy.my
domain:myport/ ; if empty, the http_proxy
environment variable will be tried.

Microsoft Media Server (MMS) input
--mms-maxbitrate <integer> Maximum bitrate
If this is set, the stream with the maximum
bitrate under that limit will be selected

libshout (icecast) output
--sout-shout-name <string> Stream-name
The name this stream/channel will get on the
icecast server.
--sout-shout-description <string>
Stream-description
A description of the stream content.
(Information about your channel).

UDP stream output

SMB input
--smb-user <string> SMB user name
Allows you to modify the user name that will
be used for the connection.
--smb-pwd <string> SMB password
Allows you to modify the password that will
be used for the connection.
--smb-domain <string> SMB domain
Allows you to modify the domain/workgroup
that will be used for the connection.

Image properties filter
--contrast <float> Image contrast (0-2)
Set the image contrast, between 0 and 2.
Defaults to 1
--brightness <float> Image brightness (0-2)
Set the image brightness, between 0 and 2.
Defaults to 1
--hue <integer> Image hue (0-360)
Set the image hue, between 0 and 360.
Defaults to 0
--saturation <float> Image saturation (0-3)
Set the image saturation, between 0 and 3.
Defaults to 1
--gamma <float> Image gamma (0-10)
Set the image gamma, between 0.01 and 10.
Defaults to 1
--brightness-threshold, --no-brightness-threshold
Enable brightness threshold (default disabled)
Show black and white pixels with brightness
as threshold value (default disabled)

File audio output
--audiofile-file <string> Output file
File to which the audio samples will be
written to

AVI demuxer
--avi-index, --no-avi-index
Force index creation (default disabled)
Recreate a index for the AVI file. Use this
if your AVI file is damaged or incomplete
(not seekable). (default disabled)

Clone video filter
--clone-count <integer> Number of clones
Select the number of video windows in which
to clone the video.

Crop video filter
--crop-geometry <string> Crop geometry (pixels)
Set the geometry of the zone to crop. This is
set as <width> x <height> + <left offset> +
<top offset>.
--autocrop, --no-autocrop Automatic cropping (default disabled)
Activate automatic black border cropping.
(default disabled)

Deinterlacing video filter
--deinterlace-mode {discard,blend,mean,bob,linear,x}
Deinterlace mode
Default deinterlace method to use for local
playback
--sout-deinterlace-mode {discard,blend,mean,bob,linear,x}
Deinterlace mode
Default deinterlace methode to use for
streaming

File dumpper
--demuxdump-file <string> Dump filename
Name of the file to which the raw stream will
be dumped.
--demuxdump-append, --no-demuxdump-append
Append to existing file (default disabled)
If the file already exists, it will not be
overwritten. (default disabled)

Distort video filter
--distort-mode {wave,ripple,gradient,edge,hough,psychedelic}
Distort mode
Distort mode, one of "wave", "ripple",
"gradient", "edge", "hough" and "psychedelic"
--distort-gradient-type <integer>
Gradient image type
Gradient image type (0 or 1)
--distort-cartoon, --no-distort-cartoon
Apply cartoon effect (default enabled)
Apply cartoon effect. Used by "gradient" and
"edge". (default enabled)

Dummy interface function
--dummy-quiet, --no-dummy-quiet
Do not open a DOS command box interface
(default disabled)
By default the dummy interface plugin will
start a DOS command box. Enabling the quiet
mode will not bring this command box but can
also be pretty annoying when you want to stop
VLC and no video window is open. (default
disabled)

DVB subtitles decoder
--dvbsub-x <integer> X coordinate of the subpicture
You can reposition the subpicture by
providing another value here.
--dvbsub-y <integer> Y coordinate of the subpicture
You can reposition the subpicture by
providing another value here.
--sout-dvbsub-x <integer> X coordinate of the encoded subpicture
You can reposition the subpicture by
providing another value here.
--sout-dvbsub-y <integer> Y coordinate of encoded the subpicture
You can reposition the subpicture by
providing another value here.
--sout-dvbsub-timeout <integer>
Timeout of subpictures
Subpictures get a default timeout of 15
seconds added to their remaining time.This
will ensure that they are at least the
specified time visible.

DVDnav Input
--dvdnav-angle <integer> DVD angle
Allows you to select the default DVD angle.
--dvdnav-menu, --no-dvdnav-menu
Start directly in menu (default enabled)
Allows you to start the DVD directly in the
main menu. This will try to skip all the
useless warnings introductions. (default
enabled)

DVDRead Input (DVD without menu support)
--dvdread-angle <integer> DVD angle
Allows you to select the default DVD angle.

Equalizer 10 bands
--equalizer-preset {flat,classical,club,dance,fullbass,fullbasstreble,fulltreble,headphones,largehall,live,party,pop,reggae,rock,ska,soft,softrock,techno}
Equalizer preset
Equalizer preset

Fake video decoder
--fake-file <string> Image file
Path of the image file when using the fake
input.
--fake-deinterlace, --no-fake-deinterlace
Deinterlace video (default disabled)
Allows you to deinterlace the image after
loading. (default disabled)
--fake-deinterlace-module {deinterlace,ffmpeg-deinterlace}
Deinterlace module
Specifies the deinterlace module to use.

Freetype2 font renderer
--freetype-font <string> Font
Filename for the font you want to use
--freetype-color {0 (Black), 8421504 (Gray), 12632256 (Silver), 16777215 (White), 8388608 (Maroon), 16711680 (Red), 16711935 (Fuchsia), 16776960 (Yellow), 8421376 (Olive), 32768 (Green), 32896 (Teal), 65280 (Lime), 8388736 (Purple), 128 (Navy), 255 (Blue), 65535 (Aqua)}
Text default color
The 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. #000000 =
black, #FF0000 = red, #00FF00 = green,
#FFFF00 = yellow (red + green), #FFFFFF =
white
--freetype-rel-fontsize {20 (Smaller), 18 (Small), 16 (Normal), 12 (Large), 6 (Larger)}
Relative font size
This is the relative default size of the
fonts that will be rendered on the video. If
absolute font size is set, relative size will
be overriden.
--freetype-effect {1 (Background), 2 (Outline), 3 (Fat Outline)}
Font Effect
It is possible to apply effects to the
renderedtext to improve its readability.

Mouse gestures control interface
--gestures-button {left,middle,right}
Trigger button
You can set the trigger button for mouse
gestures here.

GnuTLS TLS encryption layer
--tls-check-cert, --no-tls-check-cert
Check TLS/SSL server certificate validity
(default enabled)
This ensures that the server certificate is
valid (i.e. signed by an approved
Certification Authority). (default enabled)
--tls-check-hostname, --no-tls-check-hostname
Check TLS/SSL server hostname in certificate
(default enabled)
This ensures that the server hostname in
certificate matches the requested host name.
(default enabled)

Goom effect
--goom-width <integer> Goom display width
This allows you to set the resolution of the
Goom display (bigger resolution will be
prettier but more CPU intensive).
--goom-height <integer> Goom display height
This allows you to set the resolution of the
Goom display (bigger resolution will be
prettier but more CPU intensive).
--goom-speed <integer> Goom animation speed
This allows you to set the animation speed
(between 1 and 10, defaults to 6).

Growl Notification Plugin
--growl-server <string> Growl server
This is the host to which Growl notifications
will be sent. By default, notifications are
sent locally.
--growl-password <string> Growl password
Growl password on the server.

Headphone channel mixer with virtual spatialization effect
--headphone-dim <integer> Characteristic dimension
Distance between front left speaker and
listener in meters.

Image video output
--image-out-format {png,jpeg}
Image format
Set the format of the output image.
--image-out-ratio <integer>
Recording ratio
Set the ratio of images that are recorded. 3
means that one image out of three is recorded.
--image-out-prefix <string>
Filename prefix
Set the prefix of the filename. Output
filename will have the form prefixNUMBER.forma
t
--image-out-replace, --no-image-out-replace
Always write to the same file (default
disabled)
Always write to the same file (default
disabled)

File logging
--logfile <string> Log filename
Specify the log filename.
--logmode {text,html} Log format
Specify the log format. Available choices are
"text" (default) and "html".

Logo video filter
--logo-file <string> Logo filenames
Full path of the image files to use. Format
is <image>[,<delay in ms>[,<alpha>]][;<image>[
,<delay>[,<alpha>]]][;...] .
--logo-transparency <integer>
Transparency of the logo
You can set the logo transparency value here
(from 0 for full transparency to 255 for full
opacity).
--logo-position {0 (Center), 1 (Left), 2 (Right), 4 (Top), 8 (Bottom), 5 (Top-Left), 6 (Top-Right), 9 (Bottom-Left), 10 (Bottom-Right)}
Logo position
You can enforce the logo position on the
video (0=center, 1=left, 2=right, 4=top,
8=bottom, you can also use combinations of
these values).

Marquee display sub filter
--marq-marquee <string> Marquee text
Marquee text to display
--marq-position <integer> Marquee position
You can enforce the marquee position on the
video (0=center, 1=left, 2=right, 4=top,
8=bottom, you can also use combinations of
these values by adding them).
--marq-opacity <integer> Opacity
The opacity (inverse of transparency) of
overlay text. 0 = transparent, 255 = totally
opaque.
--marq-color {-268435456 (Default), 0 (Black), 8421504 (Gray), 12632256 (Silver), 16777215 (White), 8388608 (Maroon), 16711680 (Red), 16711935 (Fuchsia), 16776960 (Yellow), 8421376 (Olive), 32768 (Green), 32896 (Teal), 65280 (Lime), 8388736 (Purple), 128 (Navy), 255 (Blue), 65535 (Aqua)}
Text Default Color
The color of overlay text. 1 byte for each
color, hexadecimal. #000000 = all colors off,
0xFF0000 = just Red, 0xFFFFFF = all color on
[White]
--marq-size <integer> Font size, pixels
Specify the font size, in pixels, with -1 =
use freetype-fontsize
--marq-timeout <integer> Marquee timeout
Defines the time the marquee must remain
displayed, in milliseconds. Default value is
0 (remain forever).

M-JPEG camera demuxer
--mjpeg-fps <float> Frames per Second
This is the desired frame rate when playing
MJPEG from a file. Use 0 (this is the default
value) for a live stream (from a camera).

MOD demuxer (libmodplug)
--mod-noisereduction, --no-mod-noisereduction
Noise reduction (default enabled)
Enable noise reduction algorithm (default
enabled)
--mod-reverb, --no-mod-reverb
Reverb (default disabled)
Enable reverberation (default disabled)
--mod-megabass, --no-mod-megabass
Mega bass (default disabled)
Enable megabass mode (default disabled)
--mod-surround, --no-mod-surround
Surround (default disabled)
Surround (default disabled)

Mosaic video sub filter
--mosaic-alpha <integer> Alpha blending
Alpha blending (0 -> 255). Default is 255
--mosaic-height <integer> Height in pixels
Height in pixels
--mosaic-width <integer> Width in pixels
Width in pixels
--mosaic-position {0 (auto), 1 (fixed)}
Positioning method
Positioning method. auto: automatically
choose the best number of rows and columns.
fixed: use the user-defined number of rows
and columns.
--mosaic-rows <integer> Number of rows
Number of rows
--mosaic-cols <integer> Number of columns
Number of columns
--mosaic-keep-aspect-ratio, --no-mosaic-keep-aspect-ratio
Keep aspect ratio when resizing (default
disabled)
Keep aspect ratio when resizing (default
disabled)
--mosaic-keep-picture, --no-mosaic-keep-picture
Keep original size (default disabled)
Keep original size (default disabled)
--mosaic-order <string> Order as a comma separated list of
picture-id(s)
Order as a comma separated list of
picture-id(s)
--mosaic-delay <integer> Delay
Pictures coming from the picture video
outputs will be delayed accordingly (in
milliseconds). For high values you will need
to raise file-caching and others.
--mosaic-bs, --no-mosaic-bs
Enable bluescreen (aka greenscreen or chroma
key) video background replacing (default
disabled)
Enable bluescreen (aka greenscreen or chroma
key) video background replacing (default
disabled)
--mosaic-bsu <integer> Bluescreen chroma key U (0-255)
Bluescreen chroma key U (0-255)
--mosaic-bsv <integer> Bluescreen chroma key V (0-255)
Bluescreen chroma key V (0-255)
--mosaic-bsut <integer> Bluescreen chroma key U tolerance
Bluescreen chroma key U tolerance
--mosaic-bsvt <integer> Bluescreen chroma key V tolerance
Bluescreen chroma key V tolerance

Motion blur filter
--blur-factor <integer> Blur factor (1-127)
The degree of blurring from 1 to 127.

Motion detect video filter
--motiondetect-history <integer>
History parameter
History parameter, number of frames used for
detection
--motiondetect-description <string>
Description file
Description file, file containing simple
playlist

MusePack demuxer
--mpc-replaygain-type {0 (None), 1 (Title), 2 (Album)}
Replay Gain type
Musepack can have a title-specific replay
gain (volume control) or an album-specific
one. Choose which type you want to use

MSN Now-Playing
--msn-format <string> MSN Title format string
Format of the string to send to MSN {0}
Artist, {1} Title, {2} Album. Defaults to
"Artist - Title" ({0} - {1}).

OpenGL video output
--opengl-effect {none,cube,transparent-cube}
Select effect
Allows you to select different visual effects.

On Screen Display menu subfilter
--osdmenu-x <integer> X coordinate of the OSD menu
You can move the OSD menu by left-clicking on
it.
--osdmenu-y <integer> Y coordinate of the OSD menu
You can move the OSD menu by left-clicking on
it.
--osdmenu-position {0 (Center), 1 (Left), 2 (Right), 4 (Top), 8 (Bottom), 5 (Top-Left), 6 (Top-Right), 9 (Bottom-Left), 10 (Bottom-Right)}
OSD menu position
You can enforce the OSD menu position on the
video (0=center, 1=left, 2=right, 4=top,
8=bottom, you can also use combinations of
these values).
--osdmenu-file <string> OSD menu configuration file
An OSD menu configuration file that menu
actions with button images
--osdmenu-file-path <string>
Path to OSD menu images
Specify another path to the OSD menu images.
This will override the path as defined in the
OSD configuration file.
--osdmenu-timeout <integer>
Timeout of OSD menu
OSD menu pictures get a default timeout of 15
seconds added to their remaining time. This
will ensure that they are at least the
specified time visible.

Parametric Equalizer
--param-eq-lowf <float> Low freq (Hz)
--param-eq-lowgain <float> Low freq gain (Db)
--param-eq-highf <float> High freq (Hz)
--param-eq-highgain <float>
High freq gain (Db)
--param-eq-f1 <float> Freq 1 (Hz)
--param-eq-gain1 <float> Freq 1 gain (Db)
--param-eq-q1 <float> Freq 1 Q
--param-eq-f2 <float> Freq 2 (Hz)
--param-eq-gain2 <float> Freq 2 gain (Db)
--param-eq-q2 <float> Freq 2 Q
--param-eq-f3 <float> Freq 3 (Hz)
--param-eq-gain3 <float> Freq 3 gain (Db)
--param-eq-q3 <float> Freq 3 Q

Playlist
--playlist-autostart, --no-playlist-autostart
Auto start (default enabled)
Automatically start playing the playlist
content once it's loaded.
(default enabled)

Podcasts
--podcast-urls <string> Podcast URLs list
Enter the list of podcasts to retrieve,
separated by '|' (pipe).

PORTAUDIO audio output
--portaudio-device <integer>
Output device
Portaudio identifier for the output device

Remote control interface
--rc-quiet, --no-rc-quiet Do not open a DOS command box interface
(default disabled)
By default the rc interface plugin will start
a DOS command box. Enabling the quiet mode
will not bring this command box but can also
be pretty annoying when you want to stop VLC
and no video window is open. (default
disabled)

RSS and Atom feed display
--rss-urls <string> RSS/Atom feed URLs
RSS/Atom feed '|' (pipe) seperated URLs
--rss-position {0 (Center), 1 (Left), 2 (Right), 4 (Top), 8 (Bottom), 5 (Top-Left), 6 (Top-Right), 9 (Bottom-Left), 10 (Bottom-Right)}
Marquee position
You can enforce the marquee position on the
video (0=center, 1=left, 2=right, 4=top,
8=bottom, you can also use combinations of
these values by adding them).
--rss-opacity <integer> Opacity
The opacity (inverse of transparency) of
overlay text. 0 = transparent, 255 = totally
opaque.
--rss-color {-268435456 (Default), 0 (Black), 8421504 (Gray), 12632256 (Silver), 16777215 (White), 8388608 (Maroon), 16711680 (Red), 16711935 (Fuchsia), 16776960 (Yellow), 8421376 (Olive), 32768 (Green), 32896 (Teal), 65280 (Lime), 8388736 (Purple), 128 (Navy), 255 (Blue), 65535 (Aqua)}
Text Default Color
The color of overlay text. 1 byte for each
color, hexadecimal. #000000 = all colors off,
0xFF0000 = just Red, 0xFFFFFF = all color on
[White]
--rss-size <integer> Font size, pixels
Specify the font size, in pixels, with -1 =
use freetype-fontsize
--rss-speed <integer> RSS/Atom feed speed
RSS/Atom feed speed (bigger is slower)
--rss-length <integer> RSS/Atom feed max number of chars displayed
RSS/Atom feed max number of chars displayed
--rss-ttl <integer> Number of seconds between each forced refresh
of the feeds
Number of seconds between each forced refresh
of the feeds. If 0, the feeds will never be
updated.
--rss-images, --no-rss-images
Display feed images if available (default
enabled)
Display feed images if available (default
enabled)

Skinnable Interface
--skins2-transparency, --no-skins2-transparency
Enable transparency effects (default disabled)
You can disable all transparency effects if
you want. This is mainly useful when moving
windows does not behave correctly. (default
disabled)

Bridge stream output
--sout-bridge-out-id <integer>
ID
Specify an identifier for this elementary
stream.
--sout-bridge-in-delay <integer>
Delay
Pictures coming from the picture video
outputs will be delayed accordingly (in
milliseconds, >= 100 ms). For high values,
you will need to raise file-caching and
others.
--sout-bridge-in-id-offset <integer>
ID Offset
Offset to add to the stream IDs specified in
bridge_out to obtain the stream IDs bridge_in
will register.

Mosaic bridge stream output
--sout-mosaic-bridge-id <string>
ID
Specify an identifier string for this
subpicture
--sout-mosaic-bridge-sar <string>
Sample aspect ratio
Sample aspect ratio of the destination (1:1,
3:4, 2:3).

RTP stream output
--sout-rtp-mp4a-latm, --no-sout-rtp-mp4a-latm
MP4A LATM (default disabled)
This allows you to stream MPEG4 LATM audio
streams (see RFC3016). (default disabled)

Standard stream output
--sout-standard-access <string>
Output access method
This is the output access method that will be
used.
--sout-standard-mux <string>
Output muxer
This is the muxer that will be used.
--sout-standard-dst <string>
Output destination
This is the destination (URL) that will be
used for the stream.

Transcode stream output
--sout-transcode-venc <string>
Video encoder
This is the video encoder module that will be
used (and its associated options).
--sout-transcode-vcodec <string>
Destination video codec
This is the video codec that will be used.
--sout-transcode-vb <integer>
Video bitrate
Target bitrate of the transcoded video stream.
--sout-transcode-scale <float>
Video scaling
Scale factor to apply to the video while
transcoding (eg: 0.25)
--sout-transcode-fps <float>
Video frame-rate
Target output frame rate for the video stream.
--sout-transcode-hurry-up, --no-sout-transcode-hurry-up
Hurry up (default enabled)
The transcoder will drop frames if your CPU
can't keep up with the encoding rate.
(default enabled)
--sout-transcode-deinterlace, --no-sout-transcode-deinterlace
Deinterlace video (default disabled)
Deinterlace the video before encoding.
(default disabled)
--sout-transcode-deinterlace-module {deinterlace,ffmpeg-deinterlace}
Deinterlace module
Specify the deinterlace module to use.
--sout-transcode-vfilter <string>
Video filter
Video filters will be applied to the video
streams (after overlays are applied). You
must enter a comma-separated list of filters.
--sout-transcode-canvas-aspect <string>
Video canvas aspect ratio
This sets aspect (like 4:3) of the video
canvas and letterbox the video accordingly.
--sout-transcode-aenc <string>
Audio encoder
This is the audio encoder module that will be
used (and its associated options).
--sout-transcode-acodec <string>
Destination audio codec
This is the audio codec that will be used.
--sout-transcode-ab <integer>
Audio bitrate
Target bitrate of the transcoded audio stream.
--sout-transcode-channels <integer>
Audio channels
Number of audio channels in the transcoded
streams.
--sout-transcode-audio-sync, --no-sout-transcode-audio-sync
Synchronise on audio track (default disabled)
This option will drop/duplicate video frames
to synchronise the video track on the audio
track. (default disabled)
--sout-transcode-senc <string>
Subtitles encoder
This is the subtitles encoder module that
will be used (and its associated options).
--sout-transcode-scodec <string>
Destination subtitles codec
This is the subtitles coded that will be used.
--sout-transcode-soverlay, --no-sout-transcode-soverlay
Destination subtitles codec (default disabled)
This is the subtitles coded that will be
used. (default disabled)
--sout-transcode-sfilter <string>
Overlays
This allows you to add overlays (also known
as "subpictures" on the transcoded video
stream. The subpictures produced by the
filters will be overlayed directly onto the
video. You must specify a comma-separated
list of subpicture modules
--sout-transcode-osd, --no-sout-transcode-osd
OSD menu (default disabled)
Stream the On Screen Display menu (using the
osdmenu subpicture module). (default disabled)

Text subtitles decoder
--subsdec-align {0 (Center), 1 (Left), 2 (Right)}
Subtitles justification
Set the justification of subtitles
--subsdec-encoding {Default,ASCII,UTF-8,,ISO-8859-1,CP1252,MacRoman,MacIceland,ISO-8859-15,,ISO-8859-2,CP1250,MacCentralEurope,MacCroatian,MacRomania,,ISO-8859-5,CP1251,MacCyrillic,MacUkraine,KOI8-R,KOI8-U,KOI8-RU,,ISO-8859-6,CP1256,MacArabic,,ISO-8859-7,CP1253,MacGreek,,ISO-8859-8,CP1255,MacHebrew,,ISO-8859-9,CP1254,MacTurkish,,ISO-8859-13,CP1257,,ISO-2022-JP,ISO-2022-JP-1,ISO-2022-JP-2,EUC-JP,SHIFT_JIS,,ISO-2022-CN,ISO-2022-CN-EXT,EUC-CN,EUC-TW,BIG5,BIG5-HKSCS,,ISO-2022-KR,EUC-KR,,MacThai,KOI8-T,,ISO-8859-3,ISO-8859-4,ISO-8859-10,ISO-8859-14,ISO-8859-16,,CP850,CP862,CP866,CP874,CP932,CP949,CP950,CP1133,CP1258,,Macintosh,,UTF-7,UTF-16,UTF-16BE,UTF-16LE,UTF-32,UTF-32BE,UTF-32LE,C99,JAVA,UCS-2,UCS-2BE,UCS-2LE,UCS-4,UCS-4BE,UCS-4LE,,HZ,GBK,GB18030,JOHAB,ARMSCII-8,Georgian-Academy,Georgian-PS,TIS-620,MuleLao-1,VISCII,TCVN,HPROMAN8,NEXTSTEP}
Subtitles text encoding
Set the encoding used in text subtitles
--subsdec-autodetect-utf8, --no-subsdec-autodetect-utf8
UTF-8 subtitles autodetection (default
enabled)
This enables automatic detection of UTF-8
encoding within subtitles files. (default
enabled)
--subsdec-formatted, --no-subsdec-formatted
Formatted Subtitles (default enabled)
Some subtitle formats allow for text
formatting. VLC partly implements this, but
you can choose to disable all formatting.
(default enabled)

Theora video decoder
--sout-theora-quality <integer>
Encoding quality
Allows you to specify a quality between 1
(low) and 10 (high), instead of specifying a
particular bitrate. This will produce a VBR
stream.

Time display sub filter
--time-position {0 (Center), 1 (Left), 2 (Right), 4 (Top), 8 (Bottom), 5 (Top-Left), 6 (Top-Right), 9 (Bottom-Left), 10 (Bottom-Right)}
Time position
You can enforce the time position on the
video (0=center, 1=left, 2=right, 4=top,
8=bottom, you can also use combinations of
these values by adding them).
--time-opacity <integer> Opacity
The opacity (inverse of transparency) of
overlay text. 0 = transparent, 255 = totally
opaque.
--time-color {-268435456 (Default), 0 (Black), 8421504 (Gray), 12632256 (Silver), 16777215 (White), 8388608 (Maroon), 16711680 (Red), 16711935 (Fuchsia), 16776960 (Yellow), 8421376 (Olive), 32768 (Green), 32896 (Teal), 65280 (Lime), 8388736 (Purple), 128 (Navy), 255 (Blue), 65535 (Aqua)}
Text Default Color
The color of overlay text. 1 byte for each
color, hexadecimal. #000000 = all colors off,
0xFF0000 = just Red, 0xFFFFFF = all color on
[White]
--time-size <integer> Font size, pixels
Specify the font size, in pixels, with -1 =
use freetype-fontsize

Video transformation filter
--transform-type {90,180,270,hflip,vflip}
Transform type
One of '90', '180', '270', 'hflip' and 'vflip'

MPEG Transport Stream demuxer
--ts-dump-file <string> Filename of dump
Specify a filename where to dump the TS in.
--ts-dump-append, --no-ts-dump-append
Append (default disabled)
If the file exists and this option is
selected, the existing file will not be
overwritten. (default disabled)

Libtwolame audio encoder
--sout-twolame-quality <float>
Encoding quality
Allows you to specify a quality between 0.0
(high) and 50.0 (low), instead of specifying
a particular bitrate. This will produce a VBR
stream.
--sout-twolame-mode {0 (Stereo), 1 (Dual mono), 2 (Joint stereo)}
Stereo mode
Select how stereo streams will be handled
--sout-twolame-vbr, --no-sout-twolame-vbr
VBR mode (default disabled)
By default the encoding is CBR. (default
disabled)
--sout-twolame-psy <integer>
Psycho-acoustic model
Integer from -1 (no model) to 4.

Visualizer filter
--effect-width <integer> Video width
The width of the effects video window, in
pixels.
--effect-height <integer> Video height
The height of the effects video window, in
pixels.

Vorbis audio decoder
--sout-vorbis-quality <integer>
Encoding quality
Allows you to specify a quality between 1
(low) and 10 (high), instead of specifying a
particular bitrate. This will produce a VBR
stream.
--sout-vorbis-max-bitrate <integer>
Maximum encoding bitrate
Allows you to specify a maximum bitrate in
kbps. Useful for streaming applications.
--sout-vorbis-min-bitrate <integer>
Minimum encoding bitrate
Allows you to specify a minimum bitrate in
kbps. Useful for encoding for a fixed-size
channel.
--sout-vorbis-cbr, --no-sout-vorbis-cbr
CBR encoding (default disabled)
Allows you to force a constant bitrate
encoding (CBR). (default disabled)

Wall video filter
--wall-cols <integer> Number of columns
Select the number of horizontal video windows
in which to split the video.
--wall-rows <integer> Number of rows
Select the number of vertical video windows
in which to split the video.
--wall-element-aspect <string>
Element aspect ratio
The aspect ratio of the individual displays
building the display wall

wxWidgets interface module
--wx-embed, --no-wx-embed Embed video in interface (default enabled)
Embed the video inside the interface instead
of having it in a separate window. (default
enabled)
--wx-bookmarks, --no-wx-bookmarks
Show bookmarks dialog (default disabled)
Show bookmarks dialog when the interface
starts. (default disabled)
--wx-taskbar, --no-wx-taskbar
Show taskbar entry (default enabled)
Show taskbar entry (default enabled)
--wx-extended, --no-wx-extended
Show extended GUI (default disabled)
Show extended GUI (default disabled)
--wx-playlist-view {0 (Normal), 1 (Embedded), 2 (Both)}
Playlist view
There are two possible playlist views in the
interface : the normal playlist (separate
window), or an embedded playlist (within the
main interface, but with less features. You
can select which one will be available on the
toolbar (or both).
--wx-systray, --no-wx-systray
Show systray icon (default disabled)
Show systray icon (default disabled)

H.264/MPEG4 AVC encoder (using x264 library)
--sout-x264-keyint <integer>
Maximum GOP size
Sets maximum interval between
IDR-frames.Larger values save bits, thus
improve quality for a given bitrate at the
cost of seeking precision.
--sout-x264-min-keyint <integer>
Minimum GOP size
Sets minimum interval between IDR-frames. In
H.264, I-frames do not necessarily bound a
closed GOP because it is allowable for a
P-frame to be predicted from more frames than
just the one frame before it (also see
frameref). Therefore, I-frames are not
necessarily seekable. IDR-Frames restrict
subsequent P-frames from referring to any
frame prior to the IDR-Frame.
If scenecuts
appear within this interval, they are still
encoded as I-frames, but do not start a new
GOP.
--sout-x264-scenecut <integer>
How aggressively to insert extra I-frames (-1
to 100)
Scene-cut detection. Controls how
aggressively to insert extra I-frames. With
small values of scenecut, the codec often has
to force an I-frame when it would exceed
keyint. Good values of scenecut may find a
better location for the I-frame. Large values
use more I-frames than necessary, thus
wasting bits. -1 disables scene-cut
detection, so I-frames are be inserted only
every other keyint frames, which probably
leads to ugly encoding artifacts.
--sout-x264-bframes <integer>
Number of B-frames between I and P (1 to 16)
Number of consecutive B-frames between I and
P-frames.
--sout-x264-b-adapt, --no-sout-x264-b-adapt
Adaptive B-frame decision (default enabled)
If this is on, the specified number of
consecutive B-frames will always be used,
except possibly before an I-frame. (default
enabled)
--sout-x264-b-bias <integer>
Influences how often B-frames are used
Bias the choice to use B-frames. Positive
values cause more B-frames, negative values
cause less B-frames.
--sout-x264-bpyramid, --no-sout-x264-bpyramid
Keep some B-frames as references (default
disabled)
Allows B-frames to be used as references for
predicting other frames. Keeps the middle of
2+ consecutive B-frames as a reference, and
reorders frame appropriately. (default
disabled)
--sout-x264-cabac, --no-sout-x264-cabac
CABAC (default enabled)
CABAC (Context-Adaptive Binary Arithmetic
Coding). Slightly slows down encoding and
decoding, but should save 10-15% bitrate.
(default enabled)
--sout-x264-ref <integer> Number of reference frames (1 to 16)
Number of previous frames used as predictors.
This is effective in Anime, but seems to make
little difference in live-action source
material. Some decoders are unable to deal
with large frameref values.
--sout-x264-nf, --no-sout-x264-nf
No loop filter (enabling turns off the
deblocking loop filter) (default disabled)
Deblocking loop filter (increases quality).
(default disabled)
--sout-x264-qp <integer> Set QP (0=lossless) (0 to 51)
This selects the quantizer to use. Lower
values result in better fidelity, but higher
bitrates. 26 is a good default value.
--sout-x264-crf <integer> Quality-based VBR (nominal QP) (0 to 51)
1-pass Quality-based VBR.
--sout-x264-qpmin <integer>
Set min QP
Minimum quantizer, 15/35 seems to be a useful
range.
--sout-x264-qpmax <integer>
Set max QP
Maximum quantizer parameter.
--sout-x264-qpstep <integer>
Set max QP step
Max QP step between frames.
--sout-x264-ratetol <float>
Allowed variance of average bitrate
Sets the allowed variance in average. bitrate.
--sout-x264-vbv-maxrate <integer>
Max local bitrate
Sets a maximum local bitrate in kbits/s.
--sout-x264-vbv-bufsize <integer>
Size of VBV buffer
Sets an averaging period for the maximum
local bitrate in kbits/s.
--sout-x264-vbv-init <float>
Initial VBV buffer occupancy
Sets the initial buffer occupancy as a
fraction of the buffer size.
--sout-x264-ipratio <float>
QP factor between I and P
QP factor between I and P.
--sout-x264-pbratio <float>
QP factor between P and B
QP factor between P and B.
--sout-x264-chroma-qp-offset <integer>
QP difference between chroma and luma
QP difference between chroma and luma.
--sout-x264-qcomp <float> QP curve compression (0.0=CBR to 1.0=QCP)
QP curve compression.
--sout-x264-cplxblur <float>
Reduce fluctuations in QP (before curve
compression)
Temporally blur complexity.
--sout-x264-qblur <float> Reduce fluctuations in QP (after curve
compression)
Temporally blur quants.
--sout-x264-analyse {,none,fast,normal,slow,all}
Partitions to consider
Partitions to consider in analyse mode:
-
none :
- fast : i4x4
- normal:
i4x4,p8x8,(i8x8)
- slow : i4x4,p8x8,(i8x8),b
8x8
- all : i4x4,p8x8,(i8x8),b8x8,p4x4
(p4x
4 requires p8x8. i8x8 requires 8x8dct).
--sout-x264-direct {,none,spatial,temporal}
Direct MV prediction mode
Direct MV prediction mode.
--sout-x264-weightb, --no-sout-x264-weightb
Weighted prediction for B-frames (default
disabled)
Weighted prediction for B-frames. (default
disabled)
--sout-x264-me {,dia,hex,umh,esa}
Integer pixel motion estimation method
Selects the motion estimation algorithm: -
dia: diamond search, radius 1 (fast)
- hex:
hexagonal search, radius 2
- umh: uneven
multi-hexagon search (better but slower)
-
esa: exhaustive search (extremely slow,
primarily for testing)

--sout-x264-merange <integer>
Maximum motion vector search range (0 to 64)
Maximum distance to search for motion
estimation, measured from predicted
position(s). Default of 16 is good for most
footage, high motion sequences may benefit
from settings between 24-32.
--sout-x264-subme <integer>
Subpixel motion estimation and partition
decision quality (1 to 6)
This parameter controls quality versus speed
tradeoffs involved in the motion estimation
decision process (lower = quicker and higher
= better quality).
--sout-x264-b-rdo, --no-sout-x264-b-rdo
RD based mode decision for B-frames. Requires
subme 6 (default disabled)
RD based mode decision for B-frames.
(default disabled)
--sout-x264-mixed-refs, --no-sout-x264-mixed-refs
Decide references on a per partition basis
(default disabled)
Allows each 8x8 or 16x8 partition to
independently select a reference frame, as
opposed to only one ref per macroblock.
(default disabled)
--sout-x264-chroma-me, --no-sout-x264-chroma-me
Ignore chroma in motion estimation (default
enabled)
Chroma ME for subpel and mode decision in
P-frames. (default enabled)
--sout-x264-bime, --no-sout-x264-bime
Jointly optimize both MVs in B-frames
(default disabled)
Joint bidirectional motion refinement.
(default disabled)
--sout-x264-8x8dct, --no-sout-x264-8x8dct
Adaptive spatial transform size (default
disabled)
SATD-based decision for 8x8 transform in
inter-MBs. (default disabled)
--sout-x264-trellis <integer>
Trellis RD quantization (0,1,2). Requires
CABAC
Trellis RD quantization:
- 0: disabled
-
1: enabled only on the final encode of a MB

- 2: enabled on all mode decisions

--sout-x264-fast-pskip, --no-sout-x264-fast-pskip
Early SKIP detection on P-frames (default
enabled)
Early SKIP detection on P-frames. (default
enabled)
--sout-x264-nr <integer> Noise reduction
Dct-domain noise reduction. Adaptive
pseudo-deadzone.
--sout-x264-asm, --no-sout-x264-asm
CPU optimizations (default enabled)
CPU optimizations. (default enabled)
--sout-x264-psnr, --no-sout-x264-psnr
PSNR calculation (default disabled)
This has no effect on actual encoding
quality, it just prevents the stats from
being calculated (for speed). (default
disabled)
--sout-x264-verbose, --no-sout-x264-verbose
Print stats for each frame (default disabled)
Print stats for each frame. (default disabled)

DirectShow input
--dshow-vdev {,none} Video device name
You can specify the name of the video device
that will be used by the DirectShow plugin.
If you don't specify anything, the default
device will be used.
--dshow-adev {,none} Audio device name
You can specify the name of the audio device
that will be used by the DirectShow plugin.
If you don't specify anything, the default
device will be used.
--dshow-size <string> Video size
You can specify the size of the video that
will be displayed by the DirectShow plugin.
If you don't specify anything the default
size for your device will be used.
</nowiki>

VLC command-line help

2006-05-22T12:51:12Z

Hogi:

As you may have noticed, the command ''vlc --help'' is not very useful due to to the non-scrollable pop-up window that opened.

If you look for help, on a particular module, use ''vlc -p module --advanced''

So here's the output of ''vlc --longhelp --advanced --help-verbose'' for the 0.8.5-test1 (2006/03/27) version in Windows.

<nowiki>
Usage: vlc.exe [options] [playlistitems] ...
You can specify multiple playlistitems on the commandline. They will be enqueued in the playlist.
The first item specified will be played first.

Options-styles:
--option A global option that is set for the duration of the program.
-option A single letter version of a global --option.
:option An option that only applies to the playlistitem directly before it
and that overrides previous settings.

Playlistitem MRL syntax:
[[access][/demux]://]URL[@[title][:chapter][-[title][:chapter]]] [:option=value ...]

Many of the global --options can also be used as MRL specific :options.
Multiple :option=value pairs can be specified.

URL syntax:
[file://]filename Plain media file
http://ip:port/file HTTP URL
ftp://ip:port/file FTP URL
mms://ip:port/file MMS URL
screen:// Screen capture
[dvd://][device][@raw_device] DVD device
[vcd://][device] VCD device
[cdda://][device] Audio CD device
udp:[[<source address>]@[<bind address>][:<bind port>]]
UDP stream sent by a streaming server
vlc:pause:<seconds> Special item to pause the playlist for a certain time
vlc:quit Special item to quit VLC

Help options
-h, --help Afficher l’aide de VLC (peut être combiné
avec --advanced)
-H, --longhelp Afficher l’aide de VLC et de ses modules
(peut être combiné avec --advanced)
--advanced Afficher l’aide pour les options avancées
--help-verbose Afficher plus de détails dans l’aide
-l, --list Affiche la liste des modules disponibles
-p, --module <string> Afficher l’aide d'un module spécifique
(peut être combiné avec --advanced)
--save-config Enregistre les options de la ligne de
commande actuelle dans la configuration
--reset-config Remet à zéro la configuration
--config <string> Utilise un autre fichier de configuration
--reset-plugins-cache Remet à zéro le cache des modules
--version Affiche le numéro de version

Audio
--audio, --no-audio Enable audio (default enabled)
You can completely disable the audio output.
In this case, the audio decoding stage will
not take place, thus saving some processing
power. (default enabled)
--volume <integer> Default audio volume
You can set the default audio output volume
here, in a range from 0 to 1024.
--spdif, --no-spdif Use the S/PDIF audio output when available
(default disabled)
This option allows you to use the S/PDIF
audio output by default when your hardware
supports it as well as the audio stream being
played. (default disabled)
--force-dolby-surround {0 (Auto), 1 (On), 2 (Off)}
Force detection of Dolby Surround
Use this when you know your stream is (or is
not) encoded with Dolby Surround but fails to
be detected as such. And even if the stream
is not actually encoded with Dolby Surround,
turning on this option might enhance your
experience, especially when combined with the
Headphone Channel Mixer.
--audio-filter <string> Audio filters
This allows you to add audio post processing
filters, to modify the sound
--audio-visual <string> Audio visualizations
This allows you to add visualization modules
(spectrum analyzer, etc.).

Video
-f, --fullscreen, --no-fullscreen
Fullscreen video output (default disabled)
If this option is enabled, VLC will always
start a video in fullscreen mode. (default
disabled)
--overlay, --no-overlay Overlay video output (default enabled)
If enabled, VLC will try to take advantage of
the overlay capabilities of your graphics
card (hardware acceleration). (default
enabled)
--video-on-top, --no-video-on-top
Always on top (default disabled)
Always place the video window on top of other
windows. (default disabled)
--snapshot-path <string> Video snapshot directory
Allows you to specify the directory where the
video snapshots will be stored.
--snapshot-format {png,jpg}
Video snapshot format
Allows you to specify the image format in
which the video snapshots will be stored.
--snapshot-preview, --no-snapshot-preview
Display video snapshot preview (default
enabled)
Enable / disable displaying the snapshot
preview in the screen's to left corner.
(default enabled)
--crop <string> Video cropping
This will force the cropping of the source
video. Accepted formats are x:y (4:3, 16:9,
etc.) expressing the global image aspect.
--aspect-ratio <string> Source aspect ratio
This will force the source aspect ratio. For
instance, some DVDs claim to be 16:9 while
they are actually 4:3. This can also be used
as a hint for VLC when a movie does not have
aspect ratio information. Accepted formats
are x:y (4:3, 16:9, etc.) expressing the
global image aspect, or a float value (1.25,
1.3333, etc.) expressing pixel squareness.
--vout-filter <string> Video filter module
This will allow you to add a post-processing
filter to enhance the picture quality, for
instance deinterlacing, or to clone or
distort the video window.

Subpictures
--osd, --no-osd On Screen Display (default enabled)
VLC can display messages on the video. This
is called OSD (On Screen Display). You can
disable this feature here. (default enabled)
--sub-file <string> Use subtitle file
Load this subtitle file. To be used when
autodetect cannot detect your subtitle file.
--sub-autodetect-file, --no-sub-autodetect-file
Autodetect subtitle files (default enabled)
Automatically detect a subtitle file, if no
subtitle filename is specified. (default
enabled)
--sub-filter <string> Subpictures filter module
This will allow you to add a subpictures
filter for instance to overlay a logo.
--audio-language <string> Audio language
Give the language of the audio track you want
to use (comma separted, two or three letter
country code).
--sub-language <string> Subtitle language
Give the language of the subtitle track you
want to use (comma separted, two or tree
letter country code).
--input-repeat <integer> Input repetitions
Number of time the same input will be repeated
--dvd <string> DVD device
This is the default DVD drive (or file) to
use. Don't forget the colon after the drive
letter (eg. D:)
--vcd <string> VCD device
This is the default VCD device to use.
--cd-audio <string> Audio CD device
This is the default Audio CD device to use.
--server-port <integer> UDP port
This is the port used for UDP streams. 1234
by default.
-6, --ipv6, --no-ipv6 Force IPv6 (default disabled)
If you check this box, IPv6 will be used by
default for all UDP and HTTP connections.
(default disabled)
-4, --ipv4, --no-ipv4 Force IPv4 (default disabled)
If you check this box, IPv4 will be used by
default for all UDP and HTTP connections.
(default disabled)

Input
--access-filter <string> Access filter module
This is a legacy entry to let you configure
access filter modules.
--high-priority, --no-high-priority
Increase the priority of the process (default
disabled)
Increasing the priority of the process will
very likely improve your playing experience
as it allows VLC not to be disturbed by other
applications that could otherwise take too
much processor time. However be advised that
in certain circumstances (bugs) VLC could
take all the processor time and render the
whole system unresponsive which might require
a reboot of your machine. (default disabled)

Playlist
-Z, --random, --no-random Play files randomly forever (default disabled)
When selected, VLC will randomly play files
in the playlist until interrupted. (default
disabled)
-L, --loop, --no-loop Repeat all (default disabled)
If you want VLC to keep playing the playlist
indefinitely then enable this option.
(default disabled)
-R, --repeat, --no-repeat Repeat current item (default disabled)
When this is active, VLC will keep playing
the current playlist item over and over
again. (default disabled)
--play-and-stop, --no-play-and-stop
Play and stop (default disabled)
Stop the playlist after each played playlist
item. (default disabled)
--open <string> Default stream
This option allows you to always open a
default stream on start-up.
--auto-preparse, --no-auto-preparse
Automatically preparse files (default enabled)
This option enables automatic preparsing of
files added to the playlist (to retrieve some
metadata). (default enabled)
-S, --services-discovery <string>
Services discovery modules
Specifies the services discovery modules to
load, separated by semi-colons. Typical
values are sap, hal, ...
--extraintf <string> Extra interface modules
This option allows you to select additional
interfaces used by VLC. They will be launched
in the background in addition to the default
interface. Use a comma separated list of
interface modules. (common values are logger,
gestures, sap, rc, http or screensaver)
-v, --verbose <integer> Verbosity (0,1,2)
This option sets the verbosity level (0=only
errors and standard messages, 1=warnings,
2=debug).
--language {auto,en,en_GB,ca,da,de,es,fr,it,ja,ka,ko,nl,oc,pt_BR,ro,ru,tr,zh_CN,zh_TW}
Language
This option allows you to set the language of
the interface. The system language is
auto-detected if "auto" is specified here.
--advanced, --no-advanced Show advanced options (default enabled)
When this option is turned on, the
preferences and/or interfaces will show all
the available options, including those that
most users should never touch. (default
enabled)
--show-intf, --no-show-intf
Show interface with mouse (default disabled)
If this enabled, the interface will be shown
when you move the mouse to the edge of the
screen in fullscreen mode. (default disabled)
-I, --intf <string> Interface module
This option allows you to select the
interface used by VLC. The default behavior
is to automatically select the best module
available.
--control <string> Control interfaces
This option allows you to select control
interfaces.
-start-time <integer>
This option allows you to select the
start-time of your file. The parameter
has to be in seconds.

Hot keys
--key-fullscreen <integer> Fullscreen
Select the hotkey to use to swap fullscreen
state.
--key-play-pause <integer> Play/Pause
Select the hotkey to use to swap paused state.
--key-faster <integer> Faster
Select the hotkey to use for fast forward
playback.
--key-slower <integer> Slower
Select the hotkey to use for slow motion
playback.
--key-next <integer> Next
Select the hotkey to use to skip to the next
item in the playlist.
--key-prev <integer> Previous
Select the hotkey to use to skip to the
previous item in the playlist.
--key-stop <integer> Stop
Select the hotkey to stop the playback.
--key-jump-extrashort <integer>
Very short backwards jump
Select the hotkey to make a very short
backwards jump.
--key-jump+extrashort <integer>
Very short forward jump
Select the hotkey to make a very short
forward jump.
--key-jump-short <integer> Short backwards jump
Select the hotkey to make a short backwards
jump.
--key-jump+short <integer> Short forward jump
Select the hotkey to make a short forward
jump.
--key-jump-medium <integer>
Medium backwards jump
Select the hotkey to make a medium backwards
jump.
--key-jump+medium <integer>
Medium forward jump
Select the hotkey to make a medium forward
jump.
--key-jump-long <integer> Long backwards jump
Select the hotkey to make a long backwards
jump.
--key-jump+long <integer> Long forward jump
Select the hotkey to make a long forward jump.
--key-quit <integer> Quit
Select the hotkey to quit the application.
--key-vol-up <integer> Volume up
Select the key to increase audio volume.
--key-vol-down <integer> Volume down
Select the key to decrease audio volume.
--key-vol-mute <integer> Mute
Select the key to turn off audio volume.
--key-audio-track <integer>
Cycle audio track
Cycle through the available audio
tracks(languages)
--key-subtitle-track <integer>
Cycle subtitle track
Cycle through the available subtitle tracks
--key-aspect-ratio <integer>
Cycle source aspect ratio
Cycle through a predefined list of source
aspect ratios
--key-crop <integer> Cycle video crop
Cycle through a predefined list of crop
formats
--key-deinterlace <integer>
Cycle deinterlace modes
Cycle through all the deinterlace modes
--extrashort-jump-size <integer>
Very short jump size
Very short jump "size", in seconds
--short-jump-size <integer>
Short jump size
Short jump "size", in seconds
--medium-jump-size <integer>
Medium jump size
Medium jump "size", in seconds
--long-jump-size <integer> Long jump size
Long jump "size", in seconds
--bookmark1 <string> Playlist bookmark 1
This option allows you to define playlist
bookmarks.
--bookmark2 <string> Playlist bookmark 2
This option allows you to define playlist
bookmarks.
--bookmark3 <string> Playlist bookmark 3
This option allows you to define playlist
bookmarks.
--bookmark4 <string> Playlist bookmark 4
This option allows you to define playlist
bookmarks.
--bookmark5 <string> Playlist bookmark 5
This option allows you to define playlist
bookmarks.
--bookmark6 <string> Playlist bookmark 6
This option allows you to define playlist
bookmarks.
--bookmark7 <string> Playlist bookmark 7
This option allows you to define playlist
bookmarks.
--bookmark8 <string> Playlist bookmark 8
This option allows you to define playlist
bookmarks.
--bookmark9 <string> Playlist bookmark 9
This option allows you to define playlist
bookmarks.
--bookmark10 <string> Playlist bookmark 10
This option allows you to define playlist
bookmarks.

ffmpeg audio/video decoder/encoder ((MS)MPEG4,SVQ1,H263,WMV,WMA)
--ffmpeg-workaround-bugs <integer>
Workaround bugs
Try to fix some bugs
1 autodetect
2 old
msmpeg4
4 xvid interlaced
8 ump4
16 no
padding
32 ac vlc
64 Qpel chroma
--ffmpeg-hurry-up, --no-ffmpeg-hurry-up
Hurry up (default disabled)
Allow the decoder to partially decode or skip
frame(s) when there is not enough time. It's
useful with low CPU power but it can produce
distorted pictures. (default disabled)
--ffmpeg-pp-q <integer> Post processing quality
Quality of post processing. Valid range is 0
to 6
Higher levels require considerable more
CPU power, but produce better looking
pictures.
--sout-ffmpeg-hq {rd,bits,simple}
Quality level
Allows you to specify the quality level for
the encoding of motions vectors (this can
slow down the encoding very much).
--sout-ffmpeg-keyint <integer>
Ratio of key frames
Allows you to specify the number of frames
that will be coded for one key frame.
--sout-ffmpeg-bframes <integer>
Ratio of B frames
Allows you to specify the number of B frames
that will be coded between two reference
frames.
--sout-ffmpeg-hurry-up, --no-sout-ffmpeg-hurry-up
Hurry up (default disabled)
Allows you to specify if the encoder should
make on-the-fly quality tradeoffs if your CPU
can't keep up with the encoding rate. It will
disable trellis quantization, then the rate
distortion of motion vectors (hq), and raise
the noise reduction threshold to ease the
encoder's task. (default disabled)

MPEG2 video switcher stream output
--sout-switcher-files <string>
Files
Full paths of the files separated by colons.
--sout-switcher-sizes <string>
Sizes
List of sizes separated by colons
(720x576:480x576).
--sout-switcher-aspect-ratio <string>
Aspect ratio
Aspect ratio (4:3, 16:9).

ATSC A/52 (AC-3) audio decoder
--a52-dynrng, --no-a52-dynrng
A/52 dynamic range compression (default
enabled)
Dynamic range compression makes the loud
sounds softer, and the soft sounds louder, so
you can more easily listen to the stream in a
noisy environment without disturbing anyone.
If you disable the dynamic range compression
the playback will be more adapted to a movie
theater or a listening room. (default enabled)

Standard filesystem directory input
--recursive {none,collapse,expand}
Subdirectory behavior
Select whether subdirectories must be
expanded.
none: subdirectories do not appear
in the playlist.
collapse: subdirectories
appear but are expanded on first
play.
expand: all subdirectories are
expanded.

--ignore-filetypes <string>
Ignore files with these extensions
Specify a comma seperated list of file
extensions. Files with these extensions will
not be added to playlist when opening a
directory. This is useful if you add
directories that contain mp3 albums for
instance.

Timeshift
--timeshift-dir <string> Timeshift directory
Directory used to store the timeshift
temporary files.

FTP input
--ftp-user <string> FTP user name
Allows you to modify the user name that will
be used for the connection.
--ftp-pwd <string> FTP password
Allows you to modify the password that will
be used for the connection.
--ftp-account <string> FTP account
Allows you to modify the account that will be
used for the connection.

HTTP input
--http-proxy <string> HTTP proxy
You can specify an HTTP proxy to use. It must
be of the form http://[user[:pass]@]myproxy.my
domain:myport/ ; if empty, the http_proxy
environment variable will be tried.

Microsoft Media Server (MMS) input
--mms-maxbitrate <integer> Maximum bitrate
If this is set, the stream with the maximum
bitrate under that limit will be selected

libshout (icecast) output
--sout-shout-name <string> Stream-name
The name this stream/channel will get on the
icecast server.
--sout-shout-description <string>
Stream-description
A description of the stream content.
(Information about your channel).

UDP stream output

SMB input
--smb-user <string> SMB user name
Allows you to modify the user name that will
be used for the connection.
--smb-pwd <string> SMB password
Allows you to modify the password that will
be used for the connection.
--smb-domain <string> SMB domain
Allows you to modify the domain/workgroup
that will be used for the connection.

Image properties filter
--contrast <float> Image contrast (0-2)
Set the image contrast, between 0 and 2.
Defaults to 1
--brightness <float> Image brightness (0-2)
Set the image brightness, between 0 and 2.
Defaults to 1
--hue <integer> Image hue (0-360)
Set the image hue, between 0 and 360.
Defaults to 0
--saturation <float> Image saturation (0-3)
Set the image saturation, between 0 and 3.
Defaults to 1
--gamma <float> Image gamma (0-10)
Set the image gamma, between 0.01 and 10.
Defaults to 1
--brightness-threshold, --no-brightness-threshold
Enable brightness threshold (default disabled)
Show black and white pixels with brightness
as threshold value (default disabled)

File audio output
--audiofile-file <string> Output file
File to which the audio samples will be
written to

AVI demuxer
--avi-index, --no-avi-index
Force index creation (default disabled)
Recreate a index for the AVI file. Use this
if your AVI file is damaged or incomplete
(not seekable). (default disabled)

Clone video filter
--clone-count <integer> Number of clones
Select the number of video windows in which
to clone the video.

Crop video filter
--crop-geometry <string> Crop geometry (pixels)
Set the geometry of the zone to crop. This is
set as <width> x <height> + <left offset> +
<top offset>.
--autocrop, --no-autocrop Automatic cropping (default disabled)
Activate automatic black border cropping.
(default disabled)

Deinterlacing video filter
--deinterlace-mode {discard,blend,mean,bob,linear,x}
Deinterlace mode
Default deinterlace method to use for local
playback
--sout-deinterlace-mode {discard,blend,mean,bob,linear,x}
Deinterlace mode
Default deinterlace methode to use for
streaming

File dumpper
--demuxdump-file <string> Dump filename
Name of the file to which the raw stream will
be dumped.
--demuxdump-append, --no-demuxdump-append
Append to existing file (default disabled)
If the file already exists, it will not be
overwritten. (default disabled)

Distort video filter
--distort-mode {wave,ripple,gradient,edge,hough,psychedelic}
Distort mode
Distort mode, one of "wave", "ripple",
"gradient", "edge", "hough" and "psychedelic"
--distort-gradient-type <integer>
Gradient image type
Gradient image type (0 or 1)
--distort-cartoon, --no-distort-cartoon
Apply cartoon effect (default enabled)
Apply cartoon effect. Used by "gradient" and
"edge". (default enabled)

Dummy interface function
--dummy-quiet, --no-dummy-quiet
Do not open a DOS command box interface
(default disabled)
By default the dummy interface plugin will
start a DOS command box. Enabling the quiet
mode will not bring this command box but can
also be pretty annoying when you want to stop
VLC and no video window is open. (default
disabled)

DVB subtitles decoder
--dvbsub-x <integer> X coordinate of the subpicture
You can reposition the subpicture by
providing another value here.
--dvbsub-y <integer> Y coordinate of the subpicture
You can reposition the subpicture by
providing another value here.
--sout-dvbsub-x <integer> X coordinate of the encoded subpicture
You can reposition the subpicture by
providing another value here.
--sout-dvbsub-y <integer> Y coordinate of encoded the subpicture
You can reposition the subpicture by
providing another value here.
--sout-dvbsub-timeout <integer>
Timeout of subpictures
Subpictures get a default timeout of 15
seconds added to their remaining time.This
will ensure that they are at least the
specified time visible.

DVDnav Input
--dvdnav-angle <integer> DVD angle
Allows you to select the default DVD angle.
--dvdnav-menu, --no-dvdnav-menu
Start directly in menu (default enabled)
Allows you to start the DVD directly in the
main menu. This will try to skip all the
useless warnings introductions. (default
enabled)

DVDRead Input (DVD without menu support)
--dvdread-angle <integer> DVD angle
Allows you to select the default DVD angle.

Equalizer 10 bands
--equalizer-preset {flat,classical,club,dance,fullbass,fullbasstreble,fulltreble,headphones,largehall,live,party,pop,reggae,rock,ska,soft,softrock,techno}
Equalizer preset
Equalizer preset

Fake video decoder
--fake-file <string> Image file
Path of the image file when using the fake
input.
--fake-deinterlace, --no-fake-deinterlace
Deinterlace video (default disabled)
Allows you to deinterlace the image after
loading. (default disabled)
--fake-deinterlace-module {deinterlace,ffmpeg-deinterlace}
Deinterlace module
Specifies the deinterlace module to use.

Freetype2 font renderer
--freetype-font <string> Font
Filename for the font you want to use
--freetype-color {0 (Black), 8421504 (Gray), 12632256 (Silver), 16777215 (White), 8388608 (Maroon), 16711680 (Red), 16711935 (Fuchsia), 16776960 (Yellow), 8421376 (Olive), 32768 (Green), 32896 (Teal), 65280 (Lime), 8388736 (Purple), 128 (Navy), 255 (Blue), 65535 (Aqua)}
Text default color
The 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. #000000 =
black, #FF0000 = red, #00FF00 = green,
#FFFF00 = yellow (red + green), #FFFFFF =
white
--freetype-rel-fontsize {20 (Smaller), 18 (Small), 16 (Normal), 12 (Large), 6 (Larger)}
Relative font size
This is the relative default size of the
fonts that will be rendered on the video. If
absolute font size is set, relative size will
be overriden.
--freetype-effect {1 (Background), 2 (Outline), 3 (Fat Outline)}
Font Effect
It is possible to apply effects to the
renderedtext to improve its readability.

Mouse gestures control interface
--gestures-button {left,middle,right}
Trigger button
You can set the trigger button for mouse
gestures here.

GnuTLS TLS encryption layer
--tls-check-cert, --no-tls-check-cert
Check TLS/SSL server certificate validity
(default enabled)
This ensures that the server certificate is
valid (i.e. signed by an approved
Certification Authority). (default enabled)
--tls-check-hostname, --no-tls-check-hostname
Check TLS/SSL server hostname in certificate
(default enabled)
This ensures that the server hostname in
certificate matches the requested host name.
(default enabled)

Goom effect
--goom-width <integer> Goom display width
This allows you to set the resolution of the
Goom display (bigger resolution will be
prettier but more CPU intensive).
--goom-height <integer> Goom display height
This allows you to set the resolution of the
Goom display (bigger resolution will be
prettier but more CPU intensive).
--goom-speed <integer> Goom animation speed
This allows you to set the animation speed
(between 1 and 10, defaults to 6).

Growl Notification Plugin
--growl-server <string> Growl server
This is the host to which Growl notifications
will be sent. By default, notifications are
sent locally.
--growl-password <string> Growl password
Growl password on the server.

Headphone channel mixer with virtual spatialization effect
--headphone-dim <integer> Characteristic dimension
Distance between front left speaker and
listener in meters.

Image video output
--image-out-format {png,jpeg}
Image format
Set the format of the output image.
--image-out-ratio <integer>
Recording ratio
Set the ratio of images that are recorded. 3
means that one image out of three is recorded.
--image-out-prefix <string>
Filename prefix
Set the prefix of the filename. Output
filename will have the form prefixNUMBER.forma
t
--image-out-replace, --no-image-out-replace
Always write to the same file (default
disabled)
Always write to the same file (default
disabled)

File logging
--logfile <string> Log filename
Specify the log filename.
--logmode {text,html} Log format
Specify the log format. Available choices are
"text" (default) and "html".

Logo video filter
--logo-file <string> Logo filenames
Full path of the image files to use. Format
is <image>[,<delay in ms>[,<alpha>]][;<image>[
,<delay>[,<alpha>]]][;...] .
--logo-transparency <integer>
Transparency of the logo
You can set the logo transparency value here
(from 0 for full transparency to 255 for full
opacity).
--logo-position {0 (Center), 1 (Left), 2 (Right), 4 (Top), 8 (Bottom), 5 (Top-Left), 6 (Top-Right), 9 (Bottom-Left), 10 (Bottom-Right)}
Logo position
You can enforce the logo position on the
video (0=center, 1=left, 2=right, 4=top,
8=bottom, you can also use combinations of
these values).

Marquee display sub filter
--marq-marquee <string> Marquee text
Marquee text to display
--marq-position <integer> Marquee position
You can enforce the marquee position on the
video (0=center, 1=left, 2=right, 4=top,
8=bottom, you can also use combinations of
these values by adding them).
--marq-opacity <integer> Opacity
The opacity (inverse of transparency) of
overlay text. 0 = transparent, 255 = totally
opaque.
--marq-color {-268435456 (Default), 0 (Black), 8421504 (Gray), 12632256 (Silver), 16777215 (White), 8388608 (Maroon), 16711680 (Red), 16711935 (Fuchsia), 16776960 (Yellow), 8421376 (Olive), 32768 (Green), 32896 (Teal), 65280 (Lime), 8388736 (Purple), 128 (Navy), 255 (Blue), 65535 (Aqua)}
Text Default Color
The color of overlay text. 1 byte for each
color, hexadecimal. #000000 = all colors off,
0xFF0000 = just Red, 0xFFFFFF = all color on
[White]
--marq-size <integer> Font size, pixels
Specify the font size, in pixels, with -1 =
use freetype-fontsize
--marq-timeout <integer> Marquee timeout
Defines the time the marquee must remain
displayed, in milliseconds. Default value is
0 (remain forever).

M-JPEG camera demuxer
--mjpeg-fps <float> Frames per Second
This is the desired frame rate when playing
MJPEG from a file. Use 0 (this is the default
value) for a live stream (from a camera).

MOD demuxer (libmodplug)
--mod-noisereduction, --no-mod-noisereduction
Noise reduction (default enabled)
Enable noise reduction algorithm (default
enabled)
--mod-reverb, --no-mod-reverb
Reverb (default disabled)
Enable reverberation (default disabled)
--mod-megabass, --no-mod-megabass
Mega bass (default disabled)
Enable megabass mode (default disabled)
--mod-surround, --no-mod-surround
Surround (default disabled)
Surround (default disabled)

Mosaic video sub filter
--mosaic-alpha <integer> Alpha blending
Alpha blending (0 -> 255). Default is 255
--mosaic-height <integer> Height in pixels
Height in pixels
--mosaic-width <integer> Width in pixels
Width in pixels
--mosaic-position {0 (auto), 1 (fixed)}
Positioning method
Positioning method. auto: automatically
choose the best number of rows and columns.
fixed: use the user-defined number of rows
and columns.
--mosaic-rows <integer> Number of rows
Number of rows
--mosaic-cols <integer> Number of columns
Number of columns
--mosaic-keep-aspect-ratio, --no-mosaic-keep-aspect-ratio
Keep aspect ratio when resizing (default
disabled)
Keep aspect ratio when resizing (default
disabled)
--mosaic-keep-picture, --no-mosaic-keep-picture
Keep original size (default disabled)
Keep original size (default disabled)
--mosaic-order <string> Order as a comma separated list of
picture-id(s)
Order as a comma separated list of
picture-id(s)
--mosaic-delay <integer> Delay
Pictures coming from the picture video
outputs will be delayed accordingly (in
milliseconds). For high values you will need
to raise file-caching and others.
--mosaic-bs, --no-mosaic-bs
Enable bluescreen (aka greenscreen or chroma
key) video background replacing (default
disabled)
Enable bluescreen (aka greenscreen or chroma
key) video background replacing (default
disabled)
--mosaic-bsu <integer> Bluescreen chroma key U (0-255)
Bluescreen chroma key U (0-255)
--mosaic-bsv <integer> Bluescreen chroma key V (0-255)
Bluescreen chroma key V (0-255)
--mosaic-bsut <integer> Bluescreen chroma key U tolerance
Bluescreen chroma key U tolerance
--mosaic-bsvt <integer> Bluescreen chroma key V tolerance
Bluescreen chroma key V tolerance

Motion blur filter
--blur-factor <integer> Blur factor (1-127)
The degree of blurring from 1 to 127.

Motion detect video filter
--motiondetect-history <integer>
History parameter
History parameter, number of frames used for
detection
--motiondetect-description <string>
Description file
Description file, file containing simple
playlist

MusePack demuxer
--mpc-replaygain-type {0 (None), 1 (Title), 2 (Album)}
Replay Gain type
Musepack can have a title-specific replay
gain (volume control) or an album-specific
one. Choose which type you want to use

MSN Now-Playing
--msn-format <string> MSN Title format string
Format of the string to send to MSN {0}
Artist, {1} Title, {2} Album. Defaults to
"Artist - Title" ({0} - {1}).

OpenGL video output
--opengl-effect {none,cube,transparent-cube}
Select effect
Allows you to select different visual effects.

On Screen Display menu subfilter
--osdmenu-x <integer> X coordinate of the OSD menu
You can move the OSD menu by left-clicking on
it.
--osdmenu-y <integer> Y coordinate of the OSD menu
You can move the OSD menu by left-clicking on
it.
--osdmenu-position {0 (Center), 1 (Left), 2 (Right), 4 (Top), 8 (Bottom), 5 (Top-Left), 6 (Top-Right), 9 (Bottom-Left), 10 (Bottom-Right)}
OSD menu position
You can enforce the OSD menu position on the
video (0=center, 1=left, 2=right, 4=top,
8=bottom, you can also use combinations of
these values).
--osdmenu-file <string> OSD menu configuration file
An OSD menu configuration file that menu
actions with button images
--osdmenu-file-path <string>
Path to OSD menu images
Specify another path to the OSD menu images.
This will override the path as defined in the
OSD configuration file.
--osdmenu-timeout <integer>
Timeout of OSD menu
OSD menu pictures get a default timeout of 15
seconds added to their remaining time. This
will ensure that they are at least the
specified time visible.

Parametric Equalizer
--param-eq-lowf <float> Low freq (Hz)
--param-eq-lowgain <float> Low freq gain (Db)
--param-eq-highf <float> High freq (Hz)
--param-eq-highgain <float>
High freq gain (Db)
--param-eq-f1 <float> Freq 1 (Hz)
--param-eq-gain1 <float> Freq 1 gain (Db)
--param-eq-q1 <float> Freq 1 Q
--param-eq-f2 <float> Freq 2 (Hz)
--param-eq-gain2 <float> Freq 2 gain (Db)
--param-eq-q2 <float> Freq 2 Q
--param-eq-f3 <float> Freq 3 (Hz)
--param-eq-gain3 <float> Freq 3 gain (Db)
--param-eq-q3 <float> Freq 3 Q

Playlist
--playlist-autostart, --no-playlist-autostart
Auto start (default enabled)
Automatically start playing the playlist
content once it's loaded.
(default enabled)

Podcasts
--podcast-urls <string> Podcast URLs list
Enter the list of podcasts to retrieve,
separated by '|' (pipe).

PORTAUDIO audio output
--portaudio-device <integer>
Output device
Portaudio identifier for the output device

Remote control interface
--rc-quiet, --no-rc-quiet Do not open a DOS command box interface
(default disabled)
By default the rc interface plugin will start
a DOS command box. Enabling the quiet mode
will not bring this command box but can also
be pretty annoying when you want to stop VLC
and no video window is open. (default
disabled)

RSS and Atom feed display
--rss-urls <string> RSS/Atom feed URLs
RSS/Atom feed '|' (pipe) seperated URLs
--rss-position {0 (Center), 1 (Left), 2 (Right), 4 (Top), 8 (Bottom), 5 (Top-Left), 6 (Top-Right), 9 (Bottom-Left), 10 (Bottom-Right)}
Marquee position
You can enforce the marquee position on the
video (0=center, 1=left, 2=right, 4=top,
8=bottom, you can also use combinations of
these values by adding them).
--rss-opacity <integer> Opacity
The opacity (inverse of transparency) of
overlay text. 0 = transparent, 255 = totally
opaque.
--rss-color {-268435456 (Default), 0 (Black), 8421504 (Gray), 12632256 (Silver), 16777215 (White), 8388608 (Maroon), 16711680 (Red), 16711935 (Fuchsia), 16776960 (Yellow), 8421376 (Olive), 32768 (Green), 32896 (Teal), 65280 (Lime), 8388736 (Purple), 128 (Navy), 255 (Blue), 65535 (Aqua)}
Text Default Color
The color of overlay text. 1 byte for each
color, hexadecimal. #000000 = all colors off,
0xFF0000 = just Red, 0xFFFFFF = all color on
[White]
--rss-size <integer> Font size, pixels
Specify the font size, in pixels, with -1 =
use freetype-fontsize
--rss-speed <integer> RSS/Atom feed speed
RSS/Atom feed speed (bigger is slower)
--rss-length <integer> RSS/Atom feed max number of chars displayed
RSS/Atom feed max number of chars displayed
--rss-ttl <integer> Number of seconds between each forced refresh
of the feeds
Number of seconds between each forced refresh
of the feeds. If 0, the feeds will never be
updated.
--rss-images, --no-rss-images
Display feed images if available (default
enabled)
Display feed images if available (default
enabled)

Skinnable Interface
--skins2-transparency, --no-skins2-transparency
Enable transparency effects (default disabled)
You can disable all transparency effects if
you want. This is mainly useful when moving
windows does not behave correctly. (default
disabled)

Bridge stream output
--sout-bridge-out-id <integer>
ID
Specify an identifier for this elementary
stream.
--sout-bridge-in-delay <integer>
Delay
Pictures coming from the picture video
outputs will be delayed accordingly (in
milliseconds, >= 100 ms). For high values,
you will need to raise file-caching and
others.
--sout-bridge-in-id-offset <integer>
ID Offset
Offset to add to the stream IDs specified in
bridge_out to obtain the stream IDs bridge_in
will register.

Mosaic bridge stream output
--sout-mosaic-bridge-id <string>
ID
Specify an identifier string for this
subpicture
--sout-mosaic-bridge-sar <string>
Sample aspect ratio
Sample aspect ratio of the destination (1:1,
3:4, 2:3).

RTP stream output
--sout-rtp-mp4a-latm, --no-sout-rtp-mp4a-latm
MP4A LATM (default disabled)
This allows you to stream MPEG4 LATM audio
streams (see RFC3016). (default disabled)

Standard stream output
--sout-standard-access <string>
Output access method
This is the output access method that will be
used.
--sout-standard-mux <string>
Output muxer
This is the muxer that will be used.
--sout-standard-dst <string>
Output destination
This is the destination (URL) that will be
used for the stream.

Transcode stream output
--sout-transcode-venc <string>
Video encoder
This is the video encoder module that will be
used (and its associated options).
--sout-transcode-vcodec <string>
Destination video codec
This is the video codec that will be used.
--sout-transcode-vb <integer>
Video bitrate
Target bitrate of the transcoded video stream.
--sout-transcode-scale <float>
Video scaling
Scale factor to apply to the video while
transcoding (eg: 0.25)
--sout-transcode-fps <float>
Video frame-rate
Target output frame rate for the video stream.
--sout-transcode-hurry-up, --no-sout-transcode-hurry-up
Hurry up (default enabled)
The transcoder will drop frames if your CPU
can't keep up with the encoding rate.
(default enabled)
--sout-transcode-deinterlace, --no-sout-transcode-deinterlace
Deinterlace video (default disabled)
Deinterlace the video before encoding.
(default disabled)
--sout-transcode-deinterlace-module {deinterlace,ffmpeg-deinterlace}
Deinterlace module
Specify the deinterlace module to use.
--sout-transcode-vfilter <string>
Video filter
Video filters will be applied to the video
streams (after overlays are applied). You
must enter a comma-separated list of filters.
--sout-transcode-canvas-aspect <string>
Video canvas aspect ratio
This sets aspect (like 4:3) of the video
canvas and letterbox the video accordingly.
--sout-transcode-aenc <string>
Audio encoder
This is the audio encoder module that will be
used (and its associated options).
--sout-transcode-acodec <string>
Destination audio codec
This is the audio codec that will be used.
--sout-transcode-ab <integer>
Audio bitrate
Target bitrate of the transcoded audio stream.
--sout-transcode-channels <integer>
Audio channels
Number of audio channels in the transcoded
streams.
--sout-transcode-audio-sync, --no-sout-transcode-audio-sync
Synchronise on audio track (default disabled)
This option will drop/duplicate video frames
to synchronise the video track on the audio
track. (default disabled)
--sout-transcode-senc <string>
Subtitles encoder
This is the subtitles encoder module that
will be used (and its associated options).
--sout-transcode-scodec <string>
Destination subtitles codec
This is the subtitles coded that will be used.
--sout-transcode-soverlay, --no-sout-transcode-soverlay
Destination subtitles codec (default disabled)
This is the subtitles coded that will be
used. (default disabled)
--sout-transcode-sfilter <string>
Overlays
This allows you to add overlays (also known
as "subpictures" on the transcoded video
stream. The subpictures produced by the
filters will be overlayed directly onto the
video. You must specify a comma-separated
list of subpicture modules
--sout-transcode-osd, --no-sout-transcode-osd
OSD menu (default disabled)
Stream the On Screen Display menu (using the
osdmenu subpicture module). (default disabled)

Text subtitles decoder
--subsdec-align {0 (Center), 1 (Left), 2 (Right)}
Subtitles justification
Set the justification of subtitles
--subsdec-encoding {Default,ASCII,UTF-8,,ISO-8859-1,CP1252,MacRoman,MacIceland,ISO-8859-15,,ISO-8859-2,CP1250,MacCentralEurope,MacCroatian,MacRomania,,ISO-8859-5,CP1251,MacCyrillic,MacUkraine,KOI8-R,KOI8-U,KOI8-RU,,ISO-8859-6,CP1256,MacArabic,,ISO-8859-7,CP1253,MacGreek,,ISO-8859-8,CP1255,MacHebrew,,ISO-8859-9,CP1254,MacTurkish,,ISO-8859-13,CP1257,,ISO-2022-JP,ISO-2022-JP-1,ISO-2022-JP-2,EUC-JP,SHIFT_JIS,,ISO-2022-CN,ISO-2022-CN-EXT,EUC-CN,EUC-TW,BIG5,BIG5-HKSCS,,ISO-2022-KR,EUC-KR,,MacThai,KOI8-T,,ISO-8859-3,ISO-8859-4,ISO-8859-10,ISO-8859-14,ISO-8859-16,,CP850,CP862,CP866,CP874,CP932,CP949,CP950,CP1133,CP1258,,Macintosh,,UTF-7,UTF-16,UTF-16BE,UTF-16LE,UTF-32,UTF-32BE,UTF-32LE,C99,JAVA,UCS-2,UCS-2BE,UCS-2LE,UCS-4,UCS-4BE,UCS-4LE,,HZ,GBK,GB18030,JOHAB,ARMSCII-8,Georgian-Academy,Georgian-PS,TIS-620,MuleLao-1,VISCII,TCVN,HPROMAN8,NEXTSTEP}
Subtitles text encoding
Set the encoding used in text subtitles
--subsdec-autodetect-utf8, --no-subsdec-autodetect-utf8
UTF-8 subtitles autodetection (default
enabled)
This enables automatic detection of UTF-8
encoding within subtitles files. (default
enabled)
--subsdec-formatted, --no-subsdec-formatted
Formatted Subtitles (default enabled)
Some subtitle formats allow for text
formatting. VLC partly implements this, but
you can choose to disable all formatting.
(default enabled)

Theora video decoder
--sout-theora-quality <integer>
Encoding quality
Allows you to specify a quality between 1
(low) and 10 (high), instead of specifying a
particular bitrate. This will produce a VBR
stream.

Time display sub filter
--time-position {0 (Center), 1 (Left), 2 (Right), 4 (Top), 8 (Bottom), 5 (Top-Left), 6 (Top-Right), 9 (Bottom-Left), 10 (Bottom-Right)}
Time position
You can enforce the time position on the
video (0=center, 1=left, 2=right, 4=top,
8=bottom, you can also use combinations of
these values by adding them).
--time-opacity <integer> Opacity
The opacity (inverse of transparency) of
overlay text. 0 = transparent, 255 = totally
opaque.
--time-color {-268435456 (Default), 0 (Black), 8421504 (Gray), 12632256 (Silver), 16777215 (White), 8388608 (Maroon), 16711680 (Red), 16711935 (Fuchsia), 16776960 (Yellow), 8421376 (Olive), 32768 (Green), 32896 (Teal), 65280 (Lime), 8388736 (Purple), 128 (Navy), 255 (Blue), 65535 (Aqua)}
Text Default Color
The color of overlay text. 1 byte for each
color, hexadecimal. #000000 = all colors off,
0xFF0000 = just Red, 0xFFFFFF = all color on
[White]
--time-size <integer> Font size, pixels
Specify the font size, in pixels, with -1 =
use freetype-fontsize

Video transformation filter
--transform-type {90,180,270,hflip,vflip}
Transform type
One of '90', '180', '270', 'hflip' and 'vflip'

MPEG Transport Stream demuxer
--ts-dump-file <string> Filename of dump
Specify a filename where to dump the TS in.
--ts-dump-append, --no-ts-dump-append
Append (default disabled)
If the file exists and this option is
selected, the existing file will not be
overwritten. (default disabled)

Libtwolame audio encoder
--sout-twolame-quality <float>
Encoding quality
Allows you to specify a quality between 0.0
(high) and 50.0 (low), instead of specifying
a particular bitrate. This will produce a VBR
stream.
--sout-twolame-mode {0 (Stereo), 1 (Dual mono), 2 (Joint stereo)}
Stereo mode
Select how stereo streams will be handled
--sout-twolame-vbr, --no-sout-twolame-vbr
VBR mode (default disabled)
By default the encoding is CBR. (default
disabled)
--sout-twolame-psy <integer>
Psycho-acoustic model
Integer from -1 (no model) to 4.

Visualizer filter
--effect-width <integer> Video width
The width of the effects video window, in
pixels.
--effect-height <integer> Video height
The height of the effects video window, in
pixels.

Vorbis audio decoder
--sout-vorbis-quality <integer>
Encoding quality
Allows you to specify a quality between 1
(low) and 10 (high), instead of specifying a
particular bitrate. This will produce a VBR
stream.
--sout-vorbis-max-bitrate <integer>
Maximum encoding bitrate
Allows you to specify a maximum bitrate in
kbps. Useful for streaming applications.
--sout-vorbis-min-bitrate <integer>
Minimum encoding bitrate
Allows you to specify a minimum bitrate in
kbps. Useful for encoding for a fixed-size
channel.
--sout-vorbis-cbr, --no-sout-vorbis-cbr
CBR encoding (default disabled)
Allows you to force a constant bitrate
encoding (CBR). (default disabled)

Wall video filter
--wall-cols <integer> Number of columns
Select the number of horizontal video windows
in which to split the video.
--wall-rows <integer> Number of rows
Select the number of vertical video windows
in which to split the video.
--wall-element-aspect <string>
Element aspect ratio
The aspect ratio of the individual displays
building the display wall

wxWidgets interface module
--wx-embed, --no-wx-embed Embed video in interface (default enabled)
Embed the video inside the interface instead
of having it in a separate window. (default
enabled)
--wx-bookmarks, --no-wx-bookmarks
Show bookmarks dialog (default disabled)
Show bookmarks dialog when the interface
starts. (default disabled)
--wx-taskbar, --no-wx-taskbar
Show taskbar entry (default enabled)
Show taskbar entry (default enabled)
--wx-extended, --no-wx-extended
Show extended GUI (default disabled)
Show extended GUI (default disabled)
--wx-playlist-view {0 (Normal), 1 (Embedded), 2 (Both)}
Playlist view
There are two possible playlist views in the
interface : the normal playlist (separate
window), or an embedded playlist (within the
main interface, but with less features. You
can select which one will be available on the
toolbar (or both).
--wx-systray, --no-wx-systray
Show systray icon (default disabled)
Show systray icon (default disabled)

H.264/MPEG4 AVC encoder (using x264 library)
--sout-x264-keyint <integer>
Maximum GOP size
Sets maximum interval between
IDR-frames.Larger values save bits, thus
improve quality for a given bitrate at the
cost of seeking precision.
--sout-x264-min-keyint <integer>
Minimum GOP size
Sets minimum interval between IDR-frames. In
H.264, I-frames do not necessarily bound a
closed GOP because it is allowable for a
P-frame to be predicted from more frames than
just the one frame before it (also see
frameref). Therefore, I-frames are not
necessarily seekable. IDR-Frames restrict
subsequent P-frames from referring to any
frame prior to the IDR-Frame.
If scenecuts
appear within this interval, they are still
encoded as I-frames, but do not start a new
GOP.
--sout-x264-scenecut <integer>
How aggressively to insert extra I-frames (-1
to 100)
Scene-cut detection. Controls how
aggressively to insert extra I-frames. With
small values of scenecut, the codec often has
to force an I-frame when it would exceed
keyint. Good values of scenecut may find a
better location for the I-frame. Large values
use more I-frames than necessary, thus
wasting bits. -1 disables scene-cut
detection, so I-frames are be inserted only
every other keyint frames, which probably
leads to ugly encoding artifacts.
--sout-x264-bframes <integer>
Number of B-frames between I and P (1 to 16)
Number of consecutive B-frames between I and
P-frames.
--sout-x264-b-adapt, --no-sout-x264-b-adapt
Adaptive B-frame decision (default enabled)
If this is on, the specified number of
consecutive B-frames will always be used,
except possibly before an I-frame. (default
enabled)
--sout-x264-b-bias <integer>
Influences how often B-frames are used
Bias the choice to use B-frames. Positive
values cause more B-frames, negative values
cause less B-frames.
--sout-x264-bpyramid, --no-sout-x264-bpyramid
Keep some B-frames as references (default
disabled)
Allows B-frames to be used as references for
predicting other frames. Keeps the middle of
2+ consecutive B-frames as a reference, and
reorders frame appropriately. (default
disabled)
--sout-x264-cabac, --no-sout-x264-cabac
CABAC (default enabled)
CABAC (Context-Adaptive Binary Arithmetic
Coding). Slightly slows down encoding and
decoding, but should save 10-15% bitrate.
(default enabled)
--sout-x264-ref <integer> Number of reference frames (1 to 16)
Number of previous frames used as predictors.
This is effective in Anime, but seems to make
little difference in live-action source
material. Some decoders are unable to deal
with large frameref values.
--sout-x264-nf, --no-sout-x264-nf
No loop filter (enabling turns off the
deblocking loop filter) (default disabled)
Deblocking loop filter (increases quality).
(default disabled)
--sout-x264-qp <integer> Set QP (0=lossless) (0 to 51)
This selects the quantizer to use. Lower
values result in better fidelity, but higher
bitrates. 26 is a good default value.
--sout-x264-crf <integer> Quality-based VBR (nominal QP) (0 to 51)
1-pass Quality-based VBR.
--sout-x264-qpmin <integer>
Set min QP
Minimum quantizer, 15/35 seems to be a useful
range.
--sout-x264-qpmax <integer>
Set max QP
Maximum quantizer parameter.
--sout-x264-qpstep <integer>
Set max QP step
Max QP step between frames.
--sout-x264-ratetol <float>
Allowed variance of average bitrate
Sets the allowed variance in average. bitrate.
--sout-x264-vbv-maxrate <integer>
Max local bitrate
Sets a maximum local bitrate in kbits/s.
--sout-x264-vbv-bufsize <integer>
Size of VBV buffer
Sets an averaging period for the maximum
local bitrate in kbits/s.
--sout-x264-vbv-init <float>
Initial VBV buffer occupancy
Sets the initial buffer occupancy as a
fraction of the buffer size.
--sout-x264-ipratio <float>
QP factor between I and P
QP factor between I and P.
--sout-x264-pbratio <float>
QP factor between P and B
QP factor between P and B.
--sout-x264-chroma-qp-offset <integer>
QP difference between chroma and luma
QP difference between chroma and luma.
--sout-x264-qcomp <float> QP curve compression (0.0=CBR to 1.0=QCP)
QP curve compression.
--sout-x264-cplxblur <float>
Reduce fluctuations in QP (before curve
compression)
Temporally blur complexity.
--sout-x264-qblur <float> Reduce fluctuations in QP (after curve
compression)
Temporally blur quants.
--sout-x264-analyse {,none,fast,normal,slow,all}
Partitions to consider
Partitions to consider in analyse mode:
-
none :
- fast : i4x4
- normal:
i4x4,p8x8,(i8x8)
- slow : i4x4,p8x8,(i8x8),b
8x8
- all : i4x4,p8x8,(i8x8),b8x8,p4x4
(p4x
4 requires p8x8. i8x8 requires 8x8dct).
--sout-x264-direct {,none,spatial,temporal}
Direct MV prediction mode
Direct MV prediction mode.
--sout-x264-weightb, --no-sout-x264-weightb
Weighted prediction for B-frames (default
disabled)
Weighted prediction for B-frames. (default
disabled)
--sout-x264-me {,dia,hex,umh,esa}
Integer pixel motion estimation method
Selects the motion estimation algorithm: -
dia: diamond search, radius 1 (fast)
- hex:
hexagonal search, radius 2
- umh: uneven
multi-hexagon search (better but slower)
-
esa: exhaustive search (extremely slow,
primarily for testing)

--sout-x264-merange <integer>
Maximum motion vector search range (0 to 64)
Maximum distance to search for motion
estimation, measured from predicted
position(s). Default of 16 is good for most
footage, high motion sequences may benefit
from settings between 24-32.
--sout-x264-subme <integer>
Subpixel motion estimation and partition
decision quality (1 to 6)
This parameter controls quality versus speed
tradeoffs involved in the motion estimation
decision process (lower = quicker and higher
= better quality).
--sout-x264-b-rdo, --no-sout-x264-b-rdo
RD based mode decision for B-frames. Requires
subme 6 (default disabled)
RD based mode decision for B-frames.
(default disabled)
--sout-x264-mixed-refs, --no-sout-x264-mixed-refs
Decide references on a per partition basis
(default disabled)
Allows each 8x8 or 16x8 partition to
independently select a reference frame, as
opposed to only one ref per macroblock.
(default disabled)
--sout-x264-chroma-me, --no-sout-x264-chroma-me
Ignore chroma in motion estimation (default
enabled)
Chroma ME for subpel and mode decision in
P-frames. (default enabled)
--sout-x264-bime, --no-sout-x264-bime
Jointly optimize both MVs in B-frames
(default disabled)
Joint bidirectional motion refinement.
(default disabled)
--sout-x264-8x8dct, --no-sout-x264-8x8dct
Adaptive spatial transform size (default
disabled)
SATD-based decision for 8x8 transform in
inter-MBs. (default disabled)
--sout-x264-trellis <integer>
Trellis RD quantization (0,1,2). Requires
CABAC
Trellis RD quantization:
- 0: disabled
-
1: enabled only on the final encode of a MB

- 2: enabled on all mode decisions

--sout-x264-fast-pskip, --no-sout-x264-fast-pskip
Early SKIP detection on P-frames (default
enabled)
Early SKIP detection on P-frames. (default
enabled)
--sout-x264-nr <integer> Noise reduction
Dct-domain noise reduction. Adaptive
pseudo-deadzone.
--sout-x264-asm, --no-sout-x264-asm
CPU optimizations (default enabled)
CPU optimizations. (default enabled)
--sout-x264-psnr, --no-sout-x264-psnr
PSNR calculation (default disabled)
This has no effect on actual encoding
quality, it just prevents the stats from
being calculated (for speed). (default
disabled)
--sout-x264-verbose, --no-sout-x264-verbose
Print stats for each frame (default disabled)
Print stats for each frame. (default disabled)

DirectShow input
--dshow-vdev {,none} Video device name
You can specify the name of the video device
that will be used by the DirectShow plugin.
If you don't specify anything, the default
device will be used.
--dshow-adev {,none} Audio device name
You can specify the name of the audio device
that will be used by the DirectShow plugin.
If you don't specify anything, the default
device will be used.
--dshow-size <string> Video size
You can specify the size of the video that
will be displayed by the DirectShow plugin.
If you don't specify anything the default
size for your device will be used.
</nowiki>

ActiveX/Delphi

2006-03-11T17:49:24Z

Hogi: Alternative way to bring VLC to Delphi

{{howto| use the [[ActiveX]] control with Delphi}}

==Getting started==
===What you need===
* Borland Delphi 3 or newer
* a running System with Microsoft Windows
* [http://www.videolan.org/ VideoLan] including the [[ActiveX]] Plugin installed

===Import the ActiveX-Component===
*Start your Borland Delphi
*< Delphi2005: Select Components --> Import ActiveX --> VideoLan VLC ActiveX Plugin
*>= Delphi 2006: Select Components --> Import component --> Import ActiveX Control --> VideoLan VLC ActiveX Plugin
*Otherwise try creating a new package using the created ''AXVLC_TLB.pas''

===Confirm successfull installation===
*You should now be able to add the ''TVLCPlugin'' from the ActiveX-Tab of your Component toolbox.

==Usage Development-Time==
The VLC-Player Object ''TVLCPlugin'' can be found in your ActiveX-Components Tabsheet.
Place one of it in your Form1, place a TButton and use the following code:

unit Unit1;

interface

uses
Windows, Variants, Forms, Classes, Controls, StdCtrls, OleCtrls,
AXVLC_TLB;

type
TForm1 = class(TForm)
VLCPlugin1: TVLCPlugin;
Button1: TButton;
procedure Button1Click(Sender: TObject);
private
{ Private-Deklarationen }
public
{ Public-Deklarationen }
end;

type
VLCPlaylistMode = TOleEnum;

const
VLCPlayListInsert = $00000001;
VLCPlayListReplace = $00000002;
VLCPlayListAppend = $00000004;
VLCPlayListGo = $00000008;
VLCPlayListCheckInsert = $00000010;

var
Form1: TForm1;

implementation

{$R *.dfm}

procedure TForm1.Button1Click(Sender: TObject);
begin
VLCPlugin1.addTarget('C:\video.mpg', null, VLCPlayListInsert, 0);
// you can use any MRL with parameters instead of 'c:\video.mpg' here
VLCPlugin1.play;
end;

end.

==Usage Runtime==
If you're planning to use the VLC-Player in your application but don't know when and where, use this code to create the component on-demand.

unit Unit1;

interface

uses
Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms, OleCtrls,
AXVLC_TLB, StdCtrls, Registry, Dialogs;

type
TForm1 = class(TForm)
Button1: TButton;
Button2: TButton;
procedure Button2Click(Sender: TObject);
procedure Button1Click(Sender: TObject);
private
{ Private-Deklarationen }
public
{ Public-Deklarationen }
end;

var
Form1: TForm1;
VLCPlugin1: TVLCPlugin;
blVLCPluginFound: boolean;

type
VLCPlaylistMode = TOleEnum;

const
VLCPlayListInsert = $00000001;
VLCPlayListReplace = $00000002;
VLCPlayListAppend = $00000004;
VLCPlayListGo = $00000008;
VLCPlayListCheckInsert = $00000010;

implementation

{$R *.dfm}

procedure TForm1.Button1Click(Sender: TObject);
var
Reg: TRegistry;
begin
blVLCPluginFound := false;

// Is VLC ActiveX Plugin installed on this PC?
Reg := TRegistry.Create;
try
Reg.RootKey := HKEY_LOCAL_MACHINE;
if Reg.OpenKeyReadOnly('\Software\Classes\VideoLAN.VLCPlugin.1\') then begin
blVLCPluginFound := true;
end;
finally
FreeAndNil(Reg);
end;

if blVLCPluginFound then begin
VLCPlugin1 := TVLCPlugin.Create(Self);
VLCPlugin1.Parent := Self; // Means: Place the VLC-Player into Form1
VLCPlugin1.Width := 400;
VLCPlugin1.Height := 300;
VLCPlugin1.Top := 50;
VLCPlugin1.Left := 50;
VLCPlugin1.Show;
VLCPlugin1.addTarget('C:\video.mpg', null, VLCPlayListInsert, 0);
// you can use any MRL with parameters instead of 'c:\video.mpg' here
VLCPlugin1.play;
end else begin
ShowMessage('I am really sorry, but VLC (or its ActiveX Plugin) is currently not installed on this PC!');
end;
end;

procedure TForm1.Button2Click(Sender: TObject);
begin
if blVLCPluginFound then begin
VLCPlugin1.stop;
FreeAndNil(VLCPlugin1);
end;
end;

end.

==Alternative way to bring VLC to your Delphi Application==
Much easier way to bring VLC to your Delphi Application is to paste a TWebbrowser Object in your Form, is generate Code for the HTML and m3u file and let the Webbrowser load the HTML-file. For detailed information have a look at [[ActiveX/HTML]].

==See also==
[[ActiveX/HTML]]

ActiveX/HTML

2006-03-11T17:41:44Z

Hogi: How-to embed ActiveX using m3u playlists instead of javascript

==Embedding Activex using Javascript==

You can insert the [[ActiveX]] control in your HTML pages like this :

<OBJECT classid="clsid:E23FE9C6-778E-49D4-B537-38FCDE4887D8"
codebase="http://downloads.videolan.org/pub/videolan/vlc/latest/win32/axvlc.cab"
width="640" height="480" id="vlc" events="True">
<param name="Src" value="" />
<param name="ShowDisplay" value="True" />
<param name="AutoLoop" value="False" />
<param name="AutoPlay" value="False" />
</OBJECT>

Then, using Javascript, you can select another source, or change the audio track :

document.vlc.playlistClear();
var options=[":audio-track=5"]; // select audio track 5 (=6th, 1st is 0)
document.vlc.addTarget("...",options,2,0); // replace entry 0
document.vlc.play();

==Embedding ActiveX using m3u Playlists==
Maybe a better to show VLC in an HTML Website is to use m3u Playlists. It has got the advantage that users with turned-off Javascript can also use this plugin, since document.vlc.addTarget won't work with javascript turned off.

* Step 1: Create the HTML website with the VLC-Object linked to the m3u playlist
* Step 2: Create your m3u playlist with all options, save and upload it to your webspace.
* Step 3 (optional): Create buttons and other objects to control VLC (like document.vlc.play();)

'''Step 1: Creating the website to embed ActiveX Control'''
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
<HTML>
<BODY marginwidth="0" marginheight="0" topmargin="0" leftmargin="0">
<OBJECT classid="clsid:E23FE9C6-778E-49D4-B537-38FCDE4887D8"
codebase="http://downloads.videolan.org/pub/videolan/vlc/latest/win32/axvlc.cab"
width="400" height="300" id="vlc" events="True">
<param name="Src" value="myplaylist.m3u" />
<param name="ShowDisplay" value="True" />
<param name="AutoLoop" value="True" />
<param name="AutoPlay" value="True" />
<param name="Volume" value="100">
</OBJECT>
</BODY>
</HTML>
You should modify the values of width, height and volume (0-100) fitting to your desires. If you don't know them, simply delete them (e.g. remove ''width="640"'' from the code).

'''Step 2: Creating the m3u playlist'''

Open Notepad, create your playlist and save it as 'myplaylist.m3u' for this example.
#EXTM3U // Required to identify this file as m3u file
#EXTVLCOPT--input-repeat=-1 // repeat the following file/playlist
#EXTVLCOPT--http-reconnect=true // required for a streaming-client to enable repeat
#EXTVLCOPT--any further parameter goes here // see also [[VLC command-line help]]
#EXTINF:0, Test Description // set the title for the following file shown in your playlist
video.mpg // the actual file to be displayed

'''Annotations:'''
* For actual looping of the entire playlist, the user has to have check 'Repeat all' under Preferences --> Playlist --> General
* Mind that options have different names if you play a file locally or if you want to stream it (--sub-filter --> --s-filter)

'''Mind the different Options-styles:'''
--option A global option that is set for the duration of the program.
-option A single letter version of a global --option.
:option An option that only applies to the playlistitem directly before it
and that overrides previous settings.

==See also==
*[[ActiveX/Delphi|Delphi Implementation]]

* [[ActiveX|ActiveX Description]]

ActiveX/HTML

2006-03-06T10:26:15Z

Hogi:

You can insert the [[ActiveX]] control in your HTML pages like this :

<OBJECT classid="clsid:E23FE9C6-778E-49D4-B537-38FCDE4887D8"
codebase="http://downloads.videolan.org/pub/videolan/vlc/latest/win32/axvlc.cab"
width="640" height="480" id="vlc" events="True">
<param name="Src" value="" />
<param name="ShowDisplay" value="True" />
<param name="AutoLoop" value="False" />
<param name="AutoPlay" value="False" />
</OBJECT>

Then, using Javascript, you can select another source, or change the audio track :

document.vlc.playlistClear();
var options=[":audio-track=5"]; // select audio track 5 (=6th, 1st is 0)
document.vlc.addTarget("...",options,2,0); // replace entry 0
document.vlc.play();

==See also==
*[[ActiveX/Delphi|Delphi Implementation]]

* [[ActiveX|ActiveX Description]]

ActiveX/Delphi

2006-02-14T13:40:11Z

Hogi: /* Usage Runtime */

ActiveX/Delphi

2006-01-20T17:03:47Z

Hogi: /* Usage Development-Time */

{{howto| use the [[ActiveX]] control with Delphi}}

==Getting started==
===What you need===
* Borland Delphi 3 or newer
* a running System with Microsoft Windows
* [[VideoLan|http://www.videolan.org/]] including the ActiveX Plugin installed

===Import the ActiveX-Component===
*Start your Borland Delphi
*< Delphi2005: Select Components --> Import ActiveX --> VideoLan VLC ActiveX Plugin
*>= Delphi 2006: Select Components --> Import component --> Import ActiveX Control --> VideoLan VLC ActiveX Plugin
*Otherwise try creating a new package using the created ''AXVLC_TLB.pas''

===Confirm successfull installation===
*You should now be able to add the ''TVLCPlugin'' from the ActiveX-Tab of your Component toolbox.

==Usage Development-Time==
The VLC-Player Object ''TVLCPlugin'' can be found in your ActiveX-Components Tabsheet.
Place one of it in your Form1, place a TButton and use the following code:

unit Unit1;

interface

uses
Windows, Variants, Forms, Classes, Controls, StdCtrls, OleCtrls,
AXVLC_TLB;

type
TForm1 = class(TForm)
VLCPlugin1: TVLCPlugin;
Button1: TButton;
procedure Button1Click(Sender: TObject);
private
{ Private-Deklarationen }
public
{ Public-Deklarationen }
end;

type
VLCPlaylistMode = TOleEnum;

const
VLCPlayListInsert = $00000001;
VLCPlayListReplace = $00000002;
VLCPlayListAppend = $00000004;
VLCPlayListGo = $00000008;
VLCPlayListCheckInsert = $00000010;

var
Form1: TForm1;

implementation

{$R *.dfm}

procedure TForm1.Button1Click(Sender: TObject);
begin
VLCPlugin1.addTarget('C:\video.mpg', null, VLCPlayListInsert, 0);
// you can use any MRL with parameters instead of 'c:\video.mpg' here
VLCPlugin1.play;
end;

end.

==Usage Runtime==
If you're planning to use the VLC-Player in your application but don't know when and where, use this code to create the component on-demand.

unit Unit1;

interface

uses
Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms, OleCtrls,
AXVLC_TLB, StdCtrls;

type
TForm1 = class(TForm)
Button1: TButton;
Button2: TButton;
procedure Button2Click(Sender: TObject);
procedure Button1Click(Sender: TObject);
private
{ Private-Deklarationen }
public
{ Public-Deklarationen }
end;

var
Form1: TForm1;
VLCPlugin1: TVLCPlugin;

type
VLCPlaylistMode = TOleEnum;

const
VLCPlayListInsert = $00000001;
VLCPlayListReplace = $00000002;
VLCPlayListAppend = $00000004;
VLCPlayListGo = $00000008;
VLCPlayListCheckInsert = $00000010;

implementation

{$R *.dfm}

procedure TForm1.Button1Click(Sender: TObject);
begin
VLCPlugin1 := TVLCPlugin.Create(Self);
VLCPlugin1.Parent := Self; // Means: Place the VLC-Player into Form1
VLCPlugin1.Width := 400;
VLCPlugin1.Height := 300;
VLCPlugin1.Top := 50;
VLCPlugin1.Left := 50;
VLCPlugin1.Show;
VLCPlugin1.addTarget('C:\video.mpg', null, VLCPlayListInsert, 0);
// you can use any MRL with parameters instead of 'c:\video.mpg' here
VLCPlugin1.play;
end;

procedure TForm1.Button2Click(Sender: TObject);
begin
VLCPlugin1.stop;
FreeAndNil(VLCPlugin1);
end;

end.

ActiveX/Delphi

2006-01-20T16:56:01Z

Hogi: /* Usage */

ActiveX/Delphi

2006-01-20T16:55:06Z

Hogi: /* Usage */

ActiveX/Delphi

2006-01-20T16:52:42Z

Hogi:

ActiveX/Delphi

2006-01-19T19:25:52Z

Hogi:

==Getting started==
===What is this article about?===
This article is your guide, how to use all the functions of VLC in your own Delphi application.

===What you need===
* Borland Delphi 3 or newer
* a running System with Microsoft Windows
* [[VideoLan|http://www.videolan.org/]] including the ActiveX Plugin installed

===Import the ActiveX-Component===
*Start your Borland Delphi
*< Delphi2005: Select Components --> Import ActiveX --> VideoLan VLC ActiveX Plugin
*>= Delphi 2006: Select Components --> Import component --> Import ActiveX Control --> VideoLan VLC ActiveX Plugin
*Otherwise try creating a new package using the created ''AXVLC_TLB.pas''

===Confirm successfull installation===
*You should now be able to add the ''TVLCPlugin'' from the ActiveX-Tab of your Component toolbox.

==Usage==


The VLC-Player Object can be found in your ActiveX-Components Tabsheet.
Place one of it in your Form1, place a TButton and use the following code:

unit Unit1;

interface

uses
Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms,
Dialogs, StdCtrls, OleCtrls, AXVLC_TLB;

type
TForm1 = class(TForm)
Button1: TButton;
vlc: TVLCPlugin;
procedure Button1Click(Sender: TObject);
private
{ Private-Deklarationen }
public
{ Public-Deklarationen }
end;

type
VLCPlaylistMode = TOleEnum;
const
VLCPlayListInsert = $00000001;
VLCPlayListReplace = $00000002;
VLCPlayListAppend = $00000004;
VLCPlayListGo = $00000008;
VLCPlayListCheckInsert = $00000010;

var
Form1: TForm1;

implementation

{$R *.dfm}

procedure TForm1.Button1Click(Sender: TObject);
begin
vlc.addTarget('C:\video.mpg', null, VLCPlayListInsert, 0);
// you can use any MRL with parameters instead of 'c:\video.mpg' here
vlc.play;

end;

end.

ActiveX/Delphi

2006-01-18T22:14:13Z

Hogi:

To be edited a lot...

How to use VLC within your own Delphi Application:
Components --> Import ActiveX --> VideoLan Client
Create a new Package and select "Install".

The VLC-Player Object can be found in your ActiveX-Components Tabsheet.
Place one of it in your Form1, place a TButton and use the following code:

unit Unit1;

interface

uses
Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms,
Dialogs, StdCtrls, OleCtrls, AXVLC_TLB;

type
TForm1 = class(TForm)
Button1: TButton;
vlc: TVLCPlugin;
procedure Button1Click(Sender: TObject);
private
{ Private-Deklarationen }
public
{ Public-Deklarationen }
end;

type
VLCPlaylistMode = TOleEnum;
const
VLCPlayListInsert = $00000001;
VLCPlayListReplace = $00000002;
VLCPlayListAppend = $00000004;
VLCPlayListGo = $00000008;
VLCPlayListCheckInsert = $00000010;

var
Form1: TForm1;

implementation

{$R *.dfm}

procedure TForm1.Button1Click(Sender: TObject);
begin
vlc.addTarget('C:\video.mpg', null, VLCPlayListInsert, 0);
// you can use any MRL with parameters instead of 'c:\video.mpg' here
vlc.play;

end;

end.