18c2ecf20Sopenharmony_ci.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
28c2ecf20Sopenharmony_ci.. c:namespace:: DTV.video
38c2ecf20Sopenharmony_ci
48c2ecf20Sopenharmony_ci.. _VIDEO_FREEZE:
58c2ecf20Sopenharmony_ci
68c2ecf20Sopenharmony_ci============
78c2ecf20Sopenharmony_ciVIDEO_FREEZE
88c2ecf20Sopenharmony_ci============
98c2ecf20Sopenharmony_ci
108c2ecf20Sopenharmony_ciName
118c2ecf20Sopenharmony_ci----
128c2ecf20Sopenharmony_ci
138c2ecf20Sopenharmony_ciVIDEO_FREEZE
148c2ecf20Sopenharmony_ci
158c2ecf20Sopenharmony_ci.. attention:: This ioctl is deprecated.
168c2ecf20Sopenharmony_ci
178c2ecf20Sopenharmony_ciSynopsis
188c2ecf20Sopenharmony_ci--------
198c2ecf20Sopenharmony_ci
208c2ecf20Sopenharmony_ci.. c:macro:: VIDEO_FREEZE
218c2ecf20Sopenharmony_ci
228c2ecf20Sopenharmony_ci``int ioctl(fd, VIDEO_FREEZE)``
238c2ecf20Sopenharmony_ci
248c2ecf20Sopenharmony_ciArguments
258c2ecf20Sopenharmony_ci---------
268c2ecf20Sopenharmony_ci
278c2ecf20Sopenharmony_ci.. flat-table::
288c2ecf20Sopenharmony_ci    :header-rows:  0
298c2ecf20Sopenharmony_ci    :stub-columns: 0
308c2ecf20Sopenharmony_ci
318c2ecf20Sopenharmony_ci    -  .. row 1
328c2ecf20Sopenharmony_ci
338c2ecf20Sopenharmony_ci       -  int fd
348c2ecf20Sopenharmony_ci
358c2ecf20Sopenharmony_ci       -  File descriptor returned by a previous call to open().
368c2ecf20Sopenharmony_ci
378c2ecf20Sopenharmony_ci    -  .. row 2
388c2ecf20Sopenharmony_ci
398c2ecf20Sopenharmony_ci       -  int request
408c2ecf20Sopenharmony_ci
418c2ecf20Sopenharmony_ci       -  Equals VIDEO_FREEZE for this command.
428c2ecf20Sopenharmony_ci
438c2ecf20Sopenharmony_ciDescription
448c2ecf20Sopenharmony_ci-----------
458c2ecf20Sopenharmony_ci
468c2ecf20Sopenharmony_ciThis ioctl is for Digital TV devices only. To control a V4L2 decoder use the
478c2ecf20Sopenharmony_ciV4L2 :ref:`VIDIOC_DECODER_CMD` instead.
488c2ecf20Sopenharmony_ci
498c2ecf20Sopenharmony_ciThis ioctl call suspends the live video stream being played. Decoding
508c2ecf20Sopenharmony_ciand playing are frozen. It is then possible to restart the decoding and
518c2ecf20Sopenharmony_ciplaying process of the video stream using the VIDEO_CONTINUE command.
528c2ecf20Sopenharmony_ciIf VIDEO_SOURCE_MEMORY is selected in the ioctl call
538c2ecf20Sopenharmony_ciVIDEO_SELECT_SOURCE, the Digital TV subsystem will not decode any more data
548c2ecf20Sopenharmony_ciuntil the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
558c2ecf20Sopenharmony_ci
568c2ecf20Sopenharmony_ciReturn Value
578c2ecf20Sopenharmony_ci------------
588c2ecf20Sopenharmony_ci
598c2ecf20Sopenharmony_ciOn success 0 is returned, on error -1 and the ``errno`` variable is set
608c2ecf20Sopenharmony_ciappropriately. The generic error codes are described at the
618c2ecf20Sopenharmony_ci:ref:`Generic Error Codes <gen-errors>` chapter.
62