WIP FPC-III support
[linux/fpc-iii.git] / Documentation / userspace-api / media / dvb / video-fwrite.rst
bloba07fd7d7a40ebac675fc4b98afbd0b59fa0b8e41
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. c:namespace:: DTV.video
4 .. _video_fwrite:
6 =================
7 dvb video write()
8 =================
10 Name
11 ----
13 dvb video write()
15 .. attention:: This ioctl is deprecated.
17 Synopsis
18 --------
20 .. 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
29     -  .. row 1
31        -  int fd
33        -  File descriptor returned by a previous call to open().
35     -  .. row 2
37        -  void \*buf
39        -  Pointer to the buffer containing the PES data.
41     -  .. row 3
43        -  size_t count
45        -  Size of buf.
47 Description
48 -----------
50 This system call can only be used if VIDEO_SOURCE_MEMORY is selected
51 in the ioctl call VIDEO_SELECT_SOURCE. The data provided shall be in
52 PES format, unless the capability allows other formats. If O_NONBLOCK
53 is not specified the function will block until buffer space is
54 available. The amount of data to be transferred is implied by count.
56 Return Value
57 ------------
59 .. flat-table::
60     :header-rows:  0
61     :stub-columns: 0
63     -  .. row 1
65        -  ``EPERM``
67        -  Mode VIDEO_SOURCE_MEMORY not selected.
69     -  .. row 2
71        -  ``ENOMEM``
73        -  Attempted to write more data than the internal buffer can hold.
75     -  .. row 3
77        -  ``EBADF``
79        -  fd is not a valid open file descriptor.