blob: d00d0b5272d7e51412e08e2675cb49214cd0b444 [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 Chehab586027c2016-07-05 07:58:48 -03009NAME
10----
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 Chehab586027c2016-07-05 07:58:48 -030014SYNOPSIS
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030015--------
16
17.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU , video_spu_t *spu)
18
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030019
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030020ARGUMENTS
21---------
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030022
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_SPU for this command.
39
40 - .. row 3
41
42 - video_spu_t \*spu
43
44 - SPU decoding (de)activation and subid setting according to section
45 ??.
46
47
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030048DESCRIPTION
49-----------
50
51This ioctl activates or deactivates SPU decoding in a DVD input stream.
52It can only be used, if the driver is able to handle a DVD stream.
53
54
55RETURN VALUE
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030056------------
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.
61
62
63
64.. flat-table::
65 :header-rows: 0
66 :stub-columns: 0
67
68
69 - .. row 1
70
71 - ``EINVAL``
72
73 - input is not a valid spu setting or driver cannot handle SPU.