README.md 1.44 KB
Newer Older
Martin Finkel's avatar
Martin Finkel committed
1 2 3 4
# LibVLCSharp

LibVLCSharp are .NET bindings for `libvlc`, the multimedia framework powering the VLC applications.

Martin Finkel's avatar
Martin Finkel committed
5
## Features
Martin Finkel's avatar
Martin Finkel committed
6

Martin Finkel's avatar
Martin Finkel committed
7
Check out [libvlc-nuget](https://github.com/mfkl/libvlc-nuget) to get a basic understanding of how `libvlc` works, what it can offer and how to install it with NuGet.
Martin Finkel's avatar
Martin Finkel committed
8

Martin Finkel's avatar
Martin Finkel committed
9
Some of the features include:
Martin Finkel's avatar
Martin Finkel committed
10

Martin Finkel's avatar
Martin Finkel committed
11 12 13 14 15 16 17 18
- Network browsing for distant filesystems (SMB, FTP, SFTP, NFS...).
- HDMI passthrough 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 decoding and display on all platforms.
- DVD playback and menu navigation.
Martin Finkel's avatar
Martin Finkel committed
19

Martin Finkel's avatar
Martin Finkel committed
20
## Status
Martin Finkel's avatar
Martin Finkel committed
21 22 23 24

Heavily inspired from [libvlcpp](https://code.videolan.org/videolan/libvlcpp/tree/master/vlcpp) and using parts from [Vlc.DotNet](https://github.com/ZeBobo5/Vlc.DotNet), LibVLCSharp is aimed at Xamarin platforms (iOS/Android first, Forms). 
[CppSharp](https://github.com/mono/CppSharp) was used at the beginning for bootstrapping.

Martin Finkel's avatar
Martin Finkel committed
25
Core public APIs are mostly done but still need a few things to be ironed out. Some tests need to be fixed and more need to be written. Integration with platforms is a work in progress.
Martin Finkel's avatar
Martin Finkel committed
26 27

#### Currently supported platforms (with working sample):
Martin Finkel's avatar
Martin Finkel committed
28 29
- Xamarin.Android
- Xamarin.iOS
Martin Finkel's avatar
Martin Finkel committed
30 31 32 33 34 35 36 37 38 39
- Windows

#### Roadmap:
- macOS
- Linux (GTK)
- UWP
- Tizen
- Unity

All contributions are welcome.