cf8076c314
Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. While here, improve the documentation, marking the deprecated ioctls, and making the non-deprecated ones more like the rest of the media book. Also, add a notice for ioctls that still require documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
77 lines
1.2 KiB
ReStructuredText
77 lines
1.2 KiB
ReStructuredText
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
.. _VIDEO_SET_SPU:
|
|
|
|
=============
|
|
VIDEO_SET_SPU
|
|
=============
|
|
|
|
Name
|
|
----
|
|
|
|
VIDEO_SET_SPU
|
|
|
|
.. attention:: This ioctl is deprecated.
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. c:function:: int ioctl(fd, VIDEO_SET_SPU , video_spu_t *spu)
|
|
:name: VIDEO_SET_SPU
|
|
|
|
|
|
Arguments
|
|
---------
|
|
|
|
.. flat-table::
|
|
:header-rows: 0
|
|
:stub-columns: 0
|
|
|
|
|
|
- .. row 1
|
|
|
|
- int fd
|
|
|
|
- File descriptor returned by a previous call to open().
|
|
|
|
- .. row 2
|
|
|
|
- int request
|
|
|
|
- Equals VIDEO_SET_SPU for this command.
|
|
|
|
- .. row 3
|
|
|
|
- video_spu_t \*spu
|
|
|
|
- SPU decoding (de)activation and subid setting according to section
|
|
??.
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
This ioctl activates or deactivates SPU decoding in a DVD input stream.
|
|
It can only be used, if the driver is able to handle a DVD stream.
|
|
|
|
|
|
Return Value
|
|
------------
|
|
|
|
On success 0 is returned, on error -1 and the ``errno`` variable is set
|
|
appropriately. The generic error codes are described at the
|
|
:ref:`Generic Error Codes <gen-errors>` chapter.
|
|
|
|
|
|
|
|
.. flat-table::
|
|
:header-rows: 0
|
|
:stub-columns: 0
|
|
|
|
|
|
- .. row 1
|
|
|
|
- ``EINVAL``
|
|
|
|
- input is not a valid spu setting or driver cannot handle SPU.
|