diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-05 16:37:31 +0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-05 16:44:33 +0300 |
commit | 47d23e363fb034f32551f5fe85add77ceba98d3b (patch) | |
tree | eb08c3072ab062322bf193a83ebd6d58cb5a9c0a /Documentation/linux_tv/media/dvb/video-set-spu.rst | |
parent | bb2ade02e8507f6f9a723ec7816918cf7c4fe74d (diff) | |
download | linux-47d23e363fb034f32551f5fe85add77ceba98d3b.tar.xz |
doc-rst: linux_tv: split DVB function call documentation
Just like V4L, split the DVB function calls into one file per
system call. This is a requirement for the man pages creator
on Sphinx to work, and makes the document easier to maintain.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/linux_tv/media/dvb/video-set-spu.rst')
-rw-r--r-- | Documentation/linux_tv/media/dvb/video-set-spu.rst | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/Documentation/linux_tv/media/dvb/video-set-spu.rst b/Documentation/linux_tv/media/dvb/video-set-spu.rst new file mode 100644 index 000000000000..863c6248fab9 --- /dev/null +++ b/Documentation/linux_tv/media/dvb/video-set-spu.rst @@ -0,0 +1,70 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _VIDEO_SET_SPU: + +VIDEO_SET_SPU +============= + +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. + +Synopsis +-------- + +.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU , video_spu_t *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 + ??. + + +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. + + + |