[media] docs-next: stop abusing on the cpp domain
[deliverable/linux.git] / Documentation / media / uapi / dvb / video-set-highlight.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_SET_HIGHLIGHT:
4
586027ce 5===================
47d23e36
MCC
6VIDEO_SET_HIGHLIGHT
7===================
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12VIDEO_SET_HIGHLIGHT
47d23e36 13
15e7d615
MCC
14
15Synopsis
47d23e36
MCC
16--------
17
1b81f010 18.. c:function:: int ioctl(fd, int request = VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite)
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_HIGHLIGHT for this command.
40
41 - .. row 3
42
43 - video_highlight_t \*vhilite
44
45 - SPU Highlight information according to section ??.
46
47
15e7d615 48Description
586027ce
MCC
49-----------
50
51This ioctl sets the SPU highlight information for the menu access of a
52DVD.
53
54
15e7d615 55Return Value
47d23e36
MCC
56------------
57
58On success 0 is returned, on error -1 and the ``errno`` variable is set
59appropriately. The generic error codes are described at the
60:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.044472 seconds and 5 git commands to generate.