Documentation:Documentation

From VideoLAN Wiki
Revision as of 15:33, 10 December 2011 by Jagannath (talk | contribs)
Jump to navigation Jump to search
This page is part of official VLC media player Documentation (User GuideStreaming HowToHacker GuideModules)
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.


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.

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 GuideStreaming HowToHacker GuideModules)
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.