Linux 4.8.3
[linux/fpc-iii.git] / Documentation / media / uapi / dvb / audio-play.rst
blobdb4d7203acc5c462e5172eea8c2940c8262162fd
1 .. -*- coding: utf-8; mode: rst -*-
3 .. _AUDIO_PLAY:
5 ==========
6 AUDIO_PLAY
7 ==========
9 Name
10 ----
12 AUDIO_PLAY
15 Synopsis
16 --------
18 .. cpp:function:: int  ioctl(int fd, int request = AUDIO_PLAY)
21 Arguments
22 ---------
24 .. flat-table::
25     :header-rows:  0
26     :stub-columns: 0
29     -  .. row 1
31        -  int fd
33        -  File descriptor returned by a previous call to open().
35     -  .. row 2
37        -  int request
39        -  Equals AUDIO_PLAY for this command.
42 Description
43 -----------
45 This ioctl call asks the Audio Device to start playing an audio stream
46 from the selected source.
49 Return Value
50 ------------
52 On success 0 is returned, on error -1 and the ``errno`` variable is set
53 appropriately. The generic error codes are described at the
54 :ref:`Generic Error Codes <gen-errors>` chapter.