Commit f3e470d5 authored by Martin Finkel's avatar Martin Finkel

docs: Mention libvlcsharp preview on 3.x

parent 620a72ce
......@@ -17,6 +17,7 @@ _The official repository URL for this repo is https://code.videolan.org/videolan
- [MediaPlayerElement](#mediaplayerelement)
- [Supported platforms](#supported-platforms)
- [Installation](#installation)
- [Preview builds](#Pre-release-versions)
- [Getting started](#getting-started)
- [Documentation](#documentation)
- [Migrating from Vlc.DotNet](docs/migrating_from_Vlc.DotNet.md)
......@@ -86,6 +87,8 @@ Mono, .NET Framework and .NET Core runtimes are supported.
1. Install **LibVLC** in your platform specific project.
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).
| Platform | LibVLC Package | NuGet | Minimum OS Version |
| ----------------- | ----------------------------------- | -------------------------------------- |--------------------|
| Windows | VideoLAN.LibVLC.Windows | [![LibVLCWindowsBadge]][LibVLCWindows] | Windows XP |
......@@ -100,10 +103,10 @@ Mono, .NET Framework and .NET Core runtimes are supported.
dotnet add package VideoLAN.LibVLC.[Windows|UWP|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).
2. Install **LibVLCSharp** _or_ **LibVLCSharp.Forms** (if you plan on using Xamarin.Forms)
LibVLCSharp is the .NET wrapper that consumes `LibVLC` and allows you to interact with native code from C#/F#.
| Platform | LibVLCSharp Package | NuGet |
| ----------------- | ----------------------------------------------- | ------------------------------------------------- |
| .NET Standard | [LibVLCSharp](src/LibVLCSharp/README.md) | [![LibVLCSharpBadge]][LibVLCSharp] |
......@@ -121,7 +124,19 @@ LibVLC is the actual VLC engine written mostly in C/C++ and compiled for your ta
| Uno Platform | [LibVLCSharp.Uno][RLibVLCSharpUno] | [![LibVLCSharpUnoBadge]][LibVLCSharpUno] |
| Unity3D - Windows | [VLC for Unity (Windows)][RVLCUnityWindows] | [![VLCUnityWindowsBadge]][VLCUnityWindows] |
LibVLCSharp is the .NET wrapper that consumes `LibVLC` and allows you to interact with native code from C#/F#.
### Pre-release versions
LibVLCSharp 4 preview and LibVLC 4 nightly builds are distributed using https://feedz.io/ for now. To pull pre-release versions into your project, use the following `NuGet.config` file:
```
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<add key="videolan-preview" value="https://f.feedz.io/videolan/preview/nuget/index.json" />
</packageSources>
</configuration>
```
See the docs for [preview builds installation details](docs/libvlc_preview.md).
[RLibVLCSharpForms]: src/LibVLCSharp.Forms/README.md
[RLibVLCSharpWPF]: src/LibVLCSharp.WPF/README.md
......@@ -243,7 +258,8 @@ The [LibVLCSharp.Forms](src/LibVLCSharp.Forms/README.md) and [Uno](src/LibVLCSha
## Roadmap
- Game engines (Unity, Unreal, Godot)
- Game engines ([Unity](https://code.videolan.org/videolan/vlc-unity), [Unreal](https://code.videolan.org/videolan/LibVLCSharp/-/issues/357), Godot)
- [LibVLC 4 support](docs/libvlc_preview.md)
If you have a request or question regarding the roadmap, feel free to open an [issue](https://code.videolan.org/videolan/LibVLCSharp/issues) (using an issue template) or [PR](https://github.com/videolan/libvlcsharp/pulls).
......
......@@ -7,6 +7,7 @@ LibVLCSharp is a cross-platform audio and video API for .NET platforms based on
- [Installation steps](#Installation-steps).
- [LibVLC](#LibVLC)
- [LibVLCSharp](#LibVLCSharp)
- [Preview versions](libvlc_preview.md)
- [Migrating from Vlc.Dotnet](migrating_from_Vlc.DotNet.md)
- [How do I do X?](#How-do-I-do-X?)
- [Troubleshooting](troubleshooting.md)
......@@ -25,9 +26,13 @@ Follow our [Getting Started](getting_started.md) guide.
# Installation steps
Stable builds can be pulled from nuget.org, while pre-release builds are on feedz.io.
### LibVLC
Read and follow https://code.videolan.org/videolan/libvlc-nuget
You may download them from [NuGet](https://www.nuget.org/profiles/videolan).
Please read and follow https://code.videolan.org/videolan/libvlc-nuget.
### LibVLCSharp
......@@ -42,6 +47,20 @@ Read and follow https://code.videolan.org/videolan/libvlc-nuget
For Android specific things, head over to [Android](android.md).
### Stable versions
LibVLC 3.x and LibVLCSharp 3.x versions are the current _stable_ libvlc and libvlcsharp versions. Stable builds are recommended for production releases.
Please read and follow https://code.videolan.org/videolan/libvlc-nuget.
### Preview versions
LibVLC 4.x and LibVLCSharp 4.x versions are the current _preview_ libvlc and libvlcsharp versions. Be aware, these builds may be unstable and APIs may change at any time.
LibVLCSharp 3.x nightly builds are also available through feedz.
You may download them from feedz.io. For more details, see [LibVLC preview](libvlc_preview.md).
# How do I do X?
Check out our [How Do I Do X](how_do_I_do_X.md) page.
......
# LibVLC Preview
[Back](home.md)
LibVLC preview builds are development builds. They can be unstable, but allow you to enjoy new features before the stable release.
**It is advised NOT TO use these builds in production.**
- [Installation](#installation)
- [Source code](#source-code)
- [Stable/Preview differences](#stable-and-preview-differences)
- [LibVLC](#libvlc)
- [LibVLCSharp](#libvlcsharp)
# Installation
LibVLCSharp 3 and 4 preview and LibVLC 4 nightly builds are distributed using https://feedz.io/ for now. To pull pre-release versions into your project, use the following `NuGet.config` file:
```
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<add key="videolan-preview" value="https://f.feedz.io/videolan/preview/nuget/index.json" />
</packageSources>
</configuration>
```
# Source code
LibVLC: Development happens in the main git repository https://code.videolan.org/videolan/vlc
LibVLCSharp: master branch of https://code.videolan.org/videolan/LibVLCSharp
# Stable and Preview Differences
## LibVLC
Differences between LibVLC stable (3.x) and LibVLC preview (4.x)
release notes https://code.videolan.org/videolan/vlc/-/blob/master/README
## LibVLCSharp
Differences between LibVLCSharp stable (3.x) and LibVLCSharp preview (4.x)
_TODO_
API diffs,
platform support diffs (new/dropped)
- TFM diffs (new/dropped): `net40` was dropped in favor of `net45` in libvlcsharp 4.
- namespace changes: `Shared` was removed.
- unsafe usage -> perf diff, ongoing
https://code.videolan.org/videolan/LibVLCSharp/-/issues?scope=all&utf8=%E2%9C%93&state=opened&milestone_title=LibVLCSharp%204
\ No newline at end of file
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