Documentation/media/uapi/dvb/audio-set-karaoke.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _AUDIO_SET_KARAOKE:
   4
   5 =================
   6 AUDIO_SET_KARAOKE
   7 =================
   8
   9 Name
  10 ----
  11
  12 AUDIO_SET_KARAOKE
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke)
  19
  20
  21 Arguments
  22 ---------
  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
  48 Description
  49 -----------
  50
  51 This ioctl allows one to set the mixer settings for a karaoke DVD.
  52
  53
  54 Return Value
  55 ------------
  56
  57 On success 0 is returned, on error -1 and the ``errno`` variable is set
  58 appropriately. The generic error codes are described at the
  59 :ref:`Generic Error Codes <gen-errors>` chapter.
  60
  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.