linux/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
Mauro Carvalho Chehab fc833980e3 doc-rst: linux_tv: dvb: put return value at the end
On some syscall descriptions, the tables are described after
the return value. Do that inside descriptions.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 11:36:55 -03:00

70 lines
1.1 KiB
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _AUDIO_SET_KARAOKE:
=================
AUDIO_SET_KARAOKE
=================
NAME
----
AUDIO_SET_KARAOKE
SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke)
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 AUDIO_SET_KARAOKE for this command.
- .. row 3
- audio_karaoke_t \*karaoke
- karaoke settings according to section ??.
DESCRIPTION
-----------
This ioctl allows one to set the mixer settings for a karaoke DVD.
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``
- karaoke is not a valid or supported karaoke setting.