1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2.. c:namespace:: DTV.video
3
4.. _VIDEO_GET_STATUS:
5
6================
7VIDEO_GET_STATUS
8================
9
10Name
11----
12
13VIDEO_GET_STATUS
14
15.. attention:: This ioctl is deprecated.
16
17Synopsis
18--------
19
20.. c:macro:: VIDEO_GET_STATUS
21
22``int ioctl(fd, VIDEO_GET_STATUS, struct video_status *status)``
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_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
49Description
50-----------
51
52This ioctl call asks the Video Device to return the current status of
53the device.
54
55.. c:type:: video_status
56
57.. code-block:: c
58
59	struct video_status {
60		int                   video_blank;   /* blank video on freeze? */
61		video_play_state_t    play_state;    /* current state of playback */
62		video_stream_source_t stream_source; /* current source (demux/memory) */
63		video_format_t        video_format;  /* current aspect ratio of stream*/
64		video_displayformat_t display_format;/* selected cropping mode */
65	};
66
67Return Value
68------------
69
70On success 0 is returned, on error -1 and the ``errno`` variable is set
71appropriately. The generic error codes are described at the
72:ref:`Generic Error Codes <gen-errors>` chapter.
73