Difference between revisions of "LibVLC"

From VideoLAN Wiki
Jump to navigation Jump to search
m (Misc.)
(27 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
{{Lowercase}}
 
{{Lowercase}}
−
The [[libVLC]] (VLC SDK) media framework can be embedded into an application to get multimedia capabilities.
+
The '''libVLC''' (VLC {{SDK}}) media framework can be embedded into an application to get multimedia capabilities.
  
−
Since VLC is based on [[libVLC]], one should be able to have the same features that {{VLC}} has.
+
Since VLC is based on libVLC, one should be able to have the same features that {{VLC}} has.
  
 
The libVLC media framework is already used by several applications; see [[LibVLC_Users|who uses libVLC?]]
 
The libVLC media framework is already used by several applications; see [[LibVLC_Users|who uses libVLC?]]
Line 8: Line 8:
 
== Documentation ==
 
== Documentation ==
  
−
Please refer to the [http://www.videolan.org/developers/vlc/doc/doxygen/html/group__libvlc.html Doxygen documentation], which is the reference documentation.
+
Please refer to the [https://www.videolan.org/developers/vlc/doc/doxygen/html/group__libvlc.html Doxygen documentation], which is the reference documentation.
  
−
''Make sure that the documentation matches the LibVLC version.'' (if not, you can build it from the source code)
+
<u>''Make sure that the documentation matches the LibVLC version.''</u> (if not, you can build it from the source code)
  
 
Some further topics are covered here:
 
Some further topics are covered here:
  
−
* [[LibVLC_Memory_Management| LibVLC Memory Management]] explained: covers the basics on the _new(), _retain(), _release().
+
* [[LibVLC Memory Management]] explained: covers the basics on the <code>_new()</code>, <code>_retain()</code>, <code>_release()</code>.
−
* [[LibVLC_Media_List_Management| LibVLC Media List Management]] explained: covers the basics on setting up a playlist.
+
* [[LibVLC Media List Management]] explained: covers the basics on setting up a playlist.
 
* [[GenerateLibFromDll|Generate a .lib for using libVLC on Windows]] (before libVLC 2.1.0)
 
* [[GenerateLibFromDll|Generate a .lib for using libVLC on Windows]] (before libVLC 2.1.0)
 +
 +
== Compiling ==
 +
To build LibVLC you need [[VLC source code]] and follow [[Compile_VLC|VLC compilation instructions]] since LibVLC it is directly shipped in VLC source code.<br />
 +
You will find headers in vlc-src/include/vlc and libvlc.so binaries in the ''hidden'' folder vlc-src/lib/.libs.<br />
 +
When using your custom LibVLC build you will need to define the environment variable <var>VLC_PLUGIN_PATH</var> pointing to VLC modules located in vlc-src/modules.
  
 
== Examples ==
 
== Examples ==
Line 23: Line 28:
 
* [[LibVLC_Tutorial|Current version (1.1.x and later)]]
 
* [[LibVLC_Tutorial|Current version (1.1.x and later)]]
 
* Gtk Player: {{VLCSourceFile|name=doc/libvlc/gtk_player.c}}
 
* Gtk Player: {{VLCSourceFile|name=doc/libvlc/gtk_player.c}}
−
* Qt Player: {{VLCSourceFile|name=doc/libvlc/QtPlayer}}
+
* Qt Player: {{VLCSourceFile|name=doc/libvlc/QtPlayer/player.cpp}}
 
* WxWidgets Player: {{VLCSourceFile|name=doc/libvlc/wx_player.cpp}}
 
* WxWidgets Player: {{VLCSourceFile|name=doc/libvlc/wx_player.cpp}}
  
Line 33: Line 38:
  
 
=== More complex examples ===
 
=== More complex examples ===
−
* [http://git.videolan.org/?p=libvlc-demos.git;a=tree;f=vlcinfo;hb=HEAD MediaInfo clone]
+
* {{VLCSourceFolder|p=libvlc-demos.git|vlcinfo|l=MediaInfo clone}}
−
* [http://git.videolan.org/?p=libvlc-demos.git;a=tree;f=webcam;hb=HEAD Webcam / Cheese clone]
+
* {{VLCSourceFolder|p=libvlc-demos.git|webcam|l=Webcam / Cheese clone}}
  
 
=== libVLC on Android ===
 
=== libVLC on Android ===
−
* [https://bitbucket.org/edwardcw/libvlc-android-sample LibVLC on Android sample]
+
* [https://code.videolan.org/videolan/libvlc-android-samples LibVLC on Android sample]
  
−
=== VLCKit for Cocoa (iOS/MacOS) ===
+
=== VLCKit for Cocoa (iOS/macOS) ===
 
You can find details on features and implementation on a [[VLCKit|designated page]].
 
You can find details on features and implementation on a [[VLCKit|designated page]].
  
−
==== Mac OS X ====
+
==== macOS ====
−
* [http://git.videolan.org/?p=vlc-bindings/VLCKit.git;a=tree;f=Examples_OSX/BasicPlayerWithPlaylist;hb=HEAD Simple playlist player for Mac OS X].
+
* [https://code.videolan.org/videolan/VLCKit/tree/master/Examples/macOS/BasicPlayerWithPlaylist Simple playlist player for macOS].
−
* [http://git.videolan.org/?p=vlc-bindings/VLCKit.git;a=tree;f=Examples_OSX/iPodConverter;hb=HEAD iPod Converter for Mac OS X].
+
* [https://code.videolan.org/videolan/VLCKit/tree/master/Examples/macOS/iPodConverter iPod Converter for macOS].
−
* [http://git.videolan.org/?p=vlc-bindings/VLCKit.git;a=tree;f=Examples_OSX/FlashVideoDownloader;hb=HEAD Flash Video Downloader for Mac OS X].
+
* [https://code.videolan.org/videolan/VLCKit/tree/master/Examples/macOS/FlashVideoDownloader Flash Video Downloader for macOS].
  
 
==== iOS ====
 
==== iOS ====
−
* [http://git.videolan.org/?p=vlc-bindings/VLCKit.git;a=tree;f=Examples_iOS/SimplePlayback;hb=HEAD Simple player for iOS].
+
* [https://code.videolan.org/videolan/VLCKit/tree/master/Examples/iOS/SimplePlayback Simple player for iOS].
−
* [http://git.videolan.org/?p=vlc-bindings/VLCKit.git;a=tree;f=Examples_iOS/DropIn-Player;hb=HEAD Drop-in player for integration in iOS apps].
+
* [https://code.videolan.org/videolan/VLCKit/tree/master/Examples/iOS/DropIn-Player Drop-in player for integration in iOS apps].
 +
 
 +
=== Crossplatform .NET/Mono support with LibVLCSharp ===
 +
* [https://code.videolan.org/videolan/LibVLCSharp/tree/master/Samples Simple playback samples (iOS/Android/Mac/Windows/Xamarin.Forms)].
 +
* [https://code.videolan.org/mfkl/libvlcsharp-samples Advanced samples].
  
 
=== Outdated samples ===
 
=== Outdated samples ===
 
* [[LibVLC_Tutorial_0.9|Versions 0.9.x and 1.0.x]]
 
* [[LibVLC_Tutorial_0.9|Versions 0.9.x and 1.0.x]]
 
* [[LibVLC_Tutorial_086c|Version 0.8.6]]
 
* [[LibVLC_Tutorial_086c|Version 0.8.6]]
−
* [[LibVLC_Visual_C|Visual C++]] '' (uses "old" legacy API) ''
+
* [[LibVLC_Visual_C++|Visual C++]] '' (uses "old" legacy API) ''
 
* [[IceVLCPlayer|VCL component for Delphi]] (out-of-date)
 
* [[IceVLCPlayer|VCL component for Delphi]] (out-of-date)
  
 
== Language & platform bindings ==
 
== Language & platform bindings ==
 
LibVLC is a C library. It has bindings to the following languages and frameworks:
 
LibVLC is a C library. It has bindings to the following languages and frameworks:
−
* C++, using the C library
+
* C++, using the [https://code.videolan.org/videolan/libvlcpp libvlcpp] library
 
* The [[Web plugin]] for ActiveX (e.g. MSIE) and NPAPI (e.g. Firefox)
 
* The [[Web plugin]] for ActiveX (e.g. MSIE) and NPAPI (e.g. Firefox)
−
* [http://code.google.com/p/fbvlc/ FBVLC browser plugin]
+
* [http://WebChimera.org WebChimera] browser plugin with [http://nwjs.io/ NW.js] support
−
* [[Mac OS X Framework|Objective-C for iOS and Mac OS]]
+
* [https://github.com/RSATom/WebChimera.js WebChimera.js] - another way to bind libvlc to node.js/io.js/NW.js/Electron
 +
* [[VLCKit|Objective-C/Swift for iOS and macOS]]
 +
* [[Perl bindings|Perl]]
 
* [[PythonBinding|Python]]
 
* [[PythonBinding|Python]]
 
* [http://phonon.kde.org/ Phonon (Qt/KDE) in C++]
 
* [http://phonon.kde.org/ Phonon (Qt/KDE) in C++]
−
* [[Java bindings]]
+
* [[Java bindings|Java]]
−
* [http://git.videolan.org/?p=vlc-ports/android.git;a=shortlog libVLC android Java]
+
* [https://code.videolan.org/videolan/vlc-android/tree/master/libvlc/jni Java/Scala/Kotlin/JNI Android]
−
* [http://github.com/jteeuwen/go-vlc GO]
+
* [https://code.videolan.org/videolan/libvlcsharp C#/F#/.NET]
−
* [https://github.com/RSATom/QmlVlc QmlVlc - Qt 5 QML binding]
+
* [https://code.videolan.org/videolan/vlc-winrt/tree/master/modules/libvlcppcx C++/CX]
−
* [http://projects.tano.si/vlc-qt Qt bindings - VLC-Qt]
+
* [https://github.com/adrg/libvlc-go Go]
 +
* [https://github.com/garkimasera/vlc-rs Rust]
 +
* [http://github.com/RSATom/QmlVlc QmlVlc] - Qt 5 QML binding
 +
* [https://github.com/vlc-qt/vlc-qt VLC-Qt] - Qt bindings
 
* [[wxVLCBackend|wxWidgets MediaCtrl backend]] also in C++
 
* [[wxVLCBackend|wxWidgets MediaCtrl backend]] also in C++
 
* [[Using libvlc with Delphi]]
 
* [[Using libvlc with Delphi]]
 
* [http://sourceforge.net/projects/paslibvlc/ Pascal/Delphi]
 
* [http://sourceforge.net/projects/paslibvlc/ Pascal/Delphi]
−
* .Net / CIL
+
* [http://wiki.tcl-lang.org/48382 Tcl]
 
* [[ActiveX]] with the built-in VLC browser plugin for MSIE (obsolete)
 
* [[ActiveX]] with the built-in VLC browser plugin for MSIE (obsolete)
  
−
[[Category:LibVLC]]
+
[[Category:LibVLC|*]]

Revision as of 09:26, 27 March 2019

The libVLC (VLC SDK) media framework can be embedded into an application to get multimedia capabilities.

Since VLC is based on libVLC, one should be able to have the same features that VLC media player has.

The libVLC media framework is already used by several applications; see who uses libVLC?

Documentation

Please refer to the Doxygen documentation, which is the reference documentation.

Make sure that the documentation matches the LibVLC version. (if not, you can build it from the source code)

Some further topics are covered here:

Compiling

To build LibVLC you need VLC source code and follow VLC compilation instructions since LibVLC it is directly shipped in VLC source code.
You will find headers in vlc-src/include/vlc and libvlc.so binaries in the hidden folder vlc-src/lib/.libs.
When using your custom LibVLC build you will need to define the environment variable VLC_PLUGIN_PATH pointing to VLC modules located in vlc-src/modules.

Examples

Playback

Rendering and streaming

More complex examples

libVLC on Android

VLCKit for Cocoa (iOS/macOS)

You can find details on features and implementation on a designated page.

macOS

iOS

Crossplatform .NET/Mono support with LibVLCSharp

Outdated samples

Language & platform bindings

LibVLC is a C library. It has bindings to the following languages and frameworks:

Retrieved from "https://wiki.videolan.org/index.php?title=LibVLC&oldid=60353"