blob: 2a7f0625de3806cef95ee13dfa9e833a2cb3a88e [file] [log] [blame]
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -03001.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_SET_SPU:
4
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -03005=============
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -03006VIDEO_SET_SPU
7=============
8
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -03009Name
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030010----
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030011
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030012VIDEO_SET_SPU
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030013
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -030014.. attention:: This ioctl is deprecated.
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030015
16Synopsis
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030017--------
18
Mauro Carvalho Chehabcf8076c2016-08-19 16:56:15 -030019.. c:function:: int ioctl(fd, VIDEO_SET_SPU , video_spu_t *spu)
20 :name: VIDEO_SET_SPU
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030021
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030022
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030023Arguments
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030024---------
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030025
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
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030051Description
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030052-----------
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
57
Mauro Carvalho Chehab15e7d612016-07-05 15:14:35 -030058Return Value
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030059------------
60
61On success 0 is returned, on error -1 and the ``errno`` variable is set
62appropriately. The generic error codes are described at the
63:ref:`Generic Error Codes <gen-errors>` chapter.
64
65
66
67.. flat-table::
68 :header-rows: 0
69 :stub-columns: 0
70
71
72 - .. row 1
73
74 - ``EINVAL``
75
76 - input is not a valid spu setting or driver cannot handle SPU.