View source for Documentation:Documentation

__NOTOC__{{Documentation}} 

{| style="width:100%;margin-top:0px;background-color:#fcfcfc;border:1px solid #ccc"
|-
| style="width:56%;color:#000" | 
{| style="width:280px;border:solid 0px;background:none"
|-
| style="width:280px;text-align:center;white-space:nowrap;color:#000" | <div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">Welcome to [[Documentation|VideoLAN's&nbsp;Documentation]],</div> <div style="top:+0.2em;font-size: 95%">The reference documentation on VideoLAN's projects.</div> <div id="articlecount" style="width:100%;text-align:center;font-size:85%;">Articles under the [http://www.gnu.org/copyleft/gpl.html GNU General Public License] only.</div>
|}

&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;[[Image:VIDEOLAN.PNG]] <br> &nbsp; &nbsp;&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; 

| style="width:11%;font-size:95%;color:#000" valign="top" | 
*[[VideoLAN|VideoLAN]] 
*[[VLC|VLC media player]] 
*[[Documentation|Documentation]]

| style="width:14%;font-size:95%" valign="top" | 
*[http://www.videolan.org Main Site] 
*[http://forum.videolan.org Forum] 
*[http://planet.videolan.org News from developers]

| style="width:18%;font-size:95%" valign="top" | 
*[http://www.videolan.org/developers/ Developer's website] 
*[http://nightlies.videolan.org Latest builds] 
*[http://trac.videolan.org Trac, Bugs, SVN and roadmap]

|}
<!-- end of the header section --> 
<br> ''Pages in the "Documentation" namespace are part of the official VLC media player documentation.'' 

''All pages in this namespace are licensed under the [http://www.gnu.org/copyleft/gpl.html GNU General Public License].'' 

'''Note: Parts of this documentation are currently outdated or incomplete. If you have good knowledge of a particular subject and feel that it could be documented better, please update the appropriate wiki page.''' 

== [[Documentation:Play HowTo|VLC Usage Documentation]]  ==

User documentation for everyone. 

*[[Documentation:Play HowTo/Basic Use/VLC 1.2 Interface on Windows 7|VLC Interface 1.2 on Windows 7]] 
*[[Documentation:Play HowTo/Basic Use/Interface Windows|Basic_Use/Interface_Windows]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;[[Image:LargeVLC.png|50x50px]] 
*[[Documentation:Play HowTo/Basic Use/Interface OSX|Basic_Use/Interface_OSX]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;'''''DOWNLOAD''''' 
*[[Documentation:Play HowTo/Introduction to VLC|Introduction to VideoLAN and VLC]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;[[Image:Windows-7-logo.jpg|50x50px]]&nbsp;http://www.videolan.org/vlc/download-windows.html &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;[[Image:Apple-logo-300x300.jpg|50x50px]]&nbsp;http://www.videolan.org/vlc/download-macosx.html &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;[[Image:Ubuntu.png|50x50px]] &nbsp;http://www.videolan.org/vlc/download-ubuntu.html &nbsp; &nbsp;

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Overview and history of the VideoLAN project. &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;[[Image:Fedora logo.svg.png|50x50px]]&nbsp;http://www.videolan.org/vlc/download-fedora.html<br> 

*[[Documentation:Play HowTo/Installing VLC|Installation]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;[[Image:Installer.png|100x100px]]

'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Installation instructions for a variety of computers.'''<br> 

*[[Documentation:Play HowTo/Basic Use|VLC Usage]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;[[Image:Interface1.png|100x100px]] 
**How to play audio/video materials with the VLC media player. (For versions 0.9 and newer)

<br> 

*[[Documentation:Play HowTo/Basic Use/Interface|Interface]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;[[Image:Default Interface Mac.PNG|100x100px]] 
**Short introduction to the interface of the VLC Media Player

<br> 

*[[Documentation:Play HowTo/Basic Use/Audio|Audio]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;[[Image:Basic audio stereomono.png|150x100px]] 
**Playing audio (e.g. visualization, selection of devices) 
*[[Documentation:Play HowTo/Basic Use/Video|Video]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;[[Image:Basic video fullscreen interface.png|100x100px]] 
**Playing video (e.g. cropping, screen-/snapshots) 
*[[Documentation:Play HowTo/Basic Use/Playback|Playback]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;&nbsp;[[Image:Playbackcontrols.png|100x100px]] 
**Navigation through media files (e.g. chapters, bookmarks) 
*[[Documentation:Play HowTo/Basic Use/Playlist|Playlist]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;[[Image:Basic playlist default.png|100x100px]] 
**Creating and managing playlists 
*[[Documentation:Play HowTo/Basic Use/Subtitles|Subtitles]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;[[Image:VLCSubs.png|100x100px]] 
**Selection of subtitles 
*[[Documentation:Play HowTo/Basic Use/Video and Audio Filters|Video and Audio Filters]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;&nbsp;[[Image:Effects and Filters.PNG|100x100px]]

Usage of VLC's filters (equalizer, video filters) 

<br> 

*[[Documentation:Play HowTo/Basic Use/Snapshots|Snapshots]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;[[Image:Basic snapshots config.png|100x100px]] 
**How to create snap-/screenshots

*[[Documentation:Play HowTo/Basic Use/Hotkeys|Hotkeys]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;[[Image:VLC-hotkeys.png|100x100px]] 
**Configuration of VLC's hotkeys 
*[[Documentation:Play HowTo/Basic Use/Basic troubleshooting|Troubleshooting]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;&nbsp;[[Image:Intf-wx-messages.jpg|100x100px]] 
**Solutions for some common problems 
*[[Documentation:Play HowTo/Advanced Use of VLC|Advanced Use]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;[[Image:VLCadvanceopen.png|100x100px]] 
**Advanced instruction on streams, filters, plug-ins and more. 
*[[Documentation:WebPlugin|Using VLC inside a webpage]]&nbsp; &nbsp;&nbsp;&nbsp;[[Image:Web.JPG|100x100px]] 
**How to build webpages that use the VLC Web plugin.

[[VLC Uninstall|Uninstallation]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;[[Image:Uninstall.PNG|100x100px]] 

*Uninstallation instructions.

== [[Documentation:Streaming HowTo|VLC Streaming Documentation]]  ==

This document explains how to stream, transcode and save streams using the VideoLAN solution.&nbsp; 

'''NOTE: See [[Documentation:Streaming HowTo New|Streaming HowTo New]] for more updated information regarding streaming (WIP).''' [[Image:StreamSelect.png]] 

== [[Documentation:Hacker's Guide|The Hacker's Guide to VLC]]  ==

This document will detail the inner workings of VLC and its source code. 

*[[Hacker Guide/Audio Filters|Audio Filters]] 
*[[Hacker Guide/Core|Core]] 
*[[Hacker Guide/Modules source tree|Modules source tree]] 
*[[Hacker Guide/VLM Internals|VLM Internals]]

== [[Documentation:Modules|The VLC Modules Index]]  ==

This document references most of the VLC modules and their options as well as some example uses. 

<u>'''INTERFACE'''</u> 

'''Graphics'''<br> 

'''Text''' '''Other''' 

<u>'''OUTPUT'''</u> 

'''Audio output''' 

'''Video output''' 

'''Stream output''' 

<u>'''FILTERS'''</u> 

'''Audio filters''' 

'''video filters''' 

'''video-sub filters''' 

'''video output filters''' 

'''visualizations''' 

'''access filters''' 

<u>'''OTHER'''</u> 

'''Accesses''' 

'''Access Outputs<br> Codecs<br> Audio<br> Video<br> Subtitles<br> Demuxers<br> Playlist''' 

'''Muxers <br>Service Discovery''' 

'''Misc''' 

----

[[Image:OTHER PROJECTS.PNG]] 

<br> 

{{Documentation}}