video-freeze.rst (1320B)
1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later 2.. c:namespace:: DTV.video 3 4.. _VIDEO_FREEZE: 5 6============ 7VIDEO_FREEZE 8============ 9 10Name 11---- 12 13VIDEO_FREEZE 14 15.. attention:: This ioctl is deprecated. 16 17Synopsis 18-------- 19 20.. c:macro:: VIDEO_FREEZE 21 22``int ioctl(fd, VIDEO_FREEZE)`` 23 24Arguments 25--------- 26 27.. flat-table:: 28 :header-rows: 0 29 :stub-columns: 0 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 43Description 44----------- 45 46This ioctl is for Digital TV devices only. To control a V4L2 decoder use the 47V4L2 :ref:`VIDIOC_DECODER_CMD` instead. 48 49This ioctl call suspends the live video stream being played. Decoding 50and playing are frozen. It is then possible to restart the decoding and 51playing process of the video stream using the VIDEO_CONTINUE command. 52If VIDEO_SOURCE_MEMORY is selected in the ioctl call 53VIDEO_SELECT_SOURCE, the Digital TV subsystem will not decode any more data 54until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed. 55 56Return Value 57------------ 58 59On success 0 is returned, on error -1 and the ``errno`` variable is set 60appropriately. The generic error codes are described at the 61:ref:`Generic Error Codes <gen-errors>` chapter.