Difference between revisions of "Documentation:Documentation"

From VideoLAN Wiki
Jump to navigation Jump to search
(Edited by Jagannath for Google code-In 2011)
(Edited by Jagannath for Google code-In 2011)
Line 1: Line 1:
−
__NOTOC__
+
__NOTOC__ <!-- Beginning of header section -->
  
−
<!-- Beginning of header section -->
+
{| style="width:100%;margin-top:0px;background-color:#fcfcfc;border:1px solid #ccc"
−
{|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" |
+
| style="width:56%;color:#000" |
−
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">Welcome to [[Documentation:Documentation|VideoLAN's&nbsp;Documentation]],</div>
+
{| style="width:280px;border:solid 0px;background:none"
−
<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>
+
| 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>
 
|}
 
|}
−
|style="width:11%;font-size:95%;color:#000" valign="top"|
+
 
−
*[[VideoLAN|VideoLAN]]
+
&nbsp; &nbsp;&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;
−
*[[VLC|VLC media player]]
+
 
−
*[[Documentation:Documentation|Documentation]]
+
| style="width:11%;font-size:95%;color:#000" valign="top" |  
−
|style="width:14%;font-size:95%" valign="top"|
+
*[[VideoLAN|VideoLAN]]  
−
*[http://www.videolan.org Main Site]
+
*[[VLC|VLC media player]]  
−
*[http://forum.videolan.org Forum]
+
*[[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]
 
*[http://planet.videolan.org News from developers]
−
|style="width:18%;font-size:95%" valign="top"|
+
 
−
*[http://www.videolan.org/developers/ Developer's website]
+
| style="width:18%;font-size:95%" valign="top" |  
−
*[http://nightlies.videolan.org Latest builds]
+
*[http://www.videolan.org/developers/ Developer's website]  
 +
*[http://nightlies.videolan.org Latest builds]  
 
*[http://trac.videolan.org Trac, Bugs, SVN and roadmap]
 
*[http://trac.videolan.org Trac, Bugs, SVN and roadmap]
 +
 
|}
 
|}
−
<!-- end of the header section -->
+
<!-- end of the header section -->  
−
 
+
<br> ''Pages in the "Documentation" namespace are part of the official VLC media player documentation.''  
−
 
 
−
''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].''
+
''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.'''
+
'''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{{Yes}}]]  ==
+
== [[Documentation:Play HowTo|VLC Usage Documentation]]  ==
  
 
User documentation for everyone.  
 
User documentation for everyone.  
Line 40: Line 41:
 
*[[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;[[Image:LargeVLC.png|50x50px]]  
 
*[[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;[[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/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; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &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
+
*[[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; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &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; Overview and history of the VideoLAN project.'''  
 
'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Overview and history of the VideoLAN project.'''  
Line 81: Line 82:
 
This document explains how to stream, transcode and save streams using the VideoLAN solution. '''OUTDATED'''  
 
This document explains how to stream, transcode and save streams using the VideoLAN solution. '''OUTDATED'''  
  
−
'''NOTE: See [[Documentation:Streaming HowTo New|Streaming HowTo New]] for more updated information regarding streaming (WIP).'''
+
'''NOTE: See [[Documentation:Streaming HowTo New|Streaming HowTo New]] for more updated information regarding streaming (WIP).'''  
  
−
== [[Documentation:Hacker's Guide|The Hacker's Guide to VLC]] ==
+
== [[Documentation:Hacker's Guide|The Hacker's Guide to VLC]] ==
  
−
This document will detail the inner workings of VLC and its source code.
+
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]] ==
+
*[[Hacker Guide/Audio Filters|Audio Filters]]
 +
*[[Hacker Guide/Core|Core]]
 +
*[[Hacker Guide/Modules source tree|Modules source tree]]
 +
*[[Hacker Guide/VLM Internals|VLM Internals]]
  
−
This document references most of the VLC modules and their options as well as some example uses.
+
== [[Documentation:Modules|The VLC Modules Index]]  ==
  
 +
This document references most of the VLC modules and their options as well as some example uses.
  
−
{{Documentation}}
+
<br> {{Documentation}}

Revision as of 01:51, 8 December 2011


The reference documentation on VideoLAN's projects.
Articles under the GNU General Public License only.

                                                                                                                        


Pages in the "Documentation" namespace are part of the official VLC media player documentation.

All pages in this namespace are licensed under the 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.

VLC Usage Documentation

User documentation for everyone.

  • VLC Interface 1.2 on Windows 7
  • Basic_Use/Interface_Windows                                                                                                                                                             LargeVLC.png
  • Basic_Use/Interface_OSX                                                                                                                                                                DOWNLOAD
  • Introduction to VideoLAN and VLC                                                                                                                                                                                                                                                                                                                                                                                                               http://sourceforge.net/projects/vlc/files/1.1.11/win32/vlc-1.1.11-win32.exe/download

       Overview and history of the VideoLAN project.

       Installation instructions for a variety of computers.

  • VLC Usage
    • How to play audio/video materials with the VLC media player. (For versions 0.9 and newer)
    • Interface
      • Short introduction to the interface of the VLC Media Player
    • Audio
      • Playing audio (e.g. visualization, selection of devices)
    • Video
      • Playing video (e.g. cropping, screen-/snapshots)
    • Playback
      • Navigation through media files (e.g. chapters, bookmarks)
    • Playlist
      • Creating and managing playlists
    • Subtitles
      • Selection of subtitles
    • Video and Audio Filters
      • Usage of VLC's filters (equalizer, video filters)
    • Snapshots
      • How to create snap-/screenshots
    • Hotkeys
      • Configuration of VLC's hotkeys
    • Troubleshooting
      • Solutions for some common problems
  • Advanced Use
    • Advanced instruction on streams, filters, plug-ins and more.
  • Using VLC inside a webpage
    • How to build webpages that use the VLC Web plugin.
  • Uninstallation
    • Uninstallation instructions.

VLC Streaming Documentation

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

NOTE: See Streaming HowTo New for more updated information regarding streaming (WIP).

The Hacker's Guide to VLC

This document will detail 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.


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=20489"