WIP FPC-III support
[linux/fpc-iii.git] / Documentation / userspace-api / media / dvb / audio-set-av-sync.rst
blob85a8016bf025f99cf5eb73f0c47b3c345dbbe599
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: DTV.audio
4 .. _AUDIO_SET_AV_SYNC:
6 =================
7 AUDIO_SET_AV_SYNC
8 =================
10 Name
11 ----
13 AUDIO_SET_AV_SYNC
15 .. attention:: This ioctl is deprecated
17 Synopsis
18 --------
20 .. c:macro:: AUDIO_SET_AV_SYNC
22 ``int ioctl(int fd, AUDIO_SET_AV_SYNC, boolean state)``
24 Arguments
25 ---------
27 .. flat-table::
28     :header-rows:  0
29     :stub-columns: 0
31     -
33        -  int fd
35        -  File descriptor returned by a previous call to open().
37     -
39        -  boolean state
41        -  Tells the Digital TV subsystem if A/V synchronization shall be ON or OFF.
43           TRUE: AV-sync ON
45           FALSE: AV-sync OFF
47 Description
48 -----------
50 This ioctl call asks the Audio Device to turn ON or OFF A/V
51 synchronization.
53 Return Value
54 ------------
56 On success 0 is returned, on error -1 and the ``errno`` variable is set
57 appropriately. The generic error codes are described at the
58 :ref:`Generic Error Codes <gen-errors>` chapter.