Documentation:Documentation

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

VideoLAN VLC media player Documentation

Main Site Forum News from developers

Developer's website Latest builds Trac, Bugs, SVN and roadmap

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.

• Introduction to VideoLAN and VLC
  • Overview and history of the VideoLAN project.

• Installation                                     100x100px

       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                                 100x100px
  • Configuration of VLC's hotkeys
• Troubleshooting                         
  • Solutions for some common problems
• Advanced Use                        100x100px
  • 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. 

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.

• Audio Filters
• Core
• Modules source tree
• VLM Internals

The VLC Modules Index

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

INTERFACE

Graphics

Text Other

OUTPUT

Audio output

Video output

Stream output

FILTERS

Audio filters

video filters

video-sub filters

video output filters

visualizations

access filters

OTHER

Accesses

Access Outputs
Codecs
Audio
Video
Subtitles
Demuxers
Playlist

Muxers
Service Discovery

Misc

---

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.