From a541921afd66122b201434aeb669f8074bf20415 Mon Sep 17 00:00:00 2001 From: bastimeyer Date: Mon, 20 Nov 2023 22:23:31 +0100 Subject: [PATCH] docs: remove common issues page --- docs/cli/tutorial.rst | 7 +++---- docs/index.rst | 1 - docs/issues.rst | 47 ------------------------------------------- 3 files changed, 3 insertions(+), 52 deletions(-) delete mode 100644 docs/issues.rst diff --git a/docs/cli/tutorial.rst b/docs/cli/tutorial.rst index 89644105..5701124f 100644 --- a/docs/cli/tutorial.rst +++ b/docs/cli/tutorial.rst @@ -76,10 +76,9 @@ specify ``worst`` to get the lowest quality. Now that you have a basic grasp of how Streamlink works, you may want to look into customizing it to your own needs, such as: -- Creating a :ref:`configuration file ` of options you - want to use -- Setting up your player to :ref:`cache some data ` - before playing the stream to help avoiding buffering issues +- Creating a :ref:`configuration file ` of options you want to use. +- Setting up your player to cache some data before playing the stream to help avoiding buffering issues + or reducing its default buffering values for being able to watch low-latency streams. .. _Command Prompt: https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/windows-commands diff --git a/docs/index.rst b/docs/index.rst index 5efb05f2..faf58910 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -82,7 +82,6 @@ Table of contents cli plugins players - issues deprecations migrations developing diff --git a/docs/issues.rst b/docs/issues.rst deleted file mode 100644 index 7db61865..00000000 --- a/docs/issues.rst +++ /dev/null @@ -1,47 +0,0 @@ -Common issues -============= - -Streams are buffering/lagging ------------------------------ - -Enable caching in your player -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -By default most players do not cache the data they receive from Streamlink. -Caching can reduce the amount of buffering you run into because the player will -have some breathing room between receiving the data and playing it. - -.. list-table:: - :header-rows: 1 - - * - Player - - Parameter - - Note - * - MPC-HC - - - - Currently no way of configuring the cache - * - MPlayer - - ``-cache `` - - Between 1024 and 8192 is recommended - * - mpv - - ``--cache=yes --demuxer-max-bytes=`` - - Between 1024 and 8192 is recommended - * - VLC - - ``--file-caching --network-caching `` - - Between 1000 and 10000 is recommended - -Use the :option:`--player-args` option to pass these options to your player. - - -Multi-threaded streaming -^^^^^^^^^^^^^^^^^^^^^^^^ - -On segmented streaming protocols (such as HLS and DASH) it's possible to use -multiple threads for downloading multiple segments at the same time to -potentially increase the throughput. This can be done via Streamlink's -:option:`--stream-segment-threads` argument. - -.. note:: - - Using 2 or 3 threads should be enough to see an impact on live streams, - any more will likely not show much effect.