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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _VIDEO_GET_SIZE:
   4
   5 ==============
   6 VIDEO_GET_SIZE
   7 ==============
   8
   9 Name
  10 ----
  11
  12 VIDEO_GET_SIZE
  13
  14 .. attention:: This ioctl is deprecated.
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(int fd, VIDEO_GET_SIZE, video_size_t *size)
  20     :name: VIDEO_GET_SIZE
  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_SIZE for this command.
  42
  43     -  .. row 3
  44
  45        -  video_size_t \*size
  46
  47        -  Returns the size and aspect ratio.
  48
  49
  50 Description
  51 -----------
  52
  53 This ioctl returns the size and aspect ratio.
  54
  55 .. c:type:: video_size_t
  56
  57 .. code-block::c
  58
  59         typedef struct {
  60                 int w;
  61                 int h;
  62                 video_format_t aspect_ratio;
  63         } video_size_t;
  64
  65
  66 Return Value
  67 ------------
  68
  69 On success 0 is returned, on error -1 and the ``errno`` variable is set
  70 appropriately. The generic error codes are described at the
  71 :ref:`Generic Error Codes <gen-errors>` chapter.