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 .. attention:: This ioctl is deprecated
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int ioctl(fd, AUDIO_SET_KARAOKE, struct audio_karaoke *karaoke)
  20     :name: AUDIO_SET_KARAOKE
  21
  22
  23 Arguments
  24 ---------
  25
  26 .. flat-table::
  27     :header-rows:  0
  28     :stub-columns: 0
  29
  30
  31     -
  32
  33        -  int fd
  34
  35        -  File descriptor returned by a previous call to open().
  36
  37     -
  38
  39        -  audio_karaoke_t \*karaoke
  40
  41        -  karaoke settings according to section ??.
  42
  43
  44 Description
  45 -----------
  46
  47 This ioctl allows one to set the mixer settings for a karaoke DVD.
  48
  49
  50 Return Value
  51 ------------
  52
  53 On success 0 is returned, on error -1 and the ``errno`` variable is set
  54 appropriately. The generic error codes are described at the
  55 :ref:`Generic Error Codes <gen-errors>` chapter.
  56
  57 .. flat-table::
  58     :header-rows:  0
  59     :stub-columns: 0
  60
  61
  62     -  .. row 1
  63
  64        -  ``EINVAL``
  65
  66        -  karaoke is not a valid or supported karaoke setting.