Commit f3cdc9cf authored by Martin Finkel's avatar Martin Finkel

docs: Add troubleshooting info

parent 9371d75b
......@@ -184,6 +184,7 @@ Our [Documentation](docs/home.md) is part of this repository.
Feel free to browse it and if you see something missing, you can improve it by sending a PR.
It includes helpful documents such as:
### [Best practices](docs/best_practices.md)
This document details how to use LibVLCSharp in a correct way, notably taking into consideration the native interop part.
......@@ -192,6 +193,10 @@ This document details how to use LibVLCSharp in a correct way, notably taking in
This is a Q&A document which I compiled from all the questions I got asked regarding LibVLC and LibVLCSharp. Continously updated.
### [Troubleshooting issues](docs/debugging.md)
When you encounter an issue with LibVLC/LibVLCSharp, identifying the cause is not always straightforward. This document gives you clues on how to go about it.
### [Libvlc specific information](docs/libvlc_documentation.md)
This page focuses on the core native library and contains information regarding advanced libvlc configuration and its versioning strategy by VideoLAN.
......
......@@ -8,6 +8,7 @@ LibVLCSharp is a cross-platform audio and video API for .NET platforms based on
- [LibVLC](#LibVLC)
- [LibVLCSharp](#LibVLCSharp)
- [How do I do X?](#How-do-I-do-X?)
- [Troubleshooting](troubleshooting.md)
- [MediaPlayerElement](#MediaPlayerElement)
- [General usage guidelines and best practices](#General-usage-guidelines-and-best-practices)
- [LibVLC documentation](#libvlc-documentation)
......
# Troubleshooting issues with LibVLC/LibVLCSharp
A good first step is to try to identify whether your issue is originating from the **core LibVLC library** or from the **C# bindings** code. This is not always straightforward to do.
## Debugging with libvlc logs
To better understand what might be going on inside libvlc during playback in your application, verbose logs are helpful. To enable them, use this argument when creating your `LibVLC` object:
```csharp
new LibVLC("--verbose=2");
```
## Try your code on multiple devices and platforms
Some issues are platform specific, some are even device specific, or driver specific. Luckily LibVLCSharp runs on many platforms, so testing on various OSes is one way to try and pinpoint the original issue.
## Reproduce in official VLC apps, desktop and mobile
Enable debug logs in the official VLC apps and compare the logs with those from your application.
\ 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