1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PipeWire: pw_stream_events Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PipeWire
 <span id="projectnumber">0.2.9</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structpw__stream__events.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">pw_stream_events Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Events for a stream.
<a href="structpw__stream__events.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a74aaca4c31e44dad69aba50607055419"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__stream__events.html#a74aaca4c31e44dad69aba50607055419">version</a></td></tr>
<tr class="separator:a74aaca4c31e44dad69aba50607055419"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abbe98bb0d78e6411d08244495f349b0b"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__stream__events.html#abbe98bb0d78e6411d08244495f349b0b">destroy</a> )(void *<a class="el" href="structdata.html">data</a>)</td></tr>
<tr class="separator:abbe98bb0d78e6411d08244495f349b0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89192aed5fcd89314bf7cc7ef6b21085"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__stream__events.html#a89192aed5fcd89314bf7cc7ef6b21085">state_changed</a> )(void *<a class="el" href="structdata.html">data</a>, enum <a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82">pw_stream_state</a> old, enum <a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82">pw_stream_state</a> state, const char *error)</td></tr>
<tr class="memdesc:a89192aed5fcd89314bf7cc7ef6b21085"><td class="mdescLeft"> </td><td class="mdescRight">when the stream state changes <a href="#a89192aed5fcd89314bf7cc7ef6b21085">More...</a><br /></td></tr>
<tr class="separator:a89192aed5fcd89314bf7cc7ef6b21085"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3efe9a6dc601da668b39650d4c446031"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__stream__events.html#a3efe9a6dc601da668b39650d4c446031">control_changed</a> )(void *<a class="el" href="structdata.html">data</a>, uint32_t id, float value)</td></tr>
<tr class="memdesc:a3efe9a6dc601da668b39650d4c446031"><td class="mdescLeft"> </td><td class="mdescRight">Notify information about a control. <a href="#a3efe9a6dc601da668b39650d4c446031">More...</a><br /></td></tr>
<tr class="separator:a3efe9a6dc601da668b39650d4c446031"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8136ecfe4e1fe26467da10915f08bd2a"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__stream__events.html#a8136ecfe4e1fe26467da10915f08bd2a">format_changed</a> )(void *<a class="el" href="structdata.html">data</a>, const struct spa_pod *format)</td></tr>
<tr class="memdesc:a8136ecfe4e1fe26467da10915f08bd2a"><td class="mdescLeft"> </td><td class="mdescRight">when the format changed. <a href="#a8136ecfe4e1fe26467da10915f08bd2a">More...</a><br /></td></tr>
<tr class="separator:a8136ecfe4e1fe26467da10915f08bd2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd09d7c76b0e14a201a438f09e609b29"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__stream__events.html#abd09d7c76b0e14a201a438f09e609b29">add_buffer</a> )(void *<a class="el" href="structdata.html">data</a>, struct <a class="el" href="structpw__buffer.html">pw_buffer</a> *<a class="el" href="structbuffer.html">buffer</a>)</td></tr>
<tr class="memdesc:abd09d7c76b0e14a201a438f09e609b29"><td class="mdescLeft"> </td><td class="mdescRight">when a new buffer was created for this stream <a href="#abd09d7c76b0e14a201a438f09e609b29">More...</a><br /></td></tr>
<tr class="separator:abd09d7c76b0e14a201a438f09e609b29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0cdc45fef5f2458a0fd11a6e9ef1f6fb"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__stream__events.html#a0cdc45fef5f2458a0fd11a6e9ef1f6fb">remove_buffer</a> )(void *<a class="el" href="structdata.html">data</a>, struct <a class="el" href="structpw__buffer.html">pw_buffer</a> *<a class="el" href="structbuffer.html">buffer</a>)</td></tr>
<tr class="memdesc:a0cdc45fef5f2458a0fd11a6e9ef1f6fb"><td class="mdescLeft"> </td><td class="mdescRight">when a buffer was destroyed for this stream <a href="#a0cdc45fef5f2458a0fd11a6e9ef1f6fb">More...</a><br /></td></tr>
<tr class="separator:a0cdc45fef5f2458a0fd11a6e9ef1f6fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a512bd219ce44ba1a688d600773efe84b"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__stream__events.html#a512bd219ce44ba1a688d600773efe84b">process</a> )(void *<a class="el" href="structdata.html">data</a>)</td></tr>
<tr class="memdesc:a512bd219ce44ba1a688d600773efe84b"><td class="mdescLeft"> </td><td class="mdescRight">when a buffer can be queued (for playback streams) or dequeued (for capture streams). <a href="#a512bd219ce44ba1a688d600773efe84b">More...</a><br /></td></tr>
<tr class="separator:a512bd219ce44ba1a688d600773efe84b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aab4b9831ef563920b401b1f9daf93042"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__stream__events.html#aab4b9831ef563920b401b1f9daf93042">drained</a> )(void *<a class="el" href="structdata.html">data</a>)</td></tr>
<tr class="memdesc:aab4b9831ef563920b401b1f9daf93042"><td class="mdescLeft"> </td><td class="mdescRight">The stream is drained. <a href="#aab4b9831ef563920b401b1f9daf93042">More...</a><br /></td></tr>
<tr class="separator:aab4b9831ef563920b401b1f9daf93042"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Events for a stream. </p>
<p>These events are always called from the mainloop unless explicitly documented otherwise. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="abd09d7c76b0e14a201a438f09e609b29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd09d7c76b0e14a201a438f09e609b29">◆ </a></span>add_buffer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* pw_stream_events::add_buffer) (void *<a class="el" href="structdata.html">data</a>, struct <a class="el" href="structpw__buffer.html">pw_buffer</a> *<a class="el" href="structbuffer.html">buffer</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>when a new buffer was created for this stream </p>
</div>
</div>
<a id="a3efe9a6dc601da668b39650d4c446031"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3efe9a6dc601da668b39650d4c446031">◆ </a></span>control_changed</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* pw_stream_events::control_changed) (void *<a class="el" href="structdata.html">data</a>, uint32_t id, float value)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Notify information about a control. </p>
</div>
</div>
<a id="abbe98bb0d78e6411d08244495f349b0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbe98bb0d78e6411d08244495f349b0b">◆ </a></span>destroy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* pw_stream_events::destroy) (void *<a class="el" href="structdata.html">data</a>)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aab4b9831ef563920b401b1f9daf93042"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab4b9831ef563920b401b1f9daf93042">◆ </a></span>drained</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* pw_stream_events::drained) (void *<a class="el" href="structdata.html">data</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The stream is drained. </p>
</div>
</div>
<a id="a8136ecfe4e1fe26467da10915f08bd2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8136ecfe4e1fe26467da10915f08bd2a">◆ </a></span>format_changed</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* pw_stream_events::format_changed) (void *<a class="el" href="structdata.html">data</a>, const struct spa_pod *format)</td>
</tr>
</table>
</div><div class="memdoc">
<p>when the format changed. </p>
<p>The listener should call <a class="el" href="classpw__stream.html#abcd423c15a39666ea50abef5ff7a75bd" title="Complete the negotiation process with result code res.">pw_stream_finish_format()</a> from within this callback or later to complete the format negotiation and start the buffer negotiation. </p>
</div>
</div>
<a id="a512bd219ce44ba1a688d600773efe84b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a512bd219ce44ba1a688d600773efe84b">◆ </a></span>process</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* pw_stream_events::process) (void *<a class="el" href="structdata.html">data</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>when a buffer can be queued (for playback streams) or dequeued (for capture streams). </p>
<p>This is normally called from the mainloop but can also be called directly from the realtime data thread if the user is prepared to deal with this. </p>
</div>
</div>
<a id="a0cdc45fef5f2458a0fd11a6e9ef1f6fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cdc45fef5f2458a0fd11a6e9ef1f6fb">◆ </a></span>remove_buffer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* pw_stream_events::remove_buffer) (void *<a class="el" href="structdata.html">data</a>, struct <a class="el" href="structpw__buffer.html">pw_buffer</a> *<a class="el" href="structbuffer.html">buffer</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>when a buffer was destroyed for this stream </p>
</div>
</div>
<a id="a89192aed5fcd89314bf7cc7ef6b21085"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89192aed5fcd89314bf7cc7ef6b21085">◆ </a></span>state_changed</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* pw_stream_events::state_changed) (void *<a class="el" href="structdata.html">data</a>, enum <a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82">pw_stream_state</a> old, enum <a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82">pw_stream_state</a> state, const char *error)</td>
</tr>
</table>
</div><div class="memdoc">
<p>when the stream state changes </p>
</div>
</div>
<a id="a74aaca4c31e44dad69aba50607055419"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74aaca4c31e44dad69aba50607055419">◆ </a></span>version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t pw_stream_events::version</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="stream_8h_source.html">stream.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="structpw__stream__events.html">pw_stream_events</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>
|
