1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2.. c:namespace:: DTV.video
3
4.. _VIDEO_STOP:
5
6==========
7VIDEO_STOP
8==========
9
10Name
11----
12
13VIDEO_STOP
14
15.. attention:: This ioctl is deprecated.
16
17Synopsis
18--------
19
20.. c:macro:: VIDEO_STOP
21
22``int ioctl(fd, VIDEO_STOP, boolean mode)``
23
24Arguments
25---------
26
27.. flat-table::
28    :header-rows:  0
29    :stub-columns: 0
30
31    -  .. row 1
32
33       -  int fd
34
35       -  File descriptor returned by a previous call to open().
36
37    -  .. row 2
38
39       -  int request
40
41       -  Equals VIDEO_STOP for this command.
42
43    -  .. row 3
44
45       -  Boolean mode
46
47       -  Indicates how the screen shall be handled.
48
49    -  .. row 4
50
51       -
52       -  TRUE: Blank screen when stop.
53
54    -  .. row 5
55
56       -
57       -  FALSE: Show last decoded frame.
58
59Description
60-----------
61
62This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
63V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
64
65This ioctl call asks the Video Device to stop playing the current
66stream. Depending on the input parameter, the screen can be blanked out
67or displaying the last decoded frame.
68
69Return Value
70------------
71
72On success 0 is returned, on error -1 and the ``errno`` variable is set
73appropriately. The generic error codes are described at the
74:ref:`Generic Error Codes <gen-errors>` chapter.
75