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

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.

Documentation is like sex: when it is good, it is very, very good; and when it is bad, it is better than nothing.

VLC Usage Documentation

User documentation for everyone.

• Introduction to VideoLAN and VLC

       Overview and history of the VideoLAN project.

• Installation

       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.