Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mfkl/libvlc-nuget
NuGet packaging setup for LibVLC
https://github.com/mfkl/libvlc-nuget
audio c dotnet libvlc media native nuget-packaging player video vlc
Last synced: 12 days ago
JSON representation
NuGet packaging setup for LibVLC
- Host: GitHub
- URL: https://github.com/mfkl/libvlc-nuget
- Owner: mfkl
- License: lgpl-2.1
- Created: 2017-09-22T09:00:05.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T10:19:10.000Z (about 2 months ago)
- Last Synced: 2024-10-12T01:24:47.884Z (27 days ago)
- Topics: audio, c, dotnet, libvlc, media, native, nuget-packaging, player, video, vlc
- Language: C#
- Homepage:
- Size: 139 KB
- Stars: 63
- Watchers: 12
- Forks: 10
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# `libvlc` for .NET
[](https://discord.gg/3h3K3JF)
This repository is about presenting `libvlc` and its capabilities to .NET developers.
It also contains packaging tools and files for nuget packaging/deployment.
In other words: It's just the same thing as if you had downloaded the files from VideoLAN's website, in a NuGet package,
that you can add in your .NET project so that it gets copied into the output directory.
- [What is libvlc?](#What-is-libvlc)
- [How do I use this thing from .NET?](#How-do-I-use-this-thing-from-.NET)
- [Build and packaging customization with MSBuild](#Build-and-packaging-customization-with-MSBuild)
- [Supported platforms](#Supported-platforms)
- [Windows Classic](#windows-classic)
- [Windows Universal](#windows-universal)
- [Android](#android)
- [iOS](#iOS)
- [macOS](#macOS)
- [tvOS](#tvOS)
- [Linux](#linux)
- [Unity3D](#Unity3D)
- [Roadmap](#roadmap)
- [Commercial services](#Commercial-services)
# What is libvlc?
`libvlc` is the multimedia framework powering the VLC applications. It is fully opensource, so other apps use it too.
**API documentation**: https://www.videolan.org/developers/vlc/doc/doxygen/html/group__libvlc.html
it contains all modules, data structures and functions documentation to understand how to use the `libvlc` C API.
The **source** is in the main VLC repository: https://github.com/videolan/vlc
`libvlc` is *modularized* into hundreds of plugins, which may be loaded at runtime. This architecture provides great flexibility to developers (both VLC devs and devs consuming the library). The unified, complete and (somewhat) high level `libvlc` C API allows a wide range of operations, 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.
Full list of the new 3.0 features can be found here: https://www.videolan.org/vlc/releases/3.0.0.html
Full directory tree overview of what's included (dlls, headers, lib files) in the nuget can be found at https://github.com/mfkl/libvlc-nuget/blob/master/tree.md
# How do I use this thing from .NET?
There are usually 2 ways to go about consuming C code from .NET:
- Using [C++/CX](https://docs.microsoft.com/en-us/cpp/cppcx/visual-c-language-reference-c-cx). This allows to author [Windows Runtime components](https://docs.microsoft.com/en-us/cpp/windows/windows-runtime-cpp-template-library-wrl) and it is Windows-specific. [VLC for UWP](https://code.videolan.org/videolan/vlc-winrt) currrently works this way using both [libvlcppcx](https://github.com/kakone/libVLCX) and [libvlcpp](https://code.videolan.org/videolan/libvlcpp).
- Using [P/Invoke](http://www.mono-project.com/docs/advanced/pinvoke/). If crossplatform is a focus, you should checkout [LibVLCSharp](https://github.com/videolan/libvlcsharp).
Versioning of the nuget packages naturally follow the libvlc versioning.
# Build and packaging customization with MSBuild
How do I configure what gets copied to my output directory?
Currently, you can customize three things during the build:
- [Whether the library gets copied or not](library-copy-enabling.md)
- [Where the library is placed in the output folder](files-location-selection.md)
- [Which files are copied](cherry-picking.md)
# Supported platforms
#### LibVLC 3:
Latest stable version is [3.0.21](https://code.videolan.org/videolan/vlc/-/tags). Feel free to check out the [release notes](https://code.videolan.org/videolan/vlc/-/blob/3.0.x/NEWS).
Minimum OS version supported by LibVLC 3.x:
- Windows XP
- macOS 10.7
- iOS 7
- Android 2.3
## Windows Classic
```cmd
dotnet add package VideoLAN.LibVLC.Windows
```
*For the GPL version, use the following command:*
```cmd
dotnet add package VideoLAN.LibVLC.Windows.GPL
```
[](https://www.nuget.org/packages/VideoLAN.LibVLC.Windows)
[](https://www.nuget.org/packages/VideoLAN.LibVLC.Windows)
#### Supported CPU architectures:
- x86
- x64
*Note: if you intend to use libvlc with UWP projects, you probably need to install the [UWP](#windows-universal) package instead because this build directly uses win32 APIs.*
## Windows Universal
```cmd
dotnet add package VideoLAN.LibVLC.UWP
```
[](https://www.nuget.org/packages/VideoLAN.LibVLC.UWP)
[](https://www.nuget.org/packages/VideoLAN.LibVLC.UWP)
#### Supported CPU architectures:
- x86
- x64
- ARM
## Android
```cmd
dotnet add package VideoLAN.LibVLC.Android
```
[](https://www.nuget.org/packages/VideoLAN.LibVLC.Android)
[](https://www.nuget.org/packages/VideoLAN.LibVLC.Android)
#### Supported CPU architectures:
- armeabi-v7a
- arm64-v8a
- x86
- x86_64
## iOS
```cmd
dotnet add package VideoLAN.LibVLC.iOS
```
[](https://www.nuget.org/packages/VideoLAN.LibVLC.iOS)
[](https://www.nuget.org/packages/VideoLAN.LibVLC.iOS)
#### Supported CPU architectures:
- i386
- x86_64
- ARMv7
- ARM64
## macOS
```cmd
dotnet add package VideoLAN.LibVLC.Mac
```
[](https://www.nuget.org/packages/VideoLAN.LibVLC.Mac)
[](https://www.nuget.org/packages/VideoLAN.LibVLC.Mac)
#### Supported CPU architecture:
- x86_64
## tvOS
```cmd
dotnet add package VideoLAN.LibVLC.tvOS
```
[](https://www.nuget.org/packages/VideoLAN.LibVLC.tvOS)
[](https://www.nuget.org/packages/VideoLAN.LibVLC.tvOS)
#### Supported CPU architecture:
- x86_64
- ARM64
## Linux
For Ubuntu, follow this [guide](https://code.videolan.org/videolan/LibVLCSharp/blob/master/docs/linux-setup.md).
## Unity3D
| Platform | Unity Store Asset |
| ----------------- | ---------------------------------------------- |
| Unity3D - Windows | [![VLCUnityBadge]][VLCUnityStore] |
| Unity3D - UWP | [![VLCUnityBadge]][VLCUnityStore] |
| Unity3D - Android | [![VLCUnityBadge]][VLCUnityStore] |
| Unity3D - iOS | [![VLCUnityBadge]][VLCUnityStore] |
| Unity3D - macOS | [![VLCUnityBadge]][VLCUnityStore] |
[VLCUnityStore]: https://videolabs.io/store/unity
[VLCUnityBadge]: https://img.shields.io/badge/Made%20with-Unity-57b9d3.svg?style=flat&logo=unity
# Roadmap
- More Unity back-ends and other game engines
- WebAssembly
- LibVLC 4
# Commercial services
If you would like VLC developers to provide you with:
- custom development on LibVLC and/or LibVLCSharp,
- training and workshops,
- [LibVLCSharp commercial licenses](https://videolabs.io/solutions/libvlcsharp),
- support services,
- consulting services,
- other multimedia services.
Feel free to [contact us](https://videolabs.io/#contact).