Merge git://www.linux-watchdog.org/linux-watchdog
[deliverable/linux.git] / Documentation / media / uapi / dvb / audio-set-karaoke.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _AUDIO_SET_KARAOKE:
4
586027ce 5=================
47d23e36
MCC
6AUDIO_SET_KARAOKE
7=================
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12AUDIO_SET_KARAOKE
47d23e36 13
15e7d615
MCC
14
15Synopsis
47d23e36
MCC
16--------
17
5929cb17 18.. cpp:function:: int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke)
47d23e36 19
47d23e36 20
15e7d615 21Arguments
586027ce 22---------
47d23e36
MCC
23
24.. flat-table::
25 :header-rows: 0
26 :stub-columns: 0
27
28
29 - .. row 1
30
31 - int fd
32
33 - File descriptor returned by a previous call to open().
34
35 - .. row 2
36
37 - int request
38
39 - Equals AUDIO_SET_KARAOKE for this command.
40
41 - .. row 3
42
43 - audio_karaoke_t \*karaoke
44
45 - karaoke settings according to section ??.
46
47
15e7d615 48Description
586027ce
MCC
49-----------
50
51This ioctl allows one to set the mixer settings for a karaoke DVD.
52
53
15e7d615 54Return Value
47d23e36
MCC
55------------
56
57On success 0 is returned, on error -1 and the ``errno`` variable is set
58appropriately. The generic error codes are described at the
59:ref:`Generic Error Codes <gen-errors>` chapter.
60
47d23e36
MCC
61.. flat-table::
62 :header-rows: 0
63 :stub-columns: 0
64
65
66 - .. row 1
67
68 - ``EINVAL``
69
70 - karaoke is not a valid or supported karaoke setting.
This page took 0.052148 seconds and 5 git commands to generate.