jackaudio.github.com/api/group__NonCallbackAPI.html at master · hcfman/jackaudio.github.com · GitHub

History

244 lines (234 loc) · 12.4 KB

Raw

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>JACK-AUDIO-CONNECTION-KIT: The non-callback API</title>

/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */

$(document).ready(function() { init_search(); });

/* @license-end */

</script>

</head>

<body>

<tbody>

<div id="projectname">JACK-AUDIO-CONNECTION-KIT

</div>

</td>

</tr>

</tbody>

</table>

</div>

/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */

var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');

/* @license-end */

</script>

<li><a href="pages.html"><span>Related Pages</span></a></li>

<li class="current"><a href="modules.html"><span>Modules</span></a></li>

<li><a href="annotated.html"><span>Data Structures</span></a></li>

<li><a href="files.html"><span>Files</span></a></li>

<li>

<img id="MSearchSelect" src="search/mag_sel.svg"

onmouseover="return searchBox.OnSearchSelectShow()"

onmouseout="return searchBox.OnSearchSelectHide()"

alt=""/>

<input type="text" id="MSearchField" value="Search" accesskey="S"

onfocus="searchBox.OnSearchFieldFocus(true)"

onblur="searchBox.OnSearchFieldFocus(false)"

onkeyup="searchBox.OnSearchFieldChange(event)"/>

</span><span class="right">

</span>

</div>

</li>

</ul>

</div>

</div>

<div id="MSearchSelectWindow"

onmouseover="return searchBox.OnSearchSelectShow()"

onmouseout="return searchBox.OnSearchSelectHide()"

onkeydown="return searchBox.OnSearchSelectKey(event)">

</div>

name="MSearchResults" id="MSearchResults">

</iframe>

</div>

<a href="#groups">Modules</a> |

<a href="#func-members">Functions</a> </div>

<div class="title">The non-callback API<div class="ingroups"><a class="el" href="group__ClientFunctions.html">Creating & manipulating clients</a></div></div> </div>

</div>

Modules</h2></td></tr>

<tr class="memitem:group__ClientCallbacks"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ClientCallbacks.html">Setting Client Callbacks</a></td></tr>

</table><table class="memberdecls">

Functions</h2></td></tr>

<tr class="memitem:ga3f08587cfe43a0f883a1e2dfbb72edbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#aa954df532e901ae5172e68a23f3da9b6">jack_nframes_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__NonCallbackAPI.html#ga3f08587cfe43a0f883a1e2dfbb72edbb">jack_thread_wait</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *, int status) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT</td></tr>

<tr class="memitem:gabf0867ccf1ba257d84455d95ef3e1632"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#aa954df532e901ae5172e68a23f3da9b6">jack_nframes_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__NonCallbackAPI.html#gabf0867ccf1ba257d84455d95ef3e1632">jack_cycle_wait</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>

<tr class="memitem:ga4da168f4fb79585b19bc40db3bb06409"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__NonCallbackAPI.html#ga4da168f4fb79585b19bc40db3bb06409">jack_cycle_signal</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, int status) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>

<tr class="memitem:ga66b623b80e34424dd380d38ae42b3261"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__NonCallbackAPI.html#ga66b623b80e34424dd380d38ae42b3261">jack_set_process_thread</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, <a class="el" href="types_8h.html#aeca53f91c53724bd279a11e46a4978cf">JackThreadCallback</a> fun, void *arg) <a class="el" href="weakmacros_8h.html#adf1bde0dd996bbf61a44311165014dd1">JACK_OPTIONAL_WEAK_EXPORT</a></td></tr>

</table>

<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

<h2 class="groupheader">Function Documentation</h2>

<h2 class="memtitle"><span class="permalink"><a href="#ga4da168f4fb79585b19bc40db3bb06409">◆ </a></span>jack_cycle_signal()</h2>

<tr>

<td class="memname">void jack_cycle_signal </td>

<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>

<td class="paramname"><em>client</em>, </td>

</tr>

<tr>

<td class="paramname"><em>status</em> </td>

</tr>

<tr>

</tr>

</table>

</div><div class="memdoc">

<p>Signal next clients in the graph.</p>

<dl class="params"><dt>Parameters</dt><dd>

<tr><td class="paramname">client</td><td>- pointer to a JACK client structure </td></tr>

<tr><td class="paramname">status</td><td>- if non-zero, calling thread should exit </td></tr>

</table>

</dd>

</dl>

</div>

<h2 class="memtitle"><span class="permalink"><a href="#gabf0867ccf1ba257d84455d95ef3e1632">◆ </a></span>jack_cycle_wait()</h2>

<tr>

<td class="memname"><a class="el" href="types_8h.html#aa954df532e901ae5172e68a23f3da9b6">jack_nframes_t</a> jack_cycle_wait </td>

<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>

<td class="paramname"><em>client</em></td><td>)</td>

</tr>

</table>

</div><div class="memdoc">

<p>Wait until this JACK client should process data.</p>

<dl class="params"><dt>Parameters</dt><dd>

<tr><td class="paramname">client</td><td>- pointer to a JACK client structure</td></tr>

</table>

</dd>

</dl>

<dl class="section return"><dt>Returns</dt><dd>the number of frames of data to process </dd></dl>

</div>

<h2 class="memtitle"><span class="permalink"><a href="#ga66b623b80e34424dd380d38ae42b3261">◆ </a></span>jack_set_process_thread()</h2>

<tr>

<td class="memname">int jack_set_process_thread </td>

<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>

<td class="paramname"><em>client</em>, </td>

</tr>

<tr>

<td class="paramtype"><a class="el" href="types_8h.html#aeca53f91c53724bd279a11e46a4978cf">JackThreadCallback</a> </td>

</tr>

<tr>

</tr>

<tr>

</tr>

</table>

</div><div class="memdoc">

<p>Tell the Jack server to call <em>thread_callback</em> in the RT thread. Typical use are in conjunction with <em>jack_cycle_wait</em> and @ jack_cycle_signal functions. The code in the supplied function must be suitable for real-time execution. That means that it cannot call functions that might block for a long time. This includes all I/O functions (disk, TTY, network), malloc, free, printf, pthread_mutex_lock, sleep, wait, poll, select, pthread_join, pthread_cond_wait, etc, etc.</p>

<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise a non-zero error code. </dd></dl>

</div>

<h2 class="memtitle"><span class="permalink"><a href="#ga3f08587cfe43a0f883a1e2dfbb72edbb">◆ </a></span>jack_thread_wait()</h2>

<tr>

<td class="memname"><a class="el" href="types_8h.html#aa954df532e901ae5172e68a23f3da9b6">jack_nframes_t</a> jack_thread_wait </td>

<td class="paramtype"><a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> * </td>

</tr>

<tr>

<td class="paramname"><em>status</em> </td>

</tr>

<tr>

</tr>

</table>

</div><div class="memdoc">

<p><b>THIS FUNCTION IS DEPRECATED AND SHOULD NOT BE USED IN NEW JACK CLIENTS</b></p>

<p>It should be replace by use of @ jack_cycle_wait and @ jack_cycle_signal functions. </p>

</div>

</div>

Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1

</small></address>

</body>

</html>

jackaudio.github.com/api/group__NonCallbackAPI.html at master · hcfman/jackaudio.github.com · GitHub

Expand file tree

Breadcrumbs

group__NonCallbackAPI.html

Latest commit

History

Breadcrumbs

group__NonCallbackAPI.html

File metadata and controls