tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1.. Permission is granted to copy, distribute and/or modify this
2.. document under the terms of the GNU Free Documentation License,
3.. Version 1.1 or any later version published by the Free Software
4.. Foundation, with no Invariant Sections, no Front-Cover Texts
5.. and no Back-Cover Texts. A copy of the license is included at
6.. Documentation/media/uapi/fdl-appendix.rst.
7..
8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10.. _VIDEO_FREEZE:
11
12============
13VIDEO_FREEZE
14============
15
16Name
17----
18
19VIDEO_FREEZE
20
21.. attention:: This ioctl is deprecated.
22
23Synopsis
24--------
25
26.. c:function:: int ioctl(fd, VIDEO_FREEZE)
27 :name: VIDEO_FREEZE
28
29
30Arguments
31---------
32
33.. flat-table::
34 :header-rows: 0
35 :stub-columns: 0
36
37
38 - .. row 1
39
40 - int fd
41
42 - File descriptor returned by a previous call to open().
43
44 - .. row 2
45
46 - int request
47
48 - Equals VIDEO_FREEZE for this command.
49
50
51Description
52-----------
53
54This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
55V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
56
57This ioctl call suspends the live video stream being played. Decoding
58and playing are frozen. It is then possible to restart the decoding and
59playing process of the video stream using the VIDEO_CONTINUE command.
60If VIDEO_SOURCE_MEMORY is selected in the ioctl call
61VIDEO_SELECT_SOURCE, the Digital TV subsystem will not decode any more data
62until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
63
64
65Return Value
66------------
67
68On success 0 is returned, on error -1 and the ``errno`` variable is set
69appropriately. The generic error codes are described at the
70:ref:`Generic Error Codes <gen-errors>` chapter.