Commit f59c7c3c authored by Martin Finkel's avatar Martin Finkel

docs: various improvements/fixes

parent 7ff81be1
......@@ -12,7 +12,7 @@ The `MinimalPlayback` one provides a simple approach to getting video on the scr
The steps are:
1. Instantiate a `VideoView` and add it to your main View.
2. Call `Core.Initialize()` to load the `libvlc` native libraries, depending on your host platform.
2. Call `Core.Initialize()` to load the `libvlc` native libraries. **This call _must_ be made before creating any libvlcsharp object!**
3. The `VideoView` offers a `MediaPlayer` object (with data-binding support) which you should create and set on the `VideoView`. The `MediaPlayer` allows you to control playback with APIs such as `Play`, `Pause`, set a new media or listen for playback events.
4. In case you are using `LibVLCSharp.Forms`, make sure to call `LibVLCSharpFormsRenderer.Init()` in your platform specific project [*before*](https://forums.xamarin.com/discussion/comment/57605/#Comment_57605) `Xamarin.Forms.Forms.Init` is called. See the [Forms sample](https://github.com/videolan/libvlcsharp/tree/master/Samples/Forms).
......
......@@ -122,7 +122,7 @@ If you are using the `MediaPlayerElement`, then it is built-in in the UI.
If not, you should play with the `Scale` and `AspectRatio` MediaPlayer properties.
See https://code.videolan.org/videolan/LibVLCSharp/blob/3.x/LibVLCSharp/Shared/MediaPlayerElement/AspectRatioManager.cs#L130
See https://code.videolan.org/videolan/LibVLCSharp/-/blob/3.x/src/LibVLCSharp/Shared/MediaPlayerElement/AspectRatioManager.cs
# How do I change the movie play rate?
......@@ -159,7 +159,7 @@ https://stackoverflow.com/questions/56487740/how-to-achieve-looping-playback-wit
```csharp
using var libVLC = new LibVLC();
using var media = new Media(libVLC, "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ElephantsDream.mp4", FromType.FromLocation);
using var media = new Media(libVLC, new Uri("http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ElephantsDream.mp4"));
await media.Parse(MediaParseOptions.ParseNetwork);
......
......@@ -9,6 +9,12 @@ LibVLCSharp is based on LibVLC, so most of the LibVLC API documentation is very
You can find it here [LibVLC Doc](https://www.videolan.org/developers/vlc/doc/doxygen/html/group__libvlc.html). It currently tracks VLC master (4.0). The search box at the top right allows you to search for LibVLC C API functions and get doc on it. You can also check out documentation from the LibVLC header files directly from the [VLC source code](https://code.videolan.org/videolan/vlc/tree/master/include/vlc).
## LibVLC on NuGet
LibVLC is being distributed on NuGet from the [VideoLAN account](https://www.nuget.org/profiles/videolan).
The packaging files and more packages details can be found at https://code.videolan.org/videolan/libvlc-nuget
## LibVLC Options
Some advanced customizations and features are only accessible through LibVLC options. Those take the form of strings that you give to the LibVLC library through the `LibVLC` constructor and/or through `media.AddOption`.
......
......@@ -4,6 +4,12 @@
<img src="/src/assets/media-element.png"/>
</h3>
## Getting started
The best way to get started is to use the samples https://code.videolan.org/videolan/LibVLCSharp/-/tree/3.x/samples/Forms/LibVLCSharp.Forms.MediaElement
It already has the fonts (that are needed for icons) and necessary setup for custom renderers.
## What's available out of the box?
- Show/Hide playback controls automatically
......
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