WIP FPC-III support
[linux/fpc-iii.git] / Documentation / userspace-api / media / dvb / audio-play.rst
blobe591930b6ca7c2a6146ae6766a9606f996e7c35b
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: DTV.audio
4 .. _AUDIO_PLAY:
6 ==========
7 AUDIO_PLAY
8 ==========
10 Name
11 ----
13 AUDIO_PLAY
15 .. attention:: This ioctl is deprecated
17 Synopsis
18 --------
20 .. c:macro:: AUDIO_PLAY
22 ``int ioctl(int fd, AUDIO_PLAY)``
24 Arguments
25 ---------
27 .. flat-table::
28     :header-rows:  0
29     :stub-columns: 0
31     -  .. row 1
33        -  int fd
35        -  File descriptor returned by a previous call to open().
37 Description
38 -----------
40 This ioctl call asks the Audio Device to start playing an audio stream
41 from the selected source.
43 Return Value
44 ------------
46 On success 0 is returned, on error -1 and the ``errno`` variable is set
47 appropriately. The generic error codes are described at the
48 :ref:`Generic Error Codes <gen-errors>` chapter.