linux/Documentation/media/uapi/dvb/video-get-size.rst
Mauro Carvalho Chehab 848d10314b [media] fix broken references on dvb/video*rst
Trivially fix those broken references, by copying the structs
fron the header, just like other API documentation at the
DVB side.

This doesn't have the level of quality used at the V4L2 side
of the API, but, as this documents a deprecated API, used
only by av7110 driver, it doesn't make much sense to invest
time making it better.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-09 09:53:35 -03:00

72 lines
1.0 KiB
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _VIDEO_GET_SIZE:
==============
VIDEO_GET_SIZE
==============
Name
----
VIDEO_GET_SIZE
.. attention:: This ioctl is deprecated.
Synopsis
--------
.. c:function:: int ioctl(int fd, VIDEO_GET_SIZE, video_size_t *size)
:name: VIDEO_GET_SIZE
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals VIDEO_GET_SIZE for this command.
- .. row 3
- video_size_t \*size
- Returns the size and aspect ratio.
Description
-----------
This ioctl returns the size and aspect ratio.
.. c:type:: video_size_t
.. code-block::c
typedef struct {
int w;
int h;
video_format_t aspect_ratio;
} video_size_t;
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.