tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1.. Permission is granted to copy, distribute and/or modify this
2.. document under the terms of the GNU Free Documentation License,
3.. Version 1.1 or any later version published by the Free Software
4.. Foundation, with no Invariant Sections, no Front-Cover Texts
5.. and no Back-Cover Texts. A copy of the license is included at
6.. Documentation/media/uapi/fdl-appendix.rst.
7..
8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10.. _VIDEO_GET_STATUS:
11
12================
13VIDEO_GET_STATUS
14================
15
16Name
17----
18
19VIDEO_GET_STATUS
20
21.. attention:: This ioctl is deprecated.
22
23Synopsis
24--------
25
26.. c:function:: int ioctl(fd, VIDEO_GET_STATUS, struct video_status *status)
27 :name: VIDEO_GET_STATUS
28
29
30Arguments
31---------
32
33.. flat-table::
34 :header-rows: 0
35 :stub-columns: 0
36
37
38 - .. row 1
39
40 - int fd
41
42 - File descriptor returned by a previous call to open().
43
44 - .. row 2
45
46 - int request
47
48 - Equals VIDEO_GET_STATUS for this command.
49
50 - .. row 3
51
52 - struct video_status \*status
53
54 - Returns the current status of the Video Device.
55
56
57Description
58-----------
59
60This ioctl call asks the Video Device to return the current status of
61the device.
62
63.. c:type:: video_status
64
65.. code-block:: c
66
67 struct video_status {
68 int video_blank; /* blank video on freeze? */
69 video_play_state_t play_state; /* current state of playback */
70 video_stream_source_t stream_source; /* current source (demux/memory) */
71 video_format_t video_format; /* current aspect ratio of stream*/
72 video_displayformat_t display_format;/* selected cropping mode */
73 };
74
75Return Value
76------------
77
78On success 0 is returned, on error -1 and the ``errno`` variable is set
79appropriately. The generic error codes are described at the
80:ref:`Generic Error Codes <gen-errors>` chapter.