Unverified Commit 8b0477dc authored by Martin Finkel's avatar Martin Finkel Committed by GitHub
Browse files

Create README

parent a7109ed6
# LibVLCSharp
LibVLCSharp are .NET bindings for `libvlc`, the multimedia framework powering the VLC applications.
## 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.
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!).
Check out the [VideoLAN Forum](https://forum.videolan.org/index.php) if you have questions or IRC.
# What is it?
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.
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)
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