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

History

246 lines (236 loc) · 12.9 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

245

246

<!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: API for a session manager.</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="#nested-classes">Data Structures</a> |

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

<div class="title">API for a session manager.</div> </div>

</div>

Data Structures</h2></td></tr>

<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structjack__session__command__t.html">jack_session_command_t</a></td></tr>

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

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

<tr class="memitem:gad5683da5880fc248ba87cdf2cc3c1887"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structjack__session__command__t.html">jack_session_command_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__JackSessionManagerAPI.html#gad5683da5880fc248ba87cdf2cc3c1887">jack_session_notify</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, const char *target, <a class="el" href="group__SessionClientFunctions.html#gadaa6c819c4e14eb162b5d3f462866dfc">jack_session_event_type_t</a> type, const char *path) JACK_WEAK_EXPORT</td></tr>

<tr class="memitem:ga62b659432fdfed7ec482054430e71431"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__JackSessionManagerAPI.html#ga62b659432fdfed7ec482054430e71431">jack_session_commands_free</a> (<a class="el" href="structjack__session__command__t.html">jack_session_command_t</a> *cmds) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT</td></tr>

<tr class="memitem:ga2693d2d6eface89e41394ec41ed49ea8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__JackSessionManagerAPI.html#ga2693d2d6eface89e41394ec41ed49ea8">jack_reserve_client_name</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, const char *name, const char *uuid) JACK_WEAK_EXPORT</td></tr>

<tr class="memitem:gadc159d35a3814d463eaf0f7b36f4f241"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__JackSessionManagerAPI.html#gadc159d35a3814d463eaf0f7b36f4f241">jack_client_has_session_callback</a> (<a class="el" href="types_8h.html#a96cf103940d2ee71b141d4b9d0c116bf">jack_client_t</a> *client, const char *client_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT</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="#gadc159d35a3814d463eaf0f7b36f4f241">◆ </a></span>jack_client_has_session_callback()</h2>

<tr>

<td class="memname">int jack_client_has_session_callback </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">const char * </td>

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

</tr>

<tr>

</tr>

</table>

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

<p>Find out whether a client has set up a session callback.</p>

<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000016">Deprecated:</a></b></dt><dd>Use of JACK-Session is currently deprecated and unsupported. JACK developers recommend the use of NSM instead. See <a href="https://github.com/linuxaudio/new-session-manager">https://github.com/linuxaudio/new-session-manager</a></dd></dl>

<dl class="section return"><dt>Returns</dt><dd>0 when the client has no session callback, 1 when it has one. -1 on error. </dd></dl>

</div>

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

<tr>

<td class="memname">int jack_reserve_client_name </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">const char * </td>

</tr>

<tr>

<td class="paramtype">const char * </td>

</tr>

<tr>

</tr>

</table>

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

<p>Reserve a client name and associate it with a UUID.</p>

<p>When a client later calls <a class="el" href="group__ClientFunctions.html#gabbd2041bca191943b6ef29a991a131c5">jack_client_open()</a> and specifies the UUID, jackd will assign the reserved name. This allows a session manager to know in advance under which client name its managed clients will appear.</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="#ga62b659432fdfed7ec482054430e71431">◆ </a></span>jack_session_commands_free()</h2>

<tr>

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

<td class="paramtype"><a class="el" href="structjack__session__command__t.html">jack_session_command_t</a> * </td>

</tr>

</table>

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

<p>Free the memory allocated by a session command.</p>

<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated:</a></b></dt><dd>Use of JACK-Session is currently deprecated and unsupported. JACK developers recommend the use of NSM instead. See <a href="https://github.com/linuxaudio/new-session-manager">https://github.com/linuxaudio/new-session-manager</a> </dd></dl>

</div>

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

<tr>

<td class="memname"><a class="el" href="structjack__session__command__t.html">jack_session_command_t</a>* jack_session_notify </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">const char * </td>

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

</tr>

<tr>

<td class="paramtype"><a class="el" href="group__SessionClientFunctions.html#gadaa6c819c4e14eb162b5d3f462866dfc">jack_session_event_type_t</a> </td>

</tr>

<tr>

<td class="paramtype">const char * </td>

</tr>

<tr>

</tr>

</table>

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

<p>Send an event to all clients listening for session callbacks.</p>

<p>The returned strings of the clients are accumulated and returned as an array of <a class="el" href="structjack__session__command__t.html">jack_session_command_t</a>. its terminated by ret[i].uuid == NULL target == NULL means send to all interested clients. otherwise a clientname </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__JackSessionManagerAPI.html at master · hcfman/jackaudio.github.com · GitHub

Expand file tree

Breadcrumbs

group__JackSessionManagerAPI.html

Latest commit

History

Breadcrumbs

group__JackSessionManagerAPI.html

File metadata and controls