summaryrefslogtreecommitdiff
path: root/structpw__node__proxy__methods.html
blob: b90997d9cd4c0950c3e926214610604536aee383 (plain)
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
<!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_node_proxy_methods 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&amp;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
   &#160;<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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structpw__node__proxy__methods.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_node_proxy_methods Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Node methods.  
 <a href="structpw__node__proxy__methods.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:a220c84ef2948ad2233ce1ef8c5eb81b1"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__node__proxy__methods.html#a220c84ef2948ad2233ce1ef8c5eb81b1">version</a></td></tr>
<tr class="separator:a220c84ef2948ad2233ce1ef8c5eb81b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89422605272146bc9c1f9a4e5b03f0f3"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__node__proxy__methods.html#a89422605272146bc9c1f9a4e5b03f0f3">add_listener</a> )(void *object, struct spa_hook *listener, const struct <a class="el" href="structpw__node__proxy__events.html">pw_node_proxy_events</a> *events, void *<a class="el" href="structdata.html">data</a>)</td></tr>
<tr class="separator:a89422605272146bc9c1f9a4e5b03f0f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf16a77976a3a3095adc32217939fc27"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__node__proxy__methods.html#adf16a77976a3a3095adc32217939fc27">subscribe_params</a> )(void *object, uint32_t *ids, uint32_t n_ids)</td></tr>
<tr class="memdesc:adf16a77976a3a3095adc32217939fc27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Subscribe to parameter changes.  <a href="#adf16a77976a3a3095adc32217939fc27">More...</a><br /></td></tr>
<tr class="separator:adf16a77976a3a3095adc32217939fc27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91f747dbc317e7790d4e231cd0266a75"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__node__proxy__methods.html#a91f747dbc317e7790d4e231cd0266a75">enum_params</a> )(void *object, int seq, uint32_t id, uint32_t start, uint32_t num, const struct spa_pod *filter)</td></tr>
<tr class="memdesc:a91f747dbc317e7790d4e231cd0266a75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumerate node parameters.  <a href="#a91f747dbc317e7790d4e231cd0266a75">More...</a><br /></td></tr>
<tr class="separator:a91f747dbc317e7790d4e231cd0266a75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb03ddccfc30f1641b2c5ddb70c998ff"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__node__proxy__methods.html#acb03ddccfc30f1641b2c5ddb70c998ff">set_param</a> )(void *object, uint32_t id, uint32_t flags, const struct spa_pod *<a class="el" href="structparam.html">param</a>)</td></tr>
<tr class="memdesc:acb03ddccfc30f1641b2c5ddb70c998ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a parameter on the node.  <a href="#acb03ddccfc30f1641b2c5ddb70c998ff">More...</a><br /></td></tr>
<tr class="separator:acb03ddccfc30f1641b2c5ddb70c998ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af599dd8a1edfe3f5d6ff1fa52642e2db"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__node__proxy__methods.html#af599dd8a1edfe3f5d6ff1fa52642e2db">send_command</a> )(void *object, const struct spa_command *command)</td></tr>
<tr class="memdesc:af599dd8a1edfe3f5d6ff1fa52642e2db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a command to the node.  <a href="#af599dd8a1edfe3f5d6ff1fa52642e2db">More...</a><br /></td></tr>
<tr class="separator:af599dd8a1edfe3f5d6ff1fa52642e2db"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Node methods. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a89422605272146bc9c1f9a4e5b03f0f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89422605272146bc9c1f9a4e5b03f0f3">&#9670;&nbsp;</a></span>add_listener</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* pw_node_proxy_methods::add_listener) (void *object, struct spa_hook *listener, const struct <a class="el" href="structpw__node__proxy__events.html">pw_node_proxy_events</a> *events, void *<a class="el" href="structdata.html">data</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a91f747dbc317e7790d4e231cd0266a75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91f747dbc317e7790d4e231cd0266a75">&#9670;&nbsp;</a></span>enum_params</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* pw_node_proxy_methods::enum_params) (void *object, int seq, uint32_t id, uint32_t start, uint32_t num, const struct spa_pod *filter)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enumerate node parameters. </p>
<p>Start enumeration of node parameters. For each param, a param event will be emited.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">seq</td><td>a sequence number to place in the reply </td></tr>
    <tr><td class="paramname">id</td><td>the parameter id to enum or SPA_ID_INVALID for all </td></tr>
    <tr><td class="paramname">start</td><td>the start index or 0 for the first param </td></tr>
    <tr><td class="paramname">num</td><td>the maximum number of params to retrieve </td></tr>
    <tr><td class="paramname">filter</td><td>a param filter or NULL </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="af599dd8a1edfe3f5d6ff1fa52642e2db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af599dd8a1edfe3f5d6ff1fa52642e2db">&#9670;&nbsp;</a></span>send_command</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* pw_node_proxy_methods::send_command) (void *object, const struct spa_command *command)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Send a command to the node. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">command</td><td>the command to send </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="acb03ddccfc30f1641b2c5ddb70c998ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb03ddccfc30f1641b2c5ddb70c998ff">&#9670;&nbsp;</a></span>set_param</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* pw_node_proxy_methods::set_param) (void *object, uint32_t id, uint32_t flags, const struct spa_pod *<a class="el" href="structparam.html">param</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set a parameter on the node. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">id</td><td>the parameter id to set </td></tr>
    <tr><td class="paramname">flags</td><td>extra parameter flags </td></tr>
    <tr><td class="paramname">param</td><td>the parameter to set </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="adf16a77976a3a3095adc32217939fc27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf16a77976a3a3095adc32217939fc27">&#9670;&nbsp;</a></span>subscribe_params</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* pw_node_proxy_methods::subscribe_params) (void *object, uint32_t *ids, uint32_t n_ids)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Subscribe to parameter changes. </p>
<p>Automatically emit param events for the given ids when they are changed.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ids</td><td>an array of param ids </td></tr>
    <tr><td class="paramname">n_ids</td><td>the number of ids in <em>ids</em> </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a220c84ef2948ad2233ce1ef8c5eb81b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a220c84ef2948ad2233ce1ef8c5eb81b1">&#9670;&nbsp;</a></span>version</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t pw_node_proxy_methods::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="interfaces_8h_source.html">interfaces.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__node__proxy__methods.html">pw_node_proxy_methods</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>