• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_FREEZE:
4
5============
6VIDEO_FREEZE
7============
8
9Name
10----
11
12VIDEO_FREEZE
13
14.. attention:: This ioctl is deprecated.
15
16Synopsis
17--------
18
19.. c:function:: int ioctl(fd, VIDEO_FREEZE)
20    :name: VIDEO_FREEZE
21
22
23Arguments
24---------
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_FREEZE for this command.
42
43
44Description
45-----------
46
47This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
48V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
49
50This ioctl call suspends the live video stream being played. Decoding
51and playing are frozen. It is then possible to restart the decoding and
52playing process of the video stream using the VIDEO_CONTINUE command.
53If VIDEO_SOURCE_MEMORY is selected in the ioctl call
54VIDEO_SELECT_SOURCE, the Digital TV subsystem will not decode any more data
55until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
56
57
58Return Value
59------------
60
61On success 0 is returned, on error -1 and the ``errno`` variable is set
62appropriately. The generic error codes are described at the
63:ref:`Generic Error Codes <gen-errors>` chapter.
64