Commit 3f85b9d8 authored by Jérémy VIGNELLES's avatar Jérémy VIGNELLES Committed by Martin Finkel

Added documentation about the UWP target

parent 885238d9
......@@ -56,6 +56,30 @@ The content you place inside the `VideoView` is used for the window, like this:
</lvs:VideoView>
```
## UWP
These issues are issues of libvlc 3, that we hope to get fixed for libvlc 4
### LibVLC additionnal parameters
tl;dr : If you want to play a video with UWP, integrate the `VideoView` in your control, handle the `Loaded` event and then initialize your player with:
```cs
new LibVLC(VideoView.GetSwapChainOptions());
```
Detailed explanation:
In UWP here are mandatory options to be given to the LibVLC constructor. These options tells libvlc (and more precisely the DirectX plugin) where to output the video, using a so-called "swap chain".
This initialization step will disappear in libvlc 4, but for now, you will need to have a code similar to [this one](Samples/LibVLCSharp.UWP.Sample/MainPage.xaml.cs)
### Automatic audio output module selection
tl;dr : You don't have anything to do. This section explains how things work internally
Detailed explanation:
When you create a `new LibVLC()` in UWP, the `--aout=winstore` is automatically added. This means that you can't specify another `--aout` option in that constructor.
# Documentation
For usage of the API, you should check out the `libvlc` [C API documentation](https://www.videolan.org/developers/vlc/doc/doxygen/html/group__libvlc.html) which this wrapper follows closely.
\ No newline at end of file
......@@ -61,6 +61,7 @@ Mono, .NET Framework and .NET Core runtimes are supported.
- Xamarin.tvOS
- Xamarin.Mac (Cocoa)
- Windows (WPF, WinForms, GTK)
- Windows 10 (UWP)
- Linux (GTK)
- Xamarin.Forms
- .NET Standard 1.1 and 2.0
......@@ -73,6 +74,7 @@ Mono, .NET Framework and .NET Core runtimes are supported.
| Platform | LibVLC Package | NuGet | Minimum OS Version |
| ----------------- | ----------------------------------- | -------------------------------------- |--------------------|
| Windows | VideoLAN.LibVLC.Windows | [![LibVLCWindowsBadge]][LibVLCWindows] | Windows XP |
| UWP | VideoLAN.LibVLC.WindowsRT | [![LibVLCWin10Badge]][LibVLCWin10] | Windows 10 |
| Mac | VideoLAN.LibVLC.Mac | [![LibVLCMacBadge]][LibVLCMac] | macOS 10.7 |
| Android | VideoLAN.LibVLC.Android | [![LibVLCAndroidBadge]][LibVLCAndroid] | Android 2.3 |
| iOS | VideoLAN.LibVLC.iOS | [![LibVLCiOSBadge]][LibVLCiOS] | iOS 8.4 |
......@@ -80,7 +82,7 @@ Mono, .NET Framework and .NET Core runtimes are supported.
| Linux | [Linux guide](docs/linux-setup.md) | N/A | N/A |
```cmd
dotnet add package VideoLAN.LibVLC.[Windows|Android|iOS|Mac|tvOS]
dotnet add package VideoLAN.LibVLC.[Windows|WindowsRT|Android|iOS|Mac|tvOS]
```
LibVLC is the actual VLC engine written mostly in C/C++ and compiled for your target platform. More information [here](https://code.videolan.org/videolan/libvlc-nuget).
......@@ -94,6 +96,7 @@ LibVLC is the actual VLC engine written mostly in C/C++ and compiled for your ta
| Xamarin.iOS | [LibVLCSharp](LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
| Xamarin.tvOS | [LibVLCSharp](LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
| Xamarin.Mac | [LibVLCSharp](LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
| UWP | [LibVLCSharp](LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
| Xamarin.Forms | [LibVLCSharp.Forms](LibVLCSharp.Forms/README.md)| [![LibVLCSharpFormsBadge]][LibVLCSharpForms] |
| WPF | LibVLCSharp.WPF | [![LibVLCSharpWPFBadge]][LibVLCSharpWPF] |
| Xamarin.Forms.WPF | [LibVLCSharp.Forms.WPF][RLibVLCSharpFormsWPF] | [![LibVLCSharpFormsWPFBadge]][LibVLCSharpFormsWPF]|
......@@ -109,6 +112,9 @@ LibVLCSharp is the .NET wrapper that consumes `LibVLC` and allows you to interac
[LibVLCWindowsBadge]: https://img.shields.io/nuget/v/VideoLAN.LibVLC.Windows.svg
[LibVLCWindows]: https://www.nuget.org/packages/VideoLAN.LibVLC.Windows/
[LibVLCWin10Badge]: https://img.shields.io/nuget/v/VideoLAN.LibVLC.WindowsRT.svg
[LibVLCWin10]: https://www.nuget.org/packages/VideoLAN.LibVLC.WindowsRT/
[LibVLCMac]: https://www.nuget.org/packages/VideoLAN.LibVLC.Mac/
[LibVLCMacBadge]: https://img.shields.io/nuget/v/VideoLAN.LibVLC.Mac.svg
......@@ -144,7 +150,7 @@ LibVLCSharp is the .NET wrapper that consumes `LibVLC` and allows you to interac
## Getting started
Follow the [Getting started guide](GETTING-STARTED.md).
Follow the [Getting started guide](GETTING-STARTED.md). Make sure you read it since it contains platform-specific caveats
## Samples
......
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