]> git.sesse.net Git - nageru-docs/commitdiff
Document video:disconnect().
authorSteinar H. Gunderson <sgunderson@bigfoot.com>
Sat, 28 Apr 2018 15:01:31 +0000 (17:01 +0200)
committerSteinar H. Gunderson <sgunderson@bigfoot.com>
Sat, 28 Apr 2018 15:01:34 +0000 (17:01 +0200)
video.rst

index 88cf383b4df59f30978c6d1dcc6651df37509614..4f1ebcab8bb6f04905fdb88b2025e74efb0871db 100644 (file)
--- 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
 -------------------------