0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: DTV.video
0003
0004 .. _VIDEO_GET_STATUS:
0005
0006 ================
0007 VIDEO_GET_STATUS
0008 ================
0009
0010 Name
0011 ----
0012
0013 VIDEO_GET_STATUS
0014
0015 .. attention:: This ioctl is deprecated.
0016
0017 Synopsis
0018 --------
0019
0020 .. c:macro:: VIDEO_GET_STATUS
0021
0022 ``int ioctl(fd, VIDEO_GET_STATUS, struct video_status *status)``
0023
0024 Arguments
0025 ---------
0026
0027 .. flat-table::
0028 :header-rows: 0
0029 :stub-columns: 0
0030
0031 - .. row 1
0032
0033 - int fd
0034
0035 - File descriptor returned by a previous call to open().
0036
0037 - .. row 2
0038
0039 - int request
0040
0041 - Equals VIDEO_GET_STATUS for this command.
0042
0043 - .. row 3
0044
0045 - struct video_status \*status
0046
0047 - Returns the current status of the Video Device.
0048
0049 Description
0050 -----------
0051
0052 This ioctl call asks the Video Device to return the current status of
0053 the device.
0054
0055 .. c:type:: video_status
0056
0057 .. code-block:: c
0058
0059 struct video_status {
0060 int video_blank; /* blank video on freeze? */
0061 video_play_state_t play_state; /* current state of playback */
0062 video_stream_source_t stream_source; /* current source (demux/memory) */
0063 video_format_t video_format; /* current aspect ratio of stream*/
0064 video_displayformat_t display_format;/* selected cropping mode */
0065 };
0066
0067 Return Value
0068 ------------
0069
0070 On success 0 is returned, on error -1 and the ``errno`` variable is set
0071 appropriately. The generic error codes are described at the
0072 :ref:`Generic Error Codes <gen-errors>` chapter.
