linux/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
Mauro Carvalho Chehab 47d23e363f 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>
2016-07-05 10:44:33 -03:00

66 lines
1.0 KiB
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _AUDIO_SET_KARAOKE:
AUDIO_SET_KARAOKE
=================
Description
-----------
This ioctl allows one to set the mixer settings for a karaoke DVD.
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 ??.
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.