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