Documentation/media/uapi/dvb/video-get-status.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_GET_STATUS:
   4
   5 ================
   6 VIDEO_GET_STATUS
   7 ================
   8
   9 Name
  10 ----
  11
  12 VIDEO_GET_STATUS
  13
  14 .. attention:: This ioctl is deprecated.
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(fd, VIDEO_GET_STATUS, struct video_status *status)
  20     :name: VIDEO_GET_STATUS
  21
  22
  23 Arguments
  24 ---------
  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
  50 Description
  51 -----------
  52
  53 This ioctl call asks the Video Device to return the current status of
  54 the device.
  55
  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         };
  67
  68 Return Value
  69 ------------
  70
  71 On success 0 is returned, on error -1 and the ``errno`` variable is set
  72 appropriately. The generic error codes are described at the
  73 :ref:`Generic Error Codes <gen-errors>` chapter.