Documentation/media/uapi/dvb/audio-set-av-sync.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _AUDIO_SET_AV_SYNC:
   4
   5 =================
   6 AUDIO_SET_AV_SYNC
   7 =================
   8
   9 Name
  10 ----
  11
  12 AUDIO_SET_AV_SYNC
  13
  14
  15 Synopsis
  16 --------
  17
  18 .. cpp:function:: int  ioctl(int fd, int request = AUDIO_SET_AV_SYNC, boolean state)
  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_AV_SYNC for this command.
  40
  41     -  .. row 3
  42
  43        -  boolean state
  44
  45        -  Tells the DVB subsystem if A/V synchronization shall be ON or OFF.
  46
  47     -  .. row 4
  48
  49        -
  50        -  TRUE AV-sync ON
  51
  52     -  .. row 5
  53
  54        -
  55        -  FALSE AV-sync OFF
  56
  57
  58 Description
  59 -----------
  60
  61 This ioctl call asks the Audio Device to turn ON or OFF A/V
  62 synchronization.
  63
  64
  65 Return Value
  66 ------------
  67
  68 On success 0 is returned, on error -1 and the ``errno`` variable is set
  69 appropriately. The generic error codes are described at the
  70 :ref:`Generic Error Codes <gen-errors>` chapter.