doc-rst: linux_tv: split DVB function call documentation
[deliverable/linux.git] / Documentation / linux_tv / media / dvb / video-set-attributes.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_SET_ATTRIBUTES:
4
5VIDEO_SET_ATTRIBUTES
6====================
7
8Description
9-----------
10
11This ioctl is intended for DVD playback and allows you to set certain
12information about the stream. Some hardware may not need this
13information, but the call also tells the hardware to prepare for DVD
14playback.
15
16Synopsis
17--------
18
19.. c:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
20
21Arguments
22----------
23
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_SET_ATTRIBUTE for this command.
42
43 - .. row 3
44
45 - video_attributes_t vattr
46
47 - video attributes according to section ??.
48
49
50Return Value
51------------
52
53On success 0 is returned, on error -1 and the ``errno`` variable is set
54appropriately. The generic error codes are described at the
55:ref:`Generic Error Codes <gen-errors>` chapter.
56
57
58
59.. flat-table::
60 :header-rows: 0
61 :stub-columns: 0
62
63
64 - .. row 1
65
66 - ``EINVAL``
67
68 - input is not a valid attribute setting.
This page took 0.026119 seconds and 5 git commands to generate.