LibVLCSharp Documentation

Welcome to the LibVLCSharp documentation site. LibVLCSharp is a cross-platform audio and video API for .NET platforms based on VideoLAN's LibVLC Library.

What is LibVLCSharp?

LibVLCSharp provides a comprehensive multimedia API that can be used across mobile, server and desktop to render video and output audio. It supports Mono, .NET Framework and .NET Core runtimes.

Key Features

  • Cross-platform: Works on Windows, macOS, Linux, iOS, Android, and more
  • Multiple UI frameworks: WPF, WinForms, Xamarin.Forms, GTK, UWP, Uno Platform
  • Comprehensive API: Full access to LibVLC's powerful multimedia capabilities
  • High performance: Hardware-accelerated video decoding and rendering
  • Extensive format support: Plays virtually any audio or video format

Documentation Sections

API Documentation

Complete API reference documentation for all LibVLCSharp classes, methods, and properties.

User Guide

Comprehensive guides covering everything from getting started to advanced topics:

Getting Started

Installation, setup, and your first LibVLCSharp application.

Learn More
How do I do X?

Common questions and practical examples.

Learn More
Best Practices

Guidelines and patterns for effective LibVLCSharp usage.

Learn More

Platform Support

LibVLCSharp supports a wide range of platforms and UI frameworks:

  • Desktop: Windows (WPF, WinForms), macOS, Linux (GTK)
  • Mobile: iOS, Android (Xamarin.Forms, .NET MAUI)
  • Universal: UWP, Uno Platform
  • Server: .NET Core, ASP.NET Core

Getting Help

If you need assistance:

  1. Check our documentation and troubleshooting guide
  2. Browse community samples for examples
  3. Join our Discord community
  4. Report issues on GitLab