From: Steinar H. Gunderson <sgunderson@bigfoot.com>
Date: Sat, 28 Apr 2018 15:01:31 +0000 (+0200)
Subject: Document video:disconnect().
X-Git-Url: https://git.sesse.net/?p=nageru-docs;a=commitdiff_plain;h=7aed7f4d072d6711fe118a817b62f7e64098f283

Document video:disconnect().
---

diff --git a/video.rst b/video.rst
index 88cf383..4f1ebca 100644
--- a/video.rst
+++ b/video.rst
@@ -96,6 +96,15 @@ negative nor exactly zero. You can set a rate to e.g. 1e-6 if you want to
 in practice stop the video; once you change it back to normal speed,
 the next frame will resume playing.
 
+Finally, if you want to forcibly abort the playing of a video,
+even one that is blocking on I/O, you can use (since Nageru 1.7.2)::
+
+  video:disconnect()
+
+This is particularly useful when dealing with network streams, as FFmpeg does not
+always properly detect if the connection has been lost. See :ref:`menus`
+for a way to expose such functionality to the operator.
+
 
 Integration with CasparCG
 -------------------------