doc-rst: linux_tv: don't use uppercases for syscall sections
[deliverable/linux.git] / Documentation / linux_tv / media / 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
15e7d615
MCC
14
15Synopsis
47d23e36
MCC
16--------
17
18.. c:function:: int ioctl(fd, int request = VIDEO_STOP, boolean mode)
19
47d23e36 20
15e7d615 21Arguments
586027ce 22---------
47d23e36
MCC
23
24.. flat-table::
25 :header-rows: 0
26 :stub-columns: 0
27
28
29 - .. row 1
30
31 - int fd
32
33 - File descriptor returned by a previous call to open().
34
35 - .. row 2
36
37 - int request
38
39 - Equals VIDEO_STOP for this command.
40
41 - .. row 3
42
43 - Boolean mode
44
45 - Indicates how the screen shall be handled.
46
47 - .. row 4
48
49 -
50 - TRUE: Blank screen when stop.
51
52 - .. row 5
53
54 -
55 - FALSE: Show last decoded frame.
56
57
15e7d615 58Description
586027ce
MCC
59-----------
60
61This ioctl is for DVB devices only. To control a V4L2 decoder use the
62V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
63
64This ioctl call asks the Video Device to stop playing the current
65stream. Depending on the input parameter, the screen can be blanked out
66or displaying the last decoded frame.
67
68
15e7d615 69Return Value
47d23e36
MCC
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.
This page took 0.027317 seconds and 5 git commands to generate.