Documentation/userspace-api/media/dvb/video-get-size.rst

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