[media] docs-rst: Convert V4L2 uAPI to use C function references
[deliverable/linux.git] / Documentation / media / uapi / dvb / video-set-attributes.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_SET_ATTRIBUTES:
4
586027ce 5====================
47d23e36
MCC
6VIDEO_SET_ATTRIBUTES
7====================
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12VIDEO_SET_ATTRIBUTES
47d23e36 13
15e7d615
MCC
14
15Synopsis
47d23e36
MCC
16--------
17
1b81f010 18.. c:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
47d23e36 19
47d23e36 20
15e7d615 21Arguments
586027ce 22---------
47d23e36
MCC
23
24.. flat-table::
25 :header-rows: 0
26 :stub-columns: 0
27
28
29 - .. row 1
30
31 - int fd
32
33 - File descriptor returned by a previous call to open().
34
35 - .. row 2
36
37 - int request
38
39 - Equals VIDEO_SET_ATTRIBUTE for this command.
40
41 - .. row 3
42
43 - video_attributes_t vattr
44
45 - video attributes according to section ??.
46
47
15e7d615 48Description
586027ce
MCC
49-----------
50
51This ioctl is intended for DVD playback and allows you to set certain
52information about the stream. Some hardware may not need this
53information, but the call also tells the hardware to prepare for DVD
54playback.
55
56
15e7d615 57Return Value
47d23e36
MCC
58------------
59
60On success 0 is returned, on error -1 and the ``errno`` variable is set
61appropriately. The generic error codes are described at the
62:ref:`Generic Error Codes <gen-errors>` chapter.
63
64
65
66.. flat-table::
67 :header-rows: 0
68 :stub-columns: 0
69
70
71 - .. row 1
72
73 - ``EINVAL``
74
75 - input is not a valid attribute setting.
This page took 0.039915 seconds and 5 git commands to generate.