Unverified Commit 834491c2 authored by Martin Finkel's avatar Martin Finkel Committed by GitHub


parent bae443d4
......@@ -4,11 +4,18 @@ LibVLCSharp are .NET bindings for `libvlc`, the multimedia framework powering th
## libvlc
`libvlc` is written mostly in C. Check out the [documentation](https://www.videolan.org/developers/vlc/doc/doxygen/html/group__libvlc.html) for more info.
Checkout [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.
To bundle and use `libvlc`, you may either [compile it yourself](https://wiki.videolan.org/Category:Building/) for your platform, grab a [nightly build](https://nightlies.videolan.org/build/) or use NuGet (soon!).
Some of the features include:
Check out the [VideoLAN Forum](https://forum.videolan.org/index.php) if you have questions or IRC.
- 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.
# What is it?
......@@ -16,11 +23,19 @@ Heavily inspired from [libvlcpp](https://code.videolan.org/videolan/libvlcpp/tre
[CppSharp](https://github.com/mono/CppSharp) was used at the beginning for bootstrapping.
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. Contributions are always welcome.
Integration with platforms is a work in progress.
### Android
To integrate `libvlc` with Android, the P/Invoke way, there is an [Android specific C call](https://www.videolan.org/developers/vlc/doc/doxygen/html/group__libvlc__media__player.html#ga2a40175371247e4422ce52993935ae29) to make to setup things.
Check out the [Android](https://github.com/mfkl/LibVLCSharp/tree/android) branch for work in progress.
Current status: Audio works, video not yet (blocked by https://github.com/xamarin/xamarin-android/issues/1259)
Integration with platforms is a work in progress. Focus is on Xamarin integration (including Xamarin.Forms).
#### Currently supported platforms (with working sample):
- Android
- Windows
#### Roadmap:
- iOS
- macOS
- Linux (GTK)
- Tizen
- Unity
- F# sample
All contributions are welcome.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment