# vlc-unity-1

**Repository Path**: cloudlin/vlc-unity-1

## Basic Information

- **Project Name**: vlc-unity-1
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: LGPL-2.1
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-08-28
- **Last Updated**: 2024-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h3 align="center">
    <a href="https://assetstore.unity.com/packages/tools/video/vlc-for-unity-windows-133979"><img src="/icons/Social_Media_Image_1200x630.png"/></a>
</h3>

# VLC for Unity

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](#VLC-for-Unity)
  - [LibVLC Features](#LibVLC-Features)
  - [Supported platforms](#Supported-platforms)
  - [Installation](#Installation)
  - [Getting started](#Getting-started)
  - [Documentation](#Documentation)
  - [Support](#Support)
  - [Samples](#Samples)
  - [Roadmap](#Roadmap)
    - [Platforms support](#Platforms-support)
    - [Graphics APIs](#Graphics-APIs)
    - [Other improvements](#Other-improvements)
  - [Release Notes](#Release-Notes)
  - [Building](#Building)
  - [Code of Conduct](#Code-of-Conduct)
  - [License](#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://img.shields.io/badge/Made%20with-Unity-57b9d3.svg?style=flat&logo=unity

## Getting started

There is a quick `documentation.txt` file [included in the package](./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/3.x/docs)

## 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](./Assets/VLC-Unity-Windows/Scripts/UseRenderingPlugin.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,
- Windows 32bit,
- UWP,
- Linux.

### Graphics APIs

- OpenGL ES,
- OpenGL,
- Metal,
- Direct3D9.

### 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](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.
- Download VLC nightly build and adjust if need be `vlc-4.0.0-dev/sdk/lib` path to `LDFLAGS` in `Common.mk`
- Build with
```
./build.sh
```
This will produce a `VLCUnityPlugin.dll` which you can use with LibVLCSharp in your Unity project

## 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/).

<br/>
<h3 align="center">
    <a href="https://assetstore.unity.com/packages/tools/video/vlc-for-unity-windows-133979"><img src="icons/Icon_Image_160x160.png"/></a>
</h3>