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 .. attention:: This ioctl is deprecated
  15
  16 Synopsis
  17 --------
  18
  19 .. c:function:: int  ioctl(int fd, AUDIO_SET_AV_SYNC, boolean state)
  20     :name: AUDIO_SET_AV_SYNC
  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        -  boolean state
  40
  41        -  Tells the DVB subsystem if A/V synchronization shall be ON or OFF.
  42
  43           TRUE: AV-sync ON
  44
  45           FALSE: AV-sync OFF
  46
  47
  48 Description
  49 -----------
  50
  51 This ioctl call asks the Audio Device to turn ON or OFF A/V
  52 synchronization.
  53
  54
  55 Return Value
  56 ------------
  57
  58 On success 0 is returned, on error -1 and the ``errno`` variable is set
  59 appropriately. The generic error codes are described at the
  60 :ref:`Generic Error Codes <gen-errors>` chapter.