doc-rst: linux_tv: split DVB function call documentation
[deliverable/linux.git] / Documentation / linux_tv / media / dvb / audio-fwrite.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _audio_fwrite:
4
5 DVB audio write()
6 =================
7
8 Description
9 -----------
10
11 This system call can only be used if AUDIO_SOURCE_MEMORY is selected
12 in the ioctl call AUDIO_SELECT_SOURCE. The data provided shall be in
13 PES format. If O_NONBLOCK is not specified the function will block
14 until buffer space is available. The amount of data to be transferred is
15 implied by count.
16
17 Synopsis
18 --------
19
20 .. c:function:: size_t write(int fd, const void *buf, size_t count)
21
22 Arguments
23 ----------
24
25
26
27 .. flat-table::
28 :header-rows: 0
29 :stub-columns: 0
30
31
32 - .. row 1
33
34 - int fd
35
36 - File descriptor returned by a previous call to open().
37
38 - .. row 2
39
40 - void \*buf
41
42 - Pointer to the buffer containing the PES data.
43
44 - .. row 3
45
46 - size_t count
47
48 - Size of buf.
49
50
51 Return Value
52 ------------
53
54
55
56 .. flat-table::
57 :header-rows: 0
58 :stub-columns: 0
59
60
61 - .. row 1
62
63 - ``EPERM``
64
65 - Mode AUDIO_SOURCE_MEMORY not selected.
66
67 - .. row 2
68
69 - ``ENOMEM``
70
71 - Attempted to write more data than the internal buffer can hold.
72
73 - .. row 3
74
75 - ``EBADF``
76
77 - fd is not a valid open file descriptor.
78
79
80
This page took 0.083602 seconds and 5 git commands to generate.