Merge remote-tracking branch 'mmc-uh/next'
[deliverable/linux.git] / Documentation / media / uapi / dvb / video-get-status.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_GET_STATUS:
4
586027ce 5================
47d23e36
MCC
6VIDEO_GET_STATUS
7================
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12VIDEO_GET_STATUS
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_GET_STATUS, struct video_status *status)
20 :name: VIDEO_GET_STATUS
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_GET_STATUS for this command.
42
43 - .. row 3
44
45 - struct video_status \*status
46
47 - Returns the current status of the Video Device.
48
49
15e7d615 50Description
586027ce
MCC
51-----------
52
53This ioctl call asks the Video Device to return the current status of
54the device.
55
848d1031
MCC
56.. c:type:: video_status
57
58.. code-block:: c
59
60 struct video_status {
61 int video_blank; /* blank video on freeze? */
62 video_play_state_t play_state; /* current state of playback */
63 video_stream_source_t stream_source; /* current source (demux/memory) */
64 video_format_t video_format; /* current aspect ratio of stream*/
65 video_displayformat_t display_format;/* selected cropping mode */
66 };
586027ce 67
15e7d615 68Return Value
47d23e36
MCC
69------------
70
71On success 0 is returned, on error -1 and the ``errno`` variable is set
72appropriately. The generic error codes are described at the
73:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.053994 seconds and 5 git commands to generate.