0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: DTV.video
0003
0004 .. _VIDEO_FREEZE:
0005
0006 ============
0007 VIDEO_FREEZE
0008 ============
0009
0010 Name
0011 ----
0012
0013 VIDEO_FREEZE
0014
0015 .. attention:: This ioctl is deprecated.
0016
0017 Synopsis
0018 --------
0019
0020 .. c:macro:: VIDEO_FREEZE
0021
0022 ``int ioctl(fd, VIDEO_FREEZE)``
0023
0024 Arguments
0025 ---------
0026
0027 .. flat-table::
0028 :header-rows: 0
0029 :stub-columns: 0
0030
0031 - .. row 1
0032
0033 - int fd
0034
0035 - File descriptor returned by a previous call to open().
0036
0037 - .. row 2
0038
0039 - int request
0040
0041 - Equals VIDEO_FREEZE for this command.
0042
0043 Description
0044 -----------
0045
0046 This ioctl is for Digital TV devices only. To control a V4L2 decoder use the
0047 V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
0048
0049 This ioctl call suspends the live video stream being played. Decoding
0050 and playing are frozen. It is then possible to restart the decoding and
0051 playing process of the video stream using the VIDEO_CONTINUE command.
0052 If VIDEO_SOURCE_MEMORY is selected in the ioctl call
0053 VIDEO_SELECT_SOURCE, the Digital TV subsystem will not decode any more data
0054 until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
0055
0056 Return Value
0057 ------------
0058
0059 On success 0 is returned, on error -1 and the ``errno`` variable is set
0060 appropriately. The generic error codes are described at the
0061 :ref:`Generic Error Codes <gen-errors>` chapter.
