xref: /OK3568_Linux_fs/kernel/Documentation/userspace-api/media/dvb/video-get-status.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2*4882a593Smuzhiyun.. c:namespace:: DTV.video
3*4882a593Smuzhiyun
4*4882a593Smuzhiyun.. _VIDEO_GET_STATUS:
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun================
7*4882a593SmuzhiyunVIDEO_GET_STATUS
8*4882a593Smuzhiyun================
9*4882a593Smuzhiyun
10*4882a593SmuzhiyunName
11*4882a593Smuzhiyun----
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunVIDEO_GET_STATUS
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun.. attention:: This ioctl is deprecated.
16*4882a593Smuzhiyun
17*4882a593SmuzhiyunSynopsis
18*4882a593Smuzhiyun--------
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun.. c:macro:: VIDEO_GET_STATUS
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun``int ioctl(fd, VIDEO_GET_STATUS, struct video_status *status)``
23*4882a593Smuzhiyun
24*4882a593SmuzhiyunArguments
25*4882a593Smuzhiyun---------
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun.. flat-table::
28*4882a593Smuzhiyun    :header-rows:  0
29*4882a593Smuzhiyun    :stub-columns: 0
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun    -  .. row 1
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun       -  int fd
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun       -  File descriptor returned by a previous call to open().
36*4882a593Smuzhiyun
37*4882a593Smuzhiyun    -  .. row 2
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun       -  int request
40*4882a593Smuzhiyun
41*4882a593Smuzhiyun       -  Equals VIDEO_GET_STATUS for this command.
42*4882a593Smuzhiyun
43*4882a593Smuzhiyun    -  .. row 3
44*4882a593Smuzhiyun
45*4882a593Smuzhiyun       -  struct video_status \*status
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun       -  Returns the current status of the Video Device.
48*4882a593Smuzhiyun
49*4882a593SmuzhiyunDescription
50*4882a593Smuzhiyun-----------
51*4882a593Smuzhiyun
52*4882a593SmuzhiyunThis ioctl call asks the Video Device to return the current status of
53*4882a593Smuzhiyunthe device.
54*4882a593Smuzhiyun
55*4882a593Smuzhiyun.. c:type:: video_status
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun.. code-block:: c
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun	struct video_status {
60*4882a593Smuzhiyun		int                   video_blank;   /* blank video on freeze? */
61*4882a593Smuzhiyun		video_play_state_t    play_state;    /* current state of playback */
62*4882a593Smuzhiyun		video_stream_source_t stream_source; /* current source (demux/memory) */
63*4882a593Smuzhiyun		video_format_t        video_format;  /* current aspect ratio of stream*/
64*4882a593Smuzhiyun		video_displayformat_t display_format;/* selected cropping mode */
65*4882a593Smuzhiyun	};
66*4882a593Smuzhiyun
67*4882a593SmuzhiyunReturn Value
68*4882a593Smuzhiyun------------
69*4882a593Smuzhiyun
70*4882a593SmuzhiyunOn success 0 is returned, on error -1 and the ``errno`` variable is set
71*4882a593Smuzhiyunappropriately. The generic error codes are described at the
72*4882a593Smuzhiyun:ref:`Generic Error Codes <gen-errors>` chapter.
73