Difference between revisions of "Documentation:Documentation"

From VideoLAN Wiki
Jump to navigation Jump to search
m (nn)
 
(61 intermediate revisions by 10 users not shown)
Line 1: Line 1:
−
__NOTOC__{{Documentation}}  
+
{{Languages}}
 +
__NOTOC__  
 +
<!-- Beginning of the banner section -->
 +
{{Banner
 +
|welcome to=VideoLAN's Documentation
 +
|description=The reference documentation on VideoLAN's projects.
 +
<div id="articlecount" style="font-size: 90%;">Articles under the [https://www.gnu.org/copyleft/gpl.html GNU General Public License] only.</div>
 +
<!-- Default Template:Banner links show here -->
 +
}}
 +
<!-- End of the banner section -->
  
−
{| style="width:100%;margin-top:0px;background-color:#fcfcfc;border:1px solid #ccc"
+
== [[Documentation:User Guide|VLC User Guide]] ==
−
|-
+
This is the {{VLC}} user documentation for everyone.
−
| 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>
 
−
|}
 
  
−
<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;
+
'''[[Documentation:User_Guide|Read the complete table of contents]]'''.
  
−
| style="width:11%;font-size:95%;color:#000" valign="top" |  
+
''Highlights:''
−
*[[VideoLAN|VideoLAN]]  
+
* [[Documentation:Quick_start_guide|Quick Start Guide]]
−
*[[VLC|VLC media player]]  
+
* [[Documentation:Installing_VLC|Install VLC]]
−
*[[Documentation|Documentation]]
+
* [[Documentation:Interface|Main VLC interface]]
 +
* [[Documentation:Open_Media|Open a media file]]
 +
* [[Documentation:Command_line|VLC command line]]
  
−
| style="width:14%;font-size:95%" valign="top" |
+
== [[:Category:Mobile_documentation|VLC documentation for mobile devices]] ==
−
*[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" |
+
''Highlights:''
−
*[http://www.videolan.org/developers/ Developer's website]  
+
* [[Documentation:IOS|Documentation for iOS]]
−
*[http://nightlies.videolan.org Latest builds]  
+
* [[Documentation:Android|Documentation for Android]]
−
*[http://trac.videolan.org Trac, Bugs, SVN and roadmap]
 
  
−
|}
+
== [[Documentation:Streaming HowTo New|VLC streaming documentation]]  ==
−
<!-- end of the header section -->
+
This document explains how to stream, transcode and save streams using the VideoLAN solution.
−
<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: The [[Documentation:Streaming HowTo|legacy streaming documentation]] is still available for reference, if required.''
  
−
'''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.'''
+
== [[Hacker Guide|Hacker's Guide to VLC]] ==
  
−
== [[Documentation:Play HowTo|VLC Usage Documentation]]  ==
+
This document details 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]]
 +
* [https://dl.dropboxusercontent.com/u/90125358/VLC%20Requirements%20Documentation.rar Requirements Documentation]
  
−
User documentation for everyone.
+
== [[Documentation:Modules|The VLC Modules Index]] ==
  
−
*[[Documentation:Play HowTo/Basic Use/VLC 1.2 Interface on Windows 7|VLC Interface 1.2 on Windows 7]]
+
This document references most of the VLC modules and their options as well as some example uses.
−
*[[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;[[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;'''''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;http://sourceforge.net/projects/vlc/files/1.1.11/win32/vlc-1.1.11-win32.exe/download &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
 
  
−
'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Overview and history of the VideoLAN project.'''
 
  
−
*[[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]]
+
=== Contribute to the documentation ===
 +
'''Nota Bene:''' Parts of this documentation are currently outdated or incomplete. If you have good knowledge or feel that you could document it better, please update the appropriate wiki page.
  
−
'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Installation instructions for a variety of computers.'''<br>
+
{{Documentation}}
−
 
 
−
*[[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>
 
−
 
 
−
[[Documentation:Modules/macosx_gui|Modules/macosx_gui]]
 
−
 
 
−
'''Text'''
 
−
'''Other'''
 
−
<u>'''OUTPUT'''</u>
 
−
 
 
−
<u</u'''Audio output'''
 
  
−
'''Video output'''
+
[[Category:Documentation|*]]<!-- This modifies the sortkey -->
−
 
 
−
'''Stream output'''
 
−
<u>'''FILTERS'''</u>
 
−
 
 
−
'''Audio filters'''
 
−
 
 
−
'''video filters'''
 
−
 
 
−
'''video-sub filters'''
 
−
 
 
−
'''video output filters'''
 
−
 
 
−
'''visualizations'''
 
−
 
 
−
'''access filters'''
 
−
<u>'''OTHER'''</u>
 
−
 
 
−
<u</u>'''Accesses'''
 
−
 
 
−
'''Access Outputs<br> Codecs<br> Audio<br> Video<br> Subtitles<br> Demuxers<br> Playlist'''
 
−
 
 
−
'''Muxers <br>Service Discovery'''
 
−
 
 
−
'''Misc'''
 
−
 
 
−
{{Documentation}}
 

Latest revision as of 05:54, 27 April 2019

Languages: English • Deutsch

VLC User Guide

This is the VLC media player user documentation for everyone.

Read the complete table of contents.

Highlights:

VLC documentation for mobile devices

Highlights:

VLC streaming documentation

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

NOTE: The legacy streaming documentation is still available for reference, if required.

Hacker's Guide to VLC

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

The VLC Modules Index

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


Contribute to the documentation

Nota Bene: Parts of this documentation are currently outdated or incomplete. If you have good knowledge or feel that you could document it better, please update the appropriate wiki page.

This page is part of official VLC media player Documentation (User Guide • Streaming HowTo • Hacker Guide • Modules)
Please read the Documentation Editing Guidelines before you edit the documentation
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
Retrieved from "https://wiki.videolan.org/index.php?title=Documentation:Documentation&oldid=61298"