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

Added GTK and Android.AWindow docs

(cherry picked from commit e543573c8917c27e70a3c6923b8e64722a6593d8)
parent c001455c
# LibVLCSharp.Android.AWindow
This project is an implementation detail for LibVLCSharp on the android platform.
libvlc for android needs the AWindow class, which is provided by the Jars/org.videolan.libvlc.aar file.
This project generates Xamarin bindings for this java classes.
\ No newline at end of file
......@@ -2,28 +2,16 @@
<PropertyGroup>
<Title>LibVLCSharp.GTK</Title>
<Summary>GTK integration for LibVLCSharp</Summary>
<Description>LibVLCSharp is a cross-platform audio and video API for .NET platforms based on VideoLAN's LibVLC Library.
It provides a comprehensive multimedia API that can be used across mobile, server and desktop to render video and output audio. Mono, .NET Framework and .NET Core runtimes are supported.
<Description>The official GTK# (mono/gtk-sharp) views for LibVLCSharp.
Supported platforms:
- Xamarin.Android
- Xamarin.iOS
- Xamarin.Mac
- Windows (WPF/WinForms)
- Xamarin.Forms
- .NET Standard 1.1
- .NET Core
This package contains the views that allows to display a video played with LibVLCSharp
in a GTK# app.
Features:
- Network browsing for distant filesystems (SMB, FTP, SFTP, NFS...).
- HDMI passthrough for Audio HD codecs, like E-AC3, TrueHD or DTS-HD.
- Stream to distant renderers, like Chromecast.
- 360 video and 3D audio playback with viewpoint change.
- Support for Ambisonics audio and more than 8 audio channels.
- Subtitles size modification live.
- Hardware decoding and display on all platforms.
- DVD playback and menu navigation.
LibVLCSharp.Forms.Platforms.GTK depends on this package.
This package depends on LibVLCSharp.
libvlc needs to be installed separately.
</Description>
<TargetFramework>net47</TargetFramework>
<RootNamespace>LibVLCSharp.GTK</RootNamespace>
......@@ -36,10 +24,10 @@ Features:
<UseFullSemVerForNuGet>false</UseFullSemVerForNuGet>
<PackageLicenseExpression>LGPL-2.1-or-later</PackageLicenseExpression>
<RepositoryType>git</RepositoryType>
<RepositoryUrl>https://code.videolan.org/videolan/LibVLCSharp</RepositoryUrl>
<RepositoryUrl>https://code.videolan.org/videolan/LibVLCSharp/tree/master/LibVLCSharp.GTK</RepositoryUrl>
<PackageIconUrl>https://code.videolan.org/videolan/LibVLCSharp/raw/master/Assets/icon.png</PackageIconUrl>
<PackageReleaseNotes>https://code.videolan.org/videolan/LibVLCSharp/blob/master/NEWS</PackageReleaseNotes>
<PackageTags>libvlc;vlc;videolan;native;c/c++;video;audio;player;media;mediaplayer;codec;ffmpeg;xamarin;graphics;ios;android;linux;windows;macos;cross-platform</PackageTags>
<PackageTags>libvlc;vlc;videolan;video;audio;player;media;mediaplayer;gtk-sharp;linux;windows;cross-platform</PackageTags>
</PropertyGroup>
<ItemGroup>
<Reference Include="gdk-sharp">
......
# LibVLCSharp.GTK
[![NuGet Stats](https://img.shields.io/nuget/v/LibVLCSharp.GTK.svg)](https://www.nuget.org/packages/LibVLCSharp.GTK)
[![NuGet Stats](https://img.shields.io/nuget/dt/LibVLCSharp.GTK.svg)](https://www.nuget.org/packages/LibVLCSharp.GTK)
The official [GTK#](https://github.com/mono/gtk-sharp) views for [LibVLCSharp](../LibVLCSharp).
This package contains the views that allows to display a video played with [LibVLCSharp](../LibVLCSharp)
in a GTK# app (the mono/gtk-sharp one, [see below](#note-on-gtk-sharp)).
[LibVLCSharp.Forms.Platforms.GTK](../LibVLCSharp.Forms.Platforms.GTK) depends on this package.
This package depends on [LibVLCSharp](../LibVLCSharp).
Supported frameworks:
- net47 (on mono)
Supported platforms :
- Windows
- Linux
NOTE: This package does not currently support MacOSX! See [this issue](https://code.videolan.org/videolan/LibVLCSharp/issues/92)
WARNING : To create a GTK# program and run the samples, you will need mono and GTK# installed on the machine you build AND
on the machine you run.
## <a name="note-on-gtk-sharp"></a> A note on mono/gtk-sharp vs GtkSharp/GtkSharp
Let's face it, mono/gtk-sharp has a lot of drawbacks :
- It is based on GTK 2 (GTK 3 was released in 2011... but no stable version of GTK# for GTK3 as of now)
- Requires mono and GTK# installed on both the build and the target machine. (aka no nuget package)
Well, to be honnest, that's only two, but that's two big drawbacks.
On the other hand, [GtkSharp/GtkSharp](https://github.com/GtkSharp/GtkSharp) fixes this issues by providing a
.net standard 2.0 package for GTK 3.0
and NuGet packages for the GTK# libraries.
Unfortunately, Xamarin.Forms.GTK is only implemented using the former, which means that in order to support Xamarin.Forms.GTK, our views needs to support mono/gtk-sharp, hence this package.
## Why should I reference this package in my project?
If you you want to create a cross-platform video application using GTK#, this package is made for you.
You can also create a true cross-platform application with Xamarin.Forms, and use the GTK# backend to target linux and windows.
In that case, you would need the [LibVLCSharp.Forms.Platforms.GTK](../LibVLCSharp.Forms.Platforms.GTK) package instead,
which internally references this one.
For other platforms, see the [main documentation](../README.md)
\ No newline at end of file
......@@ -11,6 +11,8 @@ This package also contains the views for the following platforms:
- iOS
- Mac
- tvOS
libvlc needs to be installed separately.
</Description>
<TargetFrameworks>netstandard2.0;netstandard1.1;net40;net471</TargetFrameworks>
<TargetFrameworks Condition="!$([MSBuild]::IsOsPlatform('Linux'))">$(TargetFrameworks);MonoAndroid81;Xamarin.iOS10;Xamarin.Mac20;Xamarin.TVOS10</TargetFrameworks>
......
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