Difference between revisions of "Documentation:Documentation"

From VideoLAN Wiki
Jump to navigation Jump to search
(Edited by Jagannath for Google code-In 2011)
Line 45: Line 45:
 
'''       Overview and history of the VideoLAN project.'''  
 
'''       Overview and history of the VideoLAN project.'''  
  
−
*[[Documentation:Play HowTo/Installing VLC|Installation]]    [[Image:Installer.png|100x100px]]
+
*[[Documentation:Play HowTo/Installing VLC|Installation]]                                     [[Image:Installer.png|100x100px]]
  
 
'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Installation instructions for a variety of computers.'''<br>  
 
'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Installation instructions for a variety of computers.'''<br>  
  
−
*[[Documentation:Play HowTo/Basic Use|VLC Usage]]&nbsp;&nbsp;[[Image:Interface1.png|100x100px]]  
+
*[[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)  
+
**How to play audio/video materials with the VLC media player. (For versions 0.9 and newer)
−
**[[Documentation:Play HowTo/Basic Use/Interface|Interface]]&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;[[Image:Basic audio stereomono.png|150x100px]]  
+
 
−
***Playing audio (e.g. visualization, selection of devices)  
+
*[[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]]  
−
**[[Documentation:Play HowTo/Basic Use/Video|Video]]&nbsp;[[Image:Basic video fullscreen interface.png|100x100px]]  
+
**Short introduction to the interface of the VLC Media Player
−
***Playing video (e.g. cropping, screen-/snapshots)  
+
 
−
**[[Documentation:Play HowTo/Basic Use/Playback|Playback]]&nbsp;[[Image:Playbackcontrols.png|100x100px]]  
+
<br>
−
***Navigation through media files (e.g. chapters, bookmarks)  
+
 
−
**[[Documentation:Play HowTo/Basic Use/Playlist|Playlist]]&nbsp;[[Image:Basic playlist default.png|100x100px]]  
+
*[[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]]  
−
***Creating and managing playlists  
+
**Playing audio (e.g. visualization, selection of devices)  
−
**[[Documentation:Play HowTo/Basic Use/Subtitles|Subtitles]]&nbsp;[[Image:VLCSubs.png|100x100px]]  
+
*[[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]]  
−
***Selection of subtitles  
+
**Playing video (e.g. cropping, screen-/snapshots)  
−
**[[Documentation:Play HowTo/Basic Use/Video and Audio Filters|Video and Audio Filters]]&nbsp;[[Image:Effects and Filters.PNG|100x100px]]  
+
*[[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]]  
−
***Usage of VLC's filters (equalizer, video filters)  
+
**Navigation through media files (e.g. chapters, bookmarks)  
−
**[[Documentation:Play HowTo/Basic Use/Snapshots|Snapshots]]&nbsp;[[Image:Basic snapshots config.png|100x100px]]  
+
*[[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]]  
−
***How to create snap-/screenshots  
+
**Creating and managing playlists  
−
**[[Documentation:Play HowTo/Basic Use/Hotkeys|Hotkeys]]&nbsp;[[Image:Configure Hotkeys.PNG|100x100px]]  
+
*[[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]]  
−
***Configuration of VLC's hotkeys  
+
**Selection of subtitles  
−
**[[Documentation:Play HowTo/Basic Use/Basic troubleshooting|Troubleshooting]]&nbsp;[[Image:Intf-wx-messages.jpg|100x100px]]  
+
*[[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]]
−
***Solutions for some common problems  
+
 
−
*[[Documentation:Play HowTo/Advanced Use of VLC|Advanced Use]]&nbsp;[[Image:VLCadvanceopen.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.  
 
**Advanced instruction on streams, filters, plug-ins and more.  
−
*[[Documentation:WebPlugin|Using VLC inside a webpage]]&nbsp;[[Image:Web.JPG|100x100px]]  
+
*[[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.  
+
**How to build webpages that use the VLC Web plugin.
−
*[[VLC Uninstall|Uninstallation]]&nbsp;[[Image:Uninstall.PNG|100x100px]]  
+
 
−
**Uninstallation instructions.
+
[[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]]  ==
 
== [[Documentation:Streaming HowTo|VLC Streaming Documentation]]  ==

Revision as of 10:44, 9 December 2011

Do you know more about the compatibility of Documentation? Please add it here

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                                    Interface1.png
    • How to play audio/video materials with the VLC media player. (For versions 0.9 and newer)


  • Interface                                       Default Interface Mac.PNG
    • Short introduction to the interface of the VLC Media Player


  • Audio                                     Basic audio stereomono.png
    • Playing audio (e.g. visualization, selection of devices)
  • Video                                        Basic video fullscreen interface.png
    • Playing video (e.g. cropping, screen-/snapshots)
  • Playback                                     Playbackcontrols.png
    • Navigation through media files (e.g. chapters, bookmarks)
  • Playlist                                    Basic playlist default.png
    • Creating and managing playlists
  • Subtitles                                  VLCSubs.png
    • Selection of subtitles
  • Video and Audio Filters             Video effects - basic, with image adjust and sharpen selected.png

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


  • Snapshots                              Basic snapshots config.png
    • How to create snap-/screenshots
  • Hotkeys                                 100x100px
    • Configuration of VLC's hotkeys
  • Troubleshooting                         Intf-wx-messages.jpg
    • Solutions for some common problems
  • Advanced Use                        100x100px
    • Advanced instruction on streams, filters, plug-ins and more.
  • Using VLC inside a webpage     Web.JPG
    • How to build webpages that use the VLC Web plugin.

Uninstallation                            Uninstall.PNG

  • Uninstallation instructions.

VLC Streaming Documentation

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

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

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