1.. Permission is granted to copy, distribute and/or modify this 2.. document under the terms of the GNU Free Documentation License, 3.. Version 1.1 or any later version published by the Free Software 4.. Foundation, with no Invariant Sections, no Front-Cover Texts 5.. and no Back-Cover Texts. A copy of the license is included at 6.. Documentation/media/uapi/fdl-appendix.rst. 7.. 8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections 9 10.. _VIDEO_STOP: 11 12========== 13VIDEO_STOP 14========== 15 16Name 17---- 18 19VIDEO_STOP 20 21.. attention:: This ioctl is deprecated. 22 23Synopsis 24-------- 25 26.. c:function:: int ioctl(fd, VIDEO_STOP, boolean mode) 27 :name: VIDEO_STOP 28 29 30Arguments 31--------- 32 33.. flat-table:: 34 :header-rows: 0 35 :stub-columns: 0 36 37 38 - .. row 1 39 40 - int fd 41 42 - File descriptor returned by a previous call to open(). 43 44 - .. row 2 45 46 - int request 47 48 - Equals VIDEO_STOP for this command. 49 50 - .. row 3 51 52 - Boolean mode 53 54 - Indicates how the screen shall be handled. 55 56 - .. row 4 57 58 - 59 - TRUE: Blank screen when stop. 60 61 - .. row 5 62 63 - 64 - FALSE: Show last decoded frame. 65 66 67Description 68----------- 69 70This ioctl is for Digital TV devices only. To control a V4L2 decoder use the 71V4L2 :ref:`VIDIOC_DECODER_CMD` instead. 72 73This ioctl call asks the Video Device to stop playing the current 74stream. Depending on the input parameter, the screen can be blanked out 75or displaying the last decoded frame. 76 77 78Return Value 79------------ 80 81On success 0 is returned, on error -1 and the ``errno`` variable is set 82appropriately. The generic error codes are described at the 83:ref:`Generic Error Codes <gen-errors>` chapter. 84