Merge remote-tracking branch 'md/for-next'
[deliverable/linux.git] / Documentation / media / uapi / dvb / video-set-spu.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_SET_SPU:
4
586027ce 5=============
47d23e36
MCC
6VIDEO_SET_SPU
7=============
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12VIDEO_SET_SPU
47d23e36 13
cf8076c3 14.. attention:: This ioctl is deprecated.
15e7d615
MCC
15
16Synopsis
47d23e36
MCC
17--------
18
848d1031 19.. c:function:: int ioctl(fd, VIDEO_SET_SPU , struct video_spu *spu)
cf8076c3 20 :name: VIDEO_SET_SPU
47d23e36 21
47d23e36 22
15e7d615 23Arguments
586027ce 24---------
47d23e36
MCC
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_SPU for this command.
42
43 - .. row 3
44
45 - video_spu_t \*spu
46
47 - SPU decoding (de)activation and subid setting according to section
48 ??.
49
50
15e7d615 51Description
586027ce
MCC
52-----------
53
54This ioctl activates or deactivates SPU decoding in a DVD input stream.
55It can only be used, if the driver is able to handle a DVD stream.
56
848d1031
MCC
57.. c:type:: struct video_spu
58
59.. code-block:: c
60
61 typedef struct video_spu {
62 int active;
63 int stream_id;
64 } video_spu_t;
65
586027ce 66
15e7d615 67Return Value
47d23e36
MCC
68------------
69
70On success 0 is returned, on error -1 and the ``errno`` variable is set
71appropriately. The generic error codes are described at the
72:ref:`Generic Error Codes <gen-errors>` chapter.
73
74
75
76.. flat-table::
77 :header-rows: 0
78 :stub-columns: 0
79
80
81 - .. row 1
82
83 - ``EINVAL``
84
85 - input is not a valid spu setting or driver cannot handle SPU.
This page took 0.047508 seconds and 5 git commands to generate.