Linux 4.8.3
[linux/fpc-iii.git] / Documentation / media / uapi / dvb / video-play.rst
blob943c4b75537235c3c3d7208609a226b3414694aa
1 .. -*- coding: utf-8; mode: rst -*-
3 .. _VIDEO_PLAY:
5 ==========
6 VIDEO_PLAY
7 ==========
9 Name
10 ----
12 VIDEO_PLAY
15 Synopsis
16 --------
18 .. cpp:function:: int ioctl(fd, int request = VIDEO_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 VIDEO_PLAY for this command.
42 Description
43 -----------
45 This ioctl is for DVB devices only. To control a V4L2 decoder use the
46 V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
48 This ioctl call asks the Video Device to start playing a video stream
49 from the selected source.
52 Return Value
53 ------------
55 On success 0 is returned, on error -1 and the ``errno`` variable is set
56 appropriately. The generic error codes are described at the
57 :ref:`Generic Error Codes <gen-errors>` chapter.