0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: DTV.video
0003
0004 .. _VIDEO_STOP:
0005
0006 ==========
0007 VIDEO_STOP
0008 ==========
0009
0010 Name
0011 ----
0012
0013 VIDEO_STOP
0014
0015 .. attention:: This ioctl is deprecated.
0016
0017 Synopsis
0018 --------
0019
0020 .. c:macro:: VIDEO_STOP
0021
0022 ``int ioctl(fd, VIDEO_STOP, boolean mode)``
0023
0024 Arguments
0025 ---------
0026
0027 .. flat-table::
0028 :header-rows: 0
0029 :stub-columns: 0
0030
0031 - .. row 1
0032
0033 - int fd
0034
0035 - File descriptor returned by a previous call to open().
0036
0037 - .. row 2
0038
0039 - int request
0040
0041 - Equals VIDEO_STOP for this command.
0042
0043 - .. row 3
0044
0045 - Boolean mode
0046
0047 - Indicates how the screen shall be handled.
0048
0049 - .. row 4
0050
0051 -
0052 - TRUE: Blank screen when stop.
0053
0054 - .. row 5
0055
0056 -
0057 - FALSE: Show last decoded frame.
0058
0059 Description
0060 -----------
0061
0062 This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
0063 V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
0064
0065 This ioctl call asks the Video Device to stop playing the current
0066 stream. Depending on the input parameter, the screen can be blanked out
0067 or displaying the last decoded frame.
0068
0069 Return Value
0070 ------------
0071
0072 On success 0 is returned, on error -1 and the ``errno`` variable is set
0073 appropriately. The generic error codes are described at the
0074 :ref:`Generic Error Codes <gen-errors>` chapter.
