Difference between revisions of "Documentation:Documentation"

From VideoLAN Wiki
Jump to navigation Jump to search
m (nn)
 
(46 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{| style="width:100%;margin-top:0px;background-color:#fcfcfc;border:1px solid #ccc"
+
{{Languages}}
|-
+
__NOTOC__
| style="width:56%;color:#000" |
+
<!-- Beginning of the banner section -->
{| style="width:280px;border:solid 0px;background:none"
+
{{Banner
|-
+
|welcome to=VideoLAN's Documentation
| 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>
+
|description=The reference documentation on VideoLAN's projects.
|}
+
<div id="articlecount" style="font-size: 90%;">Articles under the [https://www.gnu.org/copyleft/gpl.html GNU General Public License] only.</div>
 +
<!-- Default Template:Banner links show here -->
 +
}}
 +
<!-- End of the banner section -->
  
| style="width:11%;font-size:95%;color:#000" valign="top" |
+
== [[Documentation:User Guide|VLC User Guide]] ==
*[[VideoLAN|VideoLAN]]  
+
This is the {{VLC}} user documentation for everyone.
*[[VLC|VLC media player]]
 
*[[Documentation|Documentation]]
 
  
| style="width:14%;font-size:95%" valign="top" |  
+
'''[[Documentation:User_Guide|Read the complete table of contents]]'''.
*[http://www.videolan.org Main Site]  
 
*[http://forum.videolan.org Forum]  
 
*[http://planet.videolan.org News from developers]
 
  
| style="width:18%;font-size:95%" valign="top" |  
+
''Highlights:''
*[http://www.videolan.org/developers/ Developer's website]  
+
* [[Documentation:Quick_start_guide|Quick Start Guide]]
*[http://nightlies.videolan.org Latest builds]  
+
* [[Documentation:Installing_VLC|Install VLC]]
*[http://trac.videolan.org Trac, Bugs, SVN and roadmap]
+
* [[Documentation:Interface|Main VLC interface]]
 +
* [[Documentation:Open_Media|Open a media file]]
 +
* [[Documentation:Command_line|VLC command line]]
  
|}
+
== [[:Category:Mobile_documentation|VLC documentation for mobile devices]]  ==
<!-- end of the header section -->
 
  
'''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.'''  
+
''Highlights:''
 
+
* [[Documentation:IOS|Documentation for iOS]]
== [[Documentation:Play HowTo|VLC Usage Documentation]]  ==
+
* [[Documentation:Android|Documentation for Android]]
 
 
User documentation for everyone.
 
 
 
*[[Documentation:Play HowTo/Introduction to VLC|Introduction to VideoLAN and VLC]]
 
**Overview and history of the VideoLAN project.
 
 
 
*[[Documentation:Play HowTo/Installing VLC|VLC Installation]]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;[[Image:Installer.png|100x100px]]
 
 
 
** Installation instructions for various Operating Systems.
 
 
 
*[[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)
 
 
 
*[[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]]
 
**Short introduction to the interface of the VLC Media Player
 
 
 
*[[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]]
 
**Playing audio (e.g. visualization, selection of devices)
 
 
 
*[[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]]
 
**Playing video (e.g. cropping, screen-/snapshots)
 
 
 
*[[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]]
 
**Navigation through media files (e.g. chapters, bookmarks)
 
 
 
*[[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]]
 
**Creating and managing playlists
 
 
 
*[[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]]
 
**Selection of subtitles
 
 
 
*[[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]]
 
 
 
Usage of VLC's filters (equalizer, video filters)
 
 
 
*[[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.
 
 
 
*[[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.
 
 
 
[[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 New|VLC streaming documentation]]  ==
 
This document explains how to stream, transcode and save streams using the VideoLAN solution.
 
This document explains how to stream, transcode and save streams using the VideoLAN solution.
  
'''NOTE: See [[Documentation:Streaming HowTo New|Streaming HowTo New]] for more updated information regarding streaming (WIP).'''
+
''NOTE: The [[Documentation:Streaming HowTo|legacy streaming documentation]] is still available for reference, if required.''
  
== [[Documentation:Hacker's Guide|The Hacker's Guide to VLC]] ==
+
== [[Hacker Guide|Hacker's Guide to VLC]] ==
  
This document will detail the inner workings of VLC and its source code.  
+
This document details 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]]
 +
* [https://dl.dropboxusercontent.com/u/90125358/VLC%20Requirements%20Documentation.rar Requirements Documentation]
  
*[[Hacker Guide/Audio Filters|Audio Filters]]
+
== [[Documentation:Modules|The VLC Modules Index]] ==
*[[Hacker Guide/Core|Core]]
 
*[[Hacker Guide/Modules source tree|Modules source tree]]
 
*[[Hacker Guide/VLM Internals|VLM Internals]]
 
  
== [[Documentation:Modules|The VLC Modules Index]]  ==
+
This document references most of the VLC modules and their options as well as some example uses.
  
This document references most of the VLC modules and their options as well as some example uses.
 
  
<u>'''INTERFACE'''</u>
+
=== Contribute to the documentation ===
 +
'''Nota Bene:''' Parts of this documentation are currently outdated or incomplete. If you have good knowledge or feel that you could document it better, please update the appropriate wiki page.
  
'''Graphics'''<br>
+
{{Documentation}}
 
 
'''Text''' '''Other'''
 
 
 
<u>'''OUTPUT'''</u>
 
 
 
'''Audio output'''
 
 
 
'''Video output'''
 
 
 
'''Stream output'''
 
 
 
<u>'''FILTERS'''</u>
 
 
 
'''Audio filters'''
 
 
 
'''video filters'''
 
 
 
'''video-sub filters'''
 
 
 
'''video output filters'''
 
 
 
'''visualizations'''
 
 
 
'''access filters'''
 
 
 
<u>'''OTHER'''</u>
 
 
 
'''Accesses'''
 
  
'''Access Outputs<br> Codecs<br> Audio<br> Video<br> Subtitles<br> Demuxers<br> Playlist'''
+
[[Category:Documentation|*]]<!-- This modifies the sortkey -->
 
 
'''Muxers <br>Service Discovery'''
 
 
 
'''Misc'''
 
 
 
----
 
 
 
[[Image:Other projects.png]]  
 
 
 
<br>  
 
 
 
{{Documentation}}
 

Latest revision as of 05:54, 27 April 2019

VLC User Guide

This is the VLC media player user documentation for everyone.

Read the complete table of contents.

Highlights:

VLC documentation for mobile devices

Highlights:

VLC streaming documentation

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

NOTE: The legacy streaming documentation is still available for reference, if required.

Hacker's Guide to VLC

This document details 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.


Contribute to the documentation

Nota Bene: Parts of this documentation are currently outdated or incomplete. If you have good knowledge or feel that you could document it better, please update the appropriate wiki page.

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.