Skip to content
Cross-platform .NET/Mono bindings for libVLC
Branch: master
Clone or download
Latest commit 223a1e8 May 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitlab/issue_templates Update gitlab bug reporting template Apr 19, 2019
Assets Asset: update icon SVG Mar 4, 2019
LibVLCSharp.Android.AWindow AWindow: Update java code Apr 16, 2019
LibVLCSharp.Forms.Platforms.GTK Bump version - first stable release of LibVLCSharp May 13, 2019
LibVLCSharp.Forms.Platforms.WPF Bump version - first stable release of LibVLCSharp May 13, 2019
LibVLCSharp.Forms Bump version - first stable release of LibVLCSharp May 13, 2019
LibVLCSharp.GTK Bump version - first stable release of LibVLCSharp May 13, 2019
LibVLCSharp.Tests LibVLC: Remove Log API Apr 10, 2019
LibVLCSharp.WPF Bump version - first stable release of LibVLCSharp May 13, 2019
LibVLCSharp.WinForms Bump version - first stable release of LibVLCSharp May 13, 2019
LibVLCSharp Bump version - first stable release of LibVLCSharp May 13, 2019
Samples Samples: Update all libvlc references to stable May 20, 2019
docs docs: Mention the need to install the `vlc` package in the linux setu… Mar 20, 2019
scripts CI: Download different mono build May 20, 2019
.gitignore update gitignore Oct 20, 2017
CODE_OF_CONDUCT.md Add VideoLAN Code of Conduct reference Apr 2, 2019
CONTRIBUTING.md Add CONTRIBUTING.md Jan 14, 2019
Directory.Build.props Implemented UWP platform Apr 9, 2019
GETTING-STARTED.md Added documentation about the UWP target Apr 9, 2019
LICENSE Add LICENSE Apr 20, 2018
LibVLCSharp.sln Add VS2019 support for all projects Apr 22, 2019
NEWS Update NEWS May 20, 2019
README.md README: Update refs to new UWP nuget Apr 9, 2019
VERSIONING.md Add versioning strategy doc Oct 25, 2018
azure-pipelines.yml
global.json Add VS2019 support for all projects Apr 22, 2019

README.md

LibVLCSharp

Build Status Join the chat at https://gitter.im/libvlcsharp/Lobby

LibVLCSharp is a cross-platform audio and video API for .NET platforms based on VideoLAN's LibVLC Library. It provides a comprehensive multimedia API that can be used across mobile, server and desktop to render video and output audio as well as encode and stream.

The official repository URL for this repo is https://code.videolan.org/videolan/LibVLCSharp.

Features

Check out libvlc-nuget to get a basic understanding of how libvlc works, what it can offer and how to install it with NuGet.

Some of the features include:

  • Plays all formats
  • Network browsing for distant filesystems (SMB, FTP, SFTP, NFS...).
  • HDMI pass-through for Audio HD codecs, like E-AC3, TrueHD or DTS-HD.
  • Stream to distant renderers, like Chromecast.
  • 360 video and 3D audio playback with viewpoint change.
  • Support for Ambisonics audio and more than 8 audio channels.
  • Subtitles size modification live.
  • Hardware and software decoding on all platforms.
  • DVD playback and menu navigation.
  • Equalizer support.

Most things you can achieve with the regular VLC desktop app, you can also achieve using libvlc.

Supported platforms

Mono, .NET Framework and .NET Core runtimes are supported.

  • Xamarin.Android
  • Xamarin.iOS
  • Xamarin.tvOS
  • Xamarin.Mac (Cocoa)
  • Windows Classic (WPF, WinForms, GTK)
  • Windows Universal (UWP for Desktop, mobile and Xbox)
  • Linux (GTK)
  • Xamarin.Forms
  • .NET Standard 1.1 and 2.0
  • .NET Core (including ASP.NET Core)

Installation

  1. Install LibVLC in your platform specific project.
Platform LibVLC Package NuGet Minimum OS Version
Windows VideoLAN.LibVLC.Windows LibVLCWindowsBadge Windows XP
UWP VideoLAN.LibVLC.UWP LibVLCWin10Badge Windows 10
Mac VideoLAN.LibVLC.Mac LibVLCMacBadge macOS 10.7
Android VideoLAN.LibVLC.Android LibVLCAndroidBadge Android 2.3
iOS VideoLAN.LibVLC.iOS LibVLCiOSBadge iOS 8.4
tvOS VideoLAN.LibVLC.tvOS LibVLCtvOSBadge tvOS 10.2
Linux Linux guide N/A N/A
dotnet add package VideoLAN.LibVLC.[Windows|UWP|Android|iOS|Mac|tvOS]

LibVLC is the actual VLC engine written mostly in C/C++ and compiled for your target platform. More information here.

  1. Install LibVLCSharp or LibVLCSharp.Forms (if you plan on using Xamarin.Forms)
Platform LibVLCSharp Package NuGet
.NET Standard LibVLCSharp LibVLCSharpBadge
Xamarin.Android LibVLCSharp LibVLCSharpBadge
Xamarin.iOS LibVLCSharp LibVLCSharpBadge
Xamarin.tvOS LibVLCSharp LibVLCSharpBadge
Xamarin.Mac LibVLCSharp LibVLCSharpBadge
UWP LibVLCSharp LibVLCSharpBadge
Xamarin.Forms LibVLCSharp.Forms LibVLCSharpFormsBadge
WPF LibVLCSharp.WPF LibVLCSharpWPFBadge
Xamarin.Forms.WPF LibVLCSharp.Forms.WPF LibVLCSharpFormsWPFBadge
GTK LibVLCSharp.GTK LibVLCSharpGTKBadge
Xamarin.Forms.GTK LibVLCSharp.Forms.GTK LibVLCSharpFormsGTKBadge
Windows Forms LibVLCSharp.WinForms LibVLCSharpWinFormsBadge

LibVLCSharp is the .NET wrapper that consumes LibVLC and allows you to interact with native code from C#/F#.

Getting started

Follow the Getting started guide. Make sure you read it since it contains platform-specific caveats

Samples

For more advanced samples, have a look at libvlcsharp-samples. It currently includes:

  • Chromecast sample: Discover chromecasts on your local network and select one for playback in 100% shared code (Xamarin.Forms, iOS/Android).
  • Record HLS sample: Simple .NET Core CLI app which shows how to record an HLS stream to the filesystem.
  • RTSP Mosaic: Cross-platform RTSP player sample with 4 views mosaic (Xamarin.Forms, iOS/Android).
  • PulseMusic UX: A stylish music player UX example using Skia on iOS and Android.
  • Gestures sample: Cross-platform touch gestures and 360 videos on iOS and Android.

Feel free to suggest and contribute new samples.

Quick API overview

  • LibVLC.cs: Main object pointing to a native libvlc instance in native code.
  • MediaPlayer.cs: Manages playback, offers event listeners and more. Accessible from VideoView with data-binding support.
  • Media.cs: Class representing and providing information about a media such as a video or audio file or stream.
  • VideoView.cs: Custom native view which holds a MediaPlayer object.
  • MediaDiscoverer.cs: This object should be used to find media on NAS and any SMB/UPnP-enabled device on your local network.
  • RendererDiscoverer.cs: Use this to find and use a Chromecast or other distant renderers.
  • Dialog.cs: Dialogs can be raised from the libvlc engine in some cases. Register callbacks with this object.

Roadmap

  • MediaPlayerElement control
  • Game engines (Unity, Unreal, Godot)

If you have a request or question regarding the roadmap, feel free to open an issue or PR.

Versioning

As this is a libvlc binding, we try to follow the libvlc versioning scheme as much as possible. The versioning strategy is explained in the VERSIONING document.

Release Notes

Check out the NEWS file for details about each release.

Contribute

Pull request

Pull requests are more than welcome! If you do submit one, please make sure to read the contributing guidelines first.

Gitlab issues

You can look through issues we currently have on the VideoLAN Gitlab.

Communication

Forum

If you have any question or if you're not sure it's actually an issue, please visit our forum.

Issues

You have encountered an issue and wish to report it to the VLC dev team?

You can create one on our Gitlab or on our bug tracker.

Before creating an issue or ticket, please double check for duplicates!

IRC

Want to quickly get in touch with us for a question, or even just to talk?

You will always find someone from the VLC team on IRC, #videolan channel on the freenode network.

If you don't have an IRC client, you can always use the freenode webchat.

We are also on Gitter Join the chat at https://gitter.im/libvlcsharp/Lobby

StackOverflow

We regularly monitor the libvlcsharp tag on stackoverflow

Code of Conduct

Please read and follow the VideoLAN CoC license.

License

LibVLCSharp is under the LGPLv2.1.

Note: the .NET4.0 LibVLCSharp build references a nuget package that may indicate its license as the .NET Library license but it's actually opensource under MIT.

You can’t perform that action at this time.