/usr/share/gtk-doc/html/libinstpatch/IpatchVBank.html is in libinstpatch-doc 1.0.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchVBank</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="libinstpatch Reference Manual">
<link rel="up" href="ch07.html" title="Virtual banks">
<link rel="prev" href="ch07.html" title="Virtual banks">
<link rel="next" href="IpatchVBankInst.html" title="IpatchVBankInst">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Base objects and functions">
<link rel="chapter" href="ch02.html" title="Utility objects and functions">
<link rel="chapter" href="ch03.html" title="Sample data objects and functions">
<link rel="chapter" href="ch04.html" title="DLS patches">
<link rel="chapter" href="ch05.html" title="SoundFont patches">
<link rel="chapter" href="ch06.html" title="GigaSampler patches">
<link rel="chapter" href="ch07.html" title="Virtual banks">
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
<link rel="index" href="api-index-full.html" title="API Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch07.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch07.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinstpatch Reference Manual</th>
<td><a accesskey="n" href="IpatchVBankInst.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchVBank.synopsis" class="shortcut">Top</a>
|
<a href="#IpatchVBank.description" class="shortcut">Description</a>
|
<a href="#IpatchVBank.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#IpatchVBank.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="IpatchVBank">
<a name="IpatchVBank"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchVBank.top_of_page"></a>IpatchVBank</span></h2>
<p>IpatchVBank — Virtual bank object</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchVBank.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchVBank.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#define <a
href="../libinstpatch/IpatchVBank.html#IPATCH-VBANK-INFO-COUNT--CAPS"
>IPATCH_VBANK_INFO_COUNT</a>
<a
href="../libinstpatch/IpatchVBank.html#IpatchVBank-struct"
>IpatchVBank</a>;
#define <a
href="../libinstpatch/IpatchVBank.html#IPATCH-VBANK-PARSER-VERSION--CAPS"
>IPATCH_VBANK_PARSER_VERSION</a>
<a
href="../libinstpatch/IpatchVBank.html"
>IpatchVBank</a> * <a
href="../libinstpatch/IpatchVBank.html#ipatch-vbank-new"
>ipatch_vbank_new</a> (void);
#define <a
href="../libinstpatch/IpatchVBank.html#ipatch-vbank-get-insts"
>ipatch_vbank_get_insts</a> (vbank)
<a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> * <a
href="../libinstpatch/IpatchVBank.html#ipatch-vbank-find-inst"
>ipatch_vbank_find_inst</a> (<a
href="../libinstpatch/IpatchVBank.html"
>IpatchVBank</a> *vbank,
const char *name,
int bank,
int program,
const <a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *exclude);
char * <a
href="../libinstpatch/IpatchVBank.html#ipatch-vbank-make-unique-name"
>ipatch_vbank_make_unique_name</a> (<a
href="../libinstpatch/IpatchVBank.html"
>IpatchVBank</a> *vbank,
const char *name,
const <a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *exclude);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchVBank.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a>
+----<a
href="../libinstpatch/IpatchContainer.html"
>IpatchContainer</a>
+----<a
href="../libinstpatch/IpatchBase.html"
>IpatchBase</a>
+----IpatchVBank
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="IpatchVBank.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a
href="../libinstpatch/IpatchVBank.html#IpatchVBank--author"
>author</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write
"<a
href="../libinstpatch/IpatchVBank.html#IpatchVBank--comment"
>comment</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write
"<a
href="../libinstpatch/IpatchVBank.html#IpatchVBank--date"
>date</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write
"<a
href="../libinstpatch/IpatchVBank.html#IpatchVBank--engine"
>engine</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write
"<a
href="../libinstpatch/IpatchVBank.html#IpatchVBank--name"
>name</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write
"<a
href="../libinstpatch/IpatchVBank.html#IpatchVBank--parser-version"
>parser-version</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write
"<a
href="../libinstpatch/IpatchVBank.html#IpatchVBank--require-version"
>require-version</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchVBank.description"></a><h2>Description</h2>
<p>
Virtual banks provide the capability of creating new instrument MIDI
maps from components from other files of possibly different types.</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchVBank.details"></a><h2>Details</h2>
<div class="refsect2" title="IPATCH_VBANK_INFO_COUNT">
<a name="IPATCH-VBANK-INFO-COUNT--CAPS"></a><h3>IPATCH_VBANK_INFO_COUNT</h3>
<pre class="programlisting">#define IPATCH_VBANK_INFO_COUNT 7
</pre>
<p>
Count of info strings</p>
</div>
<hr>
<div class="refsect2" title="IpatchVBank">
<a name="IpatchVBank-struct"></a><h3>IpatchVBank</h3>
<pre class="programlisting">typedef struct _IpatchVBank IpatchVBank;</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_VBANK_PARSER_VERSION">
<a name="IPATCH-VBANK-PARSER-VERSION--CAPS"></a><h3>IPATCH_VBANK_PARSER_VERSION</h3>
<pre class="programlisting">#define IPATCH_VBANK_PARSER_VERSION "1.0"
</pre>
<p>
Current IVBank parser version.</p>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_new ()">
<a name="ipatch-vbank-new"></a><h3>ipatch_vbank_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchVBank.html"
>IpatchVBank</a> * ipatch_vbank_new (void);</pre>
<p>
Create a new virtual bank base object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New IVBank base object with a reference count of 1. Caller
owns the reference and removing it will destroy the item.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_get_insts()">
<a name="ipatch-vbank-get-insts"></a><h3>ipatch_vbank_get_insts()</h3>
<pre class="programlisting">#define ipatch_vbank_get_insts(vbank)</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_find_inst ()">
<a name="ipatch-vbank-find-inst"></a><h3>ipatch_vbank_find_inst ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> * ipatch_vbank_find_inst (<a
href="../libinstpatch/IpatchVBank.html"
>IpatchVBank</a> *vbank,
const char *name,
int bank,
int program,
const <a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *exclude);</pre>
<p>
Find an instrument by name or bank:preset MIDI numbers. If instrument <em class="parameter"><code>name</code></em>
and <em class="parameter"><code>bank</code></em>:<em class="parameter"><code>program</code></em> are specified then match for either condition.
If an instrument is found its reference count is incremented before it
is returned. The caller is responsible for removing the reference
with <a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"
><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vbank</code></em> :</span></p></td>
<td> VBank to search in
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> Name of instrument to find or <code class="literal">NULL</code> to match any name
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bank</code></em> :</span></p></td>
<td> MIDI bank number of instrument to search for or -1 to not search by
MIDI bank:program numbers
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>program</code></em> :</span></p></td>
<td> MIDI program number of instrument to search for, only used
if <em class="parameter"><code>bank</code></em> is 0-128
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>exclude</code></em> :</span></p></td>
<td> An instrument to exclude from the search or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The matching instrument or <code class="literal">NULL</code> if not found. Remember to unref
the item when finished with it.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_vbank_make_unique_name ()">
<a name="ipatch-vbank-make-unique-name"></a><h3>ipatch_vbank_make_unique_name ()</h3>
<pre class="programlisting">char * ipatch_vbank_make_unique_name (<a
href="../libinstpatch/IpatchVBank.html"
>IpatchVBank</a> *vbank,
const char *name,
const <a
href="../libinstpatch/IpatchVBankInst.html"
>IpatchVBankInst</a> *exclude);</pre>
<p>
Generates a unique instrument name for <em class="parameter"><code>vbank</code></em>. The <em class="parameter"><code>name</code></em>
parameter is used as a base and is modified, by appending a number, to
make it unique (if necessary). The <em class="parameter"><code>exclude</code></em> parameter is used to exclude
an existing <em class="parameter"><code>vbank</code></em> instrument from the search.
</p>
<p>
MT-Note: To ensure that an item is actually unique before being
added to a VBank object, <a
href="../libinstpatch/IpatchContainer.html#ipatch-container-add-unique"
><code class="function">ipatch_container_add_unique()</code></a> should be
used.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vbank</code></em> :</span></p></td>
<td> VBank item
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> An initial name to use or NULL
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>exclude</code></em> :</span></p></td>
<td> An item to exclude from search or NULL
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new unique name which should be freed when finished with it.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="IpatchVBank.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "author" property'>
<a name="IpatchVBank--author"></a><h3>The <code class="literal">"author"</code> property</h3>
<pre class="programlisting"> "author" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write</pre>
<p>Author of file.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "comment" property'>
<a name="IpatchVBank--comment"></a><h3>The <code class="literal">"comment"</code> property</h3>
<pre class="programlisting"> "comment" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write</pre>
<p>Comments.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "date" property'>
<a name="IpatchVBank--date"></a><h3>The <code class="literal">"date"</code> property</h3>
<pre class="programlisting"> "date" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write</pre>
<p>Creation date.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "engine" property'>
<a name="IpatchVBank--engine"></a><h3>The <code class="literal">"engine"</code> property</h3>
<pre class="programlisting"> "engine" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write</pre>
<p>Synthesis engine.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "name" property'>
<a name="IpatchVBank--name"></a><h3>The <code class="literal">"name"</code> property</h3>
<pre class="programlisting"> "name" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write</pre>
<p>Descriptive name.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "parser-version" property'>
<a name="IpatchVBank--parser-version"></a><h3>The <code class="literal">"parser-version"</code> property</h3>
<pre class="programlisting"> "parser-version" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write</pre>
<p>Parser version.</p>
<p>Default value: "1.0"</p>
</div>
<hr>
<div class="refsect2" title='The "require-version" property'>
<a name="IpatchVBank--require-version"></a><h3>The <code class="literal">"require-version"</code> property</h3>
<pre class="programlisting"> "require-version" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write</pre>
<p>Required parser version.</p>
<p>Default value: "1.0"</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|