Merge remote-tracking branch 'lightnvm/for-next'
[deliverable/linux.git] / Documentation / media / uapi / dvb / video-stop.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_STOP:
4
586027ce 5==========
47d23e36
MCC
6VIDEO_STOP
7==========
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12VIDEO_STOP
47d23e36 13
cf8076c3 14.. attention:: This ioctl is deprecated.
15e7d615
MCC
15
16Synopsis
47d23e36
MCC
17--------
18
cf8076c3
MCC
19.. c:function:: int ioctl(fd, VIDEO_STOP, boolean mode)
20 :name: VIDEO_STOP
47d23e36 21
47d23e36 22
15e7d615 23Arguments
586027ce 24---------
47d23e36
MCC
25
26.. flat-table::
27 :header-rows: 0
28 :stub-columns: 0
29
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
59
15e7d615 60Description
586027ce
MCC
61-----------
62
63This ioctl is for DVB devices only. To control a V4L2 decoder use the
64V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
65
66This ioctl call asks the Video Device to stop playing the current
67stream. Depending on the input parameter, the screen can be blanked out
68or displaying the last decoded frame.
69
70
15e7d615 71Return Value
47d23e36
MCC
72------------
73
74On success 0 is returned, on error -1 and the ``errno`` variable is set
75appropriately. The generic error codes are described at the
76:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.05814 seconds and 5 git commands to generate.