Merge remote-tracking branch 'mmc-uh/next'
[deliverable/linux.git] / Documentation / media / uapi / dvb / video-freeze.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_FREEZE:
4
586027ce 5============
47d23e36
MCC
6VIDEO_FREEZE
7============
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12VIDEO_FREEZE
47d23e36 13
cf8076c3 14.. attention:: This ioctl is deprecated.
15e7d615
MCC
15
16Synopsis
47d23e36
MCC
17--------
18
cf8076c3
MCC
19.. c:function:: int ioctl(fd, VIDEO_FREEZE)
20 :name: VIDEO_FREEZE
47d23e36 21
47d23e36 22
15e7d615 23Arguments
586027ce 24---------
47d23e36
MCC
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
15e7d615 44Description
586027ce
MCC
45-----------
46
47This ioctl is for DVB 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 DVB subsystem will not decode any more data
55until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
56
57
15e7d615 58Return Value
47d23e36
MCC
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.
This page took 0.045686 seconds and 5 git commands to generate.