doc-rst: customize RTD theme, captions & inline literal
[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
586027ce 5====================
47d23e36
MCC
6VIDEO_SET_ATTRIBUTES
7====================
8
586027ce
MCC
9NAME
10----
47d23e36 11
586027ce 12VIDEO_SET_ATTRIBUTES
47d23e36 13
586027ce 14SYNOPSIS
47d23e36
MCC
15--------
16
17.. c:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
18
47d23e36 19
586027ce
MCC
20ARGUMENTS
21---------
47d23e36
MCC
22
23.. flat-table::
24 :header-rows: 0
25 :stub-columns: 0
26
27
28 - .. row 1
29
30 - int fd
31
32 - File descriptor returned by a previous call to open().
33
34 - .. row 2
35
36 - int request
37
38 - Equals VIDEO_SET_ATTRIBUTE for this command.
39
40 - .. row 3
41
42 - video_attributes_t vattr
43
44 - video attributes according to section ??.
45
46
586027ce
MCC
47DESCRIPTION
48-----------
49
50This ioctl is intended for DVD playback and allows you to set certain
51information about the stream. Some hardware may not need this
52information, but the call also tells the hardware to prepare for DVD
53playback.
54
55
56RETURN VALUE
47d23e36
MCC
57------------
58
59On success 0 is returned, on error -1 and the ``errno`` variable is set
60appropriately. The generic error codes are described at the
61:ref:`Generic Error Codes <gen-errors>` chapter.
62
63
64
65.. flat-table::
66 :header-rows: 0
67 :stub-columns: 0
68
69
70 - .. row 1
71
72 - ``EINVAL``
73
74 - input is not a valid attribute setting.
This page took 0.026868 seconds and 5 git commands to generate.