[media] docs-next: stop abusing on the cpp domain
[cascardo/linux.git] / Documentation / media / uapi / dvb / dmx-fwrite.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _dmx_fwrite:
4
5 =================
6 DVB demux write()
7 =================
8
9 Name
10 ----
11
12 DVB demux write()
13
14
15 Synopsis
16 --------
17
18 .. c:function:: ssize_t write(int fd, const void *buf, size_t count)
19
20
21 Arguments
22 ---------
23
24 .. flat-table::
25     :header-rows:  0
26     :stub-columns: 0
27
28
29     -  .. row 1
30
31        -  int fd
32
33        -  File descriptor returned by a previous call to open().
34
35     -  .. row 2
36
37        -  void \*buf
38
39        -  Pointer to the buffer containing the Transport Stream.
40
41     -  .. row 3
42
43        -  size_t count
44
45        -  Size of buf.
46
47
48 Description
49 -----------
50
51 This system call is only provided by the logical device
52 /dev/dvb/adapter0/dvr0, associated with the physical demux device that
53 provides the actual DVR functionality. It is used for replay of a
54 digitally recorded Transport Stream. Matching filters have to be defined
55 in the corresponding physical demux device, /dev/dvb/adapter0/demux0.
56 The amount of data to be transferred is implied by count.
57
58
59 Return Value
60 ------------
61
62 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
63
64 .. flat-table::
65     :header-rows:  0
66     :stub-columns: 0
67
68
69     -  .. row 1
70
71        -  ``EWOULDBLOCK``
72
73        -  No data was written. This might happen if O_NONBLOCK was
74           specified and there is no more buffer space available (if
75           O_NONBLOCK is not specified the function will block until buffer
76           space is available).
77
78     -  .. row 2
79
80        -  ``EBUSY``
81
82        -  This error code indicates that there are conflicting requests. The
83           corresponding demux device is setup to receive data from the
84           front- end. Make sure that these filters are stopped and that the
85           filters with input set to DMX_IN_DVR are started.
86
87     -  .. row 3
88
89        -  ``EBADF``
90
91        -  fd is not a valid open file descriptor.