# VLC for Unity [![Join the chat at https://discord.gg/3h3K3JF](https://camo.githubusercontent.com/92f7e81da5fe4cf08cc42f1e576b8d15e23b8266/68747470733a2f2f696d672e736869656c64732e696f2f646973636f72642f3731363933393339363436343530383935383f6c6162656c3d646973636f7264)](https://discord.gg/3h3K3JF) This repository contains the native Unity plugin that bridges [LibVLCSharp](https://code.videolan.org/videolan/LibVLCSharp) with LibVLC for performance oriented video rendering in Unity3D applications and games. Available on the [Unity Store](https://assetstore.unity.com/packages/tools/video/vlc-for-unity-windows-133979). - [VLC for Unity](https://github.com/videolan/vlc-unity/raw/master/#VLC-for-Unity) - [LibVLC Features](https://github.com/videolan/vlc-unity/raw/master/#LibVLC-Features) - [Supported platforms](https://github.com/videolan/vlc-unity/raw/master/#Supported-platforms) - [Installation](https://github.com/videolan/vlc-unity/raw/master/#Installation) - [Getting started](https://github.com/videolan/vlc-unity/raw/master/#Getting-started) - [Documentation](https://github.com/videolan/vlc-unity/raw/master/#Documentation) - [Support](https://github.com/videolan/vlc-unity/raw/master/#Support) - [Samples](https://github.com/videolan/vlc-unity/raw/master/#Samples) - [Roadmap](https://github.com/videolan/vlc-unity/raw/master/#Roadmap) - [Platforms support](https://github.com/videolan/vlc-unity/raw/master/#Platforms-support) - [Graphics APIs](https://github.com/videolan/vlc-unity/raw/master/#Graphics-APIs) - [Other improvements](https://github.com/videolan/vlc-unity/raw/master/#Other-improvements) - [Release Notes](https://github.com/videolan/vlc-unity/raw/master/#Release-Notes) - [Building](https://github.com/videolan/vlc-unity/raw/master/#Building) - [Code of Conduct](https://github.com/videolan/vlc-unity/raw/master/#Code-of-Conduct) - [License](https://github.com/videolan/vlc-unity/raw/master/#License) ## LibVLC Features Given that this plugin is using [LibVLCSharp](https://code.videolan.org/videolan/LibVLCSharp) (which uses LibVLC), it exposes more or less the [same feature set](https://code.videolan.org/videolan/LibVLCSharp#features) and same codecs support than VLC, such as: - Play every media file formats, every codec and every streaming protocols - Run on every platform, from desktop (Windows, Linux, Mac) to mobile (Android, iOS) and TVs - Hardware and efficient decoding on every platform, up to 8K - Network browsing for distant filesystems (SMB, FTP, SFTP, NFS...) and servers (UPnP, DLNA) - Playback of Audio CD, DVD and Bluray with menu navigation - Support for HDR, including tonemapping for SDR streams - Audio passthrough with SPDIF and HDMI, including for Audio HD codecs, like DD+, TrueHD or DTS-HD - Support for video and audio filters - Support for 360 video and 3D audio playback, including Ambisonics - Able to cast and stream to distant renderers, like Chromecast and UPnP renderers. And more. ## Supported platforms - Windows Classic x64 ## Installation The recommended way to install the VLC for Unity plugin is through the [Unity Store](https://assetstore.unity.com/packages/tools/video/vlc-for-unity-windows-133979). This also ensures you get commercial support with your build. | Platform | Unity Store Asset | | ----------------- | ----------------------------------------------- | | Windows | [![VLCUnityWindowsBadge]][VLCUnityWindows] | [RVLCUnityWindows]: https://assetstore.unity.com/packages/tools/video/vlc-for-unity-windows-133979 [VLCUnityWindows]: https://assetstore.unity.com/packages/tools/video/vlc-for-unity-windows-133979 [VLCUnityWindowsBadge]: https://camo.githubusercontent.com/a15a521aee59e0b58c968ed4114a0969acff65b3/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d616465253230776974682d556e6974792d3537623964332e7376673f7374796c653d666c6174266c6f676f3d756e697479 #### [Download the Free Trial Version](https://videolabs.io/#unity). ## Getting started There is a quick `documentation.txt` file [included in the package](https://github.com/videolan/vlc-unity/raw/master/Assets/VLC-Unity-Windows/documentation.txt). It gives some context and high level overview of how things work and how to get started. Since this Unity plugin largely shares the same API than LibVLCSharp, most LibVLCSharp [samples](https://code.videolan.org/mfkl/libvlcsharp-samples) and [documentation](https://code.videolan.org/videolan/LibVLCSharp/tree/3.x/docs) apply, do check those out! ## Documentation See the [LibVLCSharp documentation](https://code.videolan.org/videolan/LibVLCSharp/tree/master/docs). It includes [best practices](https://code.videolan.org/videolan/LibVLCSharp/blob/master/docs/best_practices.md), [Q&A guide](https://code.videolan.org/videolan/LibVLCSharp/blob/master/docs/how_do_I_do_X.md), [libvlc specific information](https://code.videolan.org/videolan/LibVLCSharp/blob/master/docs/libvlc_documentation.md) and [tutorials](https://code.videolan.org/videolan/LibVLCSharp/blob/master/docs/tutorials.md). ## Support Support is done on a volunteer base, professional support is only available for [paying customers](https://assetstore.unity.com/packages/tools/video/vlc-for-unity-windows-133979). ## Samples A minimal Unity sample is available [here](https://github.com/videolan/vlc-unity/raw/master/Assets/VLC-Unity-Windows/Scripts/MinimalPlayback.cs). Additional Unity samples will come soon. More LibVLCSharp samples can be found [here](https://code.videolan.org/mfkl/libvlcsharp-samples). ## Roadmap ### Platforms support - Android (prototype working), - macOS, iOS, tvOS, - UWP, - Linux. ### Graphics APIs - OpenGL ES, - OpenGL, - Metal. ### Other improvements - Provide various easy to use, ready-to-run samples and improved documentation. - Provide in-Editor MediaPlayer customization, so you can customize LibVLC and playback parameters directly from the Unity Editor. ## Release Notes Check out the [NEWS](https://github.com/videolan/vlc-unity/raw/master/NEWS) file for details about each release. ## Building ### Windows - Download and install https://github.com/mstorsjo/llvm-mingw on latest Debian (WSL or otherwise). Add it to path. - run `./get-libvlc-windows.sh` to download a win64 llvm libvlc 4 build. - Build with ``` ./build.sh ``` This will produce a `VLCUnityPlugin.dll` which you can use with LibVLCSharp in your Unity project - Extract the `vlc-cache-gen.exe` binary from the nightly build archive. Drag and drop the `plugins` folder onto it. Or just run the Unity scene with `_libVLC = new LibVLC("--reset-plugins-cache");`. This will produce a `plugins.dat` file in the `plugins` folder. ## Debugging Editor crash location: `C:\Users\YourUserName\AppData\Local\Temp\Unity\Editor\Crashes` ## Code of Conduct Please read and follow the [VideoLAN CoC](https://wiki.videolan.org/Code_of_Conduct/). ## License Licensed under the LGPL 2.1 and prorietary license via [Videolabs](https://videolabs.io/).