Linux 4.11-rc6
[linux/fpc-iii.git] / Documentation / media / uapi / dvb / video-fwrite.rst
blobcfe7c57dcfc74eabc28c8cc0e9f44c4fe3614551
1 .. -*- coding: utf-8; mode: rst -*-
3 .. _video_fwrite:
5 =================
6 dvb video write()
7 =================
9 Name
10 ----
12 dvb video write()
14 .. attention:: This ioctl is deprecated.
16 Synopsis
17 --------
19 .. c:function:: size_t write(int fd, const void *buf, size_t count)
22 Arguments
23 ---------
25 .. flat-table::
26     :header-rows:  0
27     :stub-columns: 0
30     -  .. row 1
32        -  int fd
34        -  File descriptor returned by a previous call to open().
36     -  .. row 2
38        -  void \*buf
40        -  Pointer to the buffer containing the PES data.
42     -  .. row 3
44        -  size_t count
46        -  Size of buf.
49 Description
50 -----------
52 This system call can only be used if VIDEO_SOURCE_MEMORY is selected
53 in the ioctl call VIDEO_SELECT_SOURCE. The data provided shall be in
54 PES format, unless the capability allows other formats. If O_NONBLOCK
55 is not specified the function will block until buffer space is
56 available. The amount of data to be transferred is implied by count.
59 Return Value
60 ------------
62 .. flat-table::
63     :header-rows:  0
64     :stub-columns: 0
67     -  .. row 1
69        -  ``EPERM``
71        -  Mode VIDEO_SOURCE_MEMORY not selected.
73     -  .. row 2
75        -  ``ENOMEM``
77        -  Attempted to write more data than the internal buffer can hold.
79     -  .. row 3
81        -  ``EBADF``
83        -  fd is not a valid open file descriptor.