/usr/share/doc/python-liblo-docs/index.html is in python-liblo-docs 0.10.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 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://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/html; charset=utf-8" />
<title>pyliblo 0.10 API Documentation — pyliblo documentation</title>
<link rel="stylesheet" href="_static/nasophon.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: false
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="pyliblo documentation" href="#" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="#">pyliblo documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<span class="target" id="module-liblo"></span><div class="section" id="pyliblo-0-10-api-documentation">
<h1>pyliblo 0.10 API Documentation<a class="headerlink" href="#pyliblo-0-10-api-documentation" title="Permalink to this headline">¶</a></h1>
<p>Homepage: <a class="reference external" href="http://das.nasophon.de/pyliblo/">http://das.nasophon.de/pyliblo/</a></p>
<p>The latest version of this manual can be found at
<a class="reference external" href="http://dsacre.github.io/pyliblo/doc/">http://dsacre.github.io/pyliblo/doc/</a>.</p>
<p>For the most part, pyliblo is just a thin wrapper around
<a class="reference external" href="http://liblo.sourceforge.net/">liblo</a>, which does
all the real work.
For questions not answered here, also see the
<a class="reference external" href="http://liblo.sourceforge.net/docs/modules.html">liblo documentation</a>
and the <a class="reference external" href="http://opensoundcontrol.org/spec-1_0">OSC spec</a>.</p>
<div class="section" id="module-level-functions">
<h2>Module-level Functions<a class="headerlink" href="#module-level-functions" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="liblo.send">
<code class="descname">send</code><span class="sig-paren">(</span><em>target</em>, <em>*messages</em><span class="sig-paren">)</span><a class="headerlink" href="#liblo.send" title="Permalink to this definition">¶</a></dt>
<dt>
<code class="descname">send</code><span class="sig-paren">(</span><em>target</em>, <em>path</em>, <em>*args</em><span class="sig-paren">)</span></dt>
<dd><p>Send messages to the the given target, without requiring a server.
Arguments may be one or more <a class="reference internal" href="#liblo.Message" title="liblo.Message"><code class="xref py py-class docutils literal"><span class="pre">Message</span></code></a> or <a class="reference internal" href="#liblo.Bundle" title="liblo.Bundle"><code class="xref py py-class docutils literal"><span class="pre">Bundle</span></code></a> objects,
or a single message given by its path and optional arguments.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>target</strong> – the address to send the message to; an <a class="reference internal" href="#liblo.Address" title="liblo.Address"><code class="xref py py-class docutils literal"><span class="pre">Address</span></code></a> object,
a port number, a <code class="docutils literal"><span class="pre">(hostname,</span> <span class="pre">port)</span></code> tuple, or a URL.</li>
<li><strong>messages</strong> – one or more objects of type <a class="reference internal" href="#liblo.Message" title="liblo.Message"><code class="xref py py-class docutils literal"><span class="pre">Message</span></code></a> or <a class="reference internal" href="#liblo.Bundle" title="liblo.Bundle"><code class="xref py py-class docutils literal"><span class="pre">Bundle</span></code></a>.</li>
<li><strong>path</strong> – the path of the message to be sent.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>AddressError</strong> – if the given target is invalid.</li>
<li><strong>IOError</strong> – if the message couldn’t be sent.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="liblo.time">
<code class="descname">time</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#liblo.time" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the current time as a floating point number (seconds since
January 1, 1900).</p>
</dd></dl>
</div>
<div class="section" id="osc-server-classes">
<h2>OSC Server Classes<a class="headerlink" href="#osc-server-classes" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="liblo.Server">
<em class="property">class </em><code class="descname">Server</code><a class="headerlink" href="#liblo.Server" title="Permalink to this definition">¶</a></dt>
<dd><p>A server that can receive OSC messages using a simple single-threaded
polling model.
Use <a class="reference internal" href="#liblo.ServerThread" title="liblo.ServerThread"><code class="xref py py-class docutils literal"><span class="pre">ServerThread</span></code></a> for an OSC server that runs in its own thread
and never blocks.</p>
<dl class="method">
<dt id="liblo.Server.Server">
<code class="descname">Server</code><span class="sig-paren">(</span><em>port</em><span class="optional">[</span>, <em>proto</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#liblo.Server.Server" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new <code class="xref py py-class docutils literal"><span class="pre">Server</span></code> object.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>port</strong> – a decimal port number or a UNIX socket path. If omitted, an
arbitrary free UDP port will be used.</li>
<li><strong>proto</strong> – one of the constants <code class="xref py py-const docutils literal"><span class="pre">UDP</span></code>, <code class="xref py py-const docutils literal"><span class="pre">TCP</span></code>, or <code class="xref py py-const docutils literal"><span class="pre">UNIX</span></code>;
default is <code class="xref py py-const docutils literal"><span class="pre">UDP</span></code>.</li>
<li><strong>reg_methods</strong> – <code class="docutils literal"><span class="pre">False</span></code> if you don’t want the init function to automatically
register callbacks defined with the <a class="reference internal" href="#liblo.make_method" title="liblo.make_method"><code class="xref py py-func docutils literal"><span class="pre">make_method()</span></code></a> decorator
(keyword argument only).</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Exceptions: ServerError</p>
</dd></dl>
<dl class="method">
<dt id="liblo.Server.recv">
<code class="descname">recv</code><span class="sig-paren">(</span><em>timeout=None</em><span class="sig-paren">)</span><a class="headerlink" href="#liblo.Server.recv" title="Permalink to this definition">¶</a></dt>
<dd><p>Receive and dispatch one OSC message. Blocking by default, unless
<em>timeout</em> is specified.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>timeout</strong> – Time in milliseconds after which the function returns if no
messages have been received.
<em>timeout</em> may be 0, in which case the function always returns
immediately, whether messages have been received or not.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="docutils literal"><span class="pre">True</span></code> if a message was received, otherwise <code class="docutils literal"><span class="pre">False</span></code>.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="liblo.Server.send">
<code class="descname">send</code><span class="sig-paren">(</span><em>target</em>, <em>*messages</em><span class="sig-paren">)</span><a class="headerlink" href="#liblo.Server.send" title="Permalink to this definition">¶</a></dt>
<dt>
<code class="descname">send</code><span class="sig-paren">(</span><em>target</em>, <em>path</em>, <em>*args</em><span class="sig-paren">)</span></dt>
<dd><p>Send a message or bundle from this server to the the given target.
Arguments may be one or more <a class="reference internal" href="#liblo.Message" title="liblo.Message"><code class="xref py py-class docutils literal"><span class="pre">Message</span></code></a> or <a class="reference internal" href="#liblo.Bundle" title="liblo.Bundle"><code class="xref py py-class docutils literal"><span class="pre">Bundle</span></code></a>
objects, or a single message given by its path and optional arguments.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>target</strong> – the address to send the message to; an <a class="reference internal" href="#liblo.Address" title="liblo.Address"><code class="xref py py-class docutils literal"><span class="pre">Address</span></code></a> object,
a port number, a <code class="docutils literal"><span class="pre">(hostname,</span> <span class="pre">port)</span></code> tuple, or a URL.</li>
<li><strong>messages</strong> – one or more objects of type <a class="reference internal" href="#liblo.Message" title="liblo.Message"><code class="xref py py-class docutils literal"><span class="pre">Message</span></code></a> or <a class="reference internal" href="#liblo.Bundle" title="liblo.Bundle"><code class="xref py py-class docutils literal"><span class="pre">Bundle</span></code></a>.</li>
<li><strong>path</strong> – the path of the message to be sent.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>AddressError</strong> – if the given target is invalid.</li>
<li><strong>IOError</strong> – if the message couldn’t be sent.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="liblo.Server.add_method">
<code class="descname">add_method</code><span class="sig-paren">(</span><em>path</em>, <em>typespec</em>, <em>func</em>, <em>user_data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#liblo.Server.add_method" title="Permalink to this definition">¶</a></dt>
<dd><p>Register a callback function for OSC messages with matching path and
argument types.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>path</strong> – the message path to be handled by the registered method.
<code class="docutils literal"><span class="pre">None</span></code> may be used as a wildcard to match any OSC message.</li>
<li><strong>typespec</strong> – the argument types to be handled by the registered method.
<code class="docutils literal"><span class="pre">None</span></code> may be used as a wildcard to match any OSC message.</li>
<li><strong>func</strong> – the callback function. This may be a global function, a class
method, or any other callable object, pyliblo will know what
to do either way.</li>
<li><strong>user_data</strong> – An arbitrary object that will be passed on to <em>func</em> every time
a matching message is received.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="liblo.Server.del_method">
<code class="descname">del_method</code><span class="sig-paren">(</span><em>path</em>, <em>typespec</em><span class="sig-paren">)</span><a class="headerlink" href="#liblo.Server.del_method" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a callback function. For both <em>path</em> and <em>typespec</em>, <code class="docutils literal"><span class="pre">None</span></code>
may be used as a wildcard.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.9.2.</span></p>
</div>
</dd></dl>
<dl class="method">
<dt id="liblo.Server.register_methods">
<code class="descname">register_methods</code><span class="sig-paren">(</span><em>obj=None</em><span class="sig-paren">)</span><a class="headerlink" href="#liblo.Server.register_methods" title="Permalink to this definition">¶</a></dt>
<dd><p>Call <a class="reference internal" href="#liblo.Server.add_method" title="liblo.Server.add_method"><code class="xref py py-meth docutils literal"><span class="pre">add_method()</span></code></a> for all methods of an object that are
decorated with <a class="reference internal" href="#liblo.make_method" title="liblo.make_method"><code class="xref py py-func docutils literal"><span class="pre">make_method()</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>obj</strong> – The object that implements the OSC callbacks to be registered.
By default this is the server object itself.</td>
</tr>
</tbody>
</table>
<p>This function is usually called automatically by the server’s
constructor, unless its <em>reg_methods</em> parameter was set to <code class="docutils literal"><span class="pre">False</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="liblo.Server.add_bundle_handlers">
<code class="descname">add_bundle_handlers</code><span class="sig-paren">(</span><em>start_handler</em>, <em>end_handler</em>, <em>user_data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#liblo.Server.add_bundle_handlers" title="Permalink to this definition">¶</a></dt>
<dd><p>Add bundle notification handlers.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>start_handler</strong> – a callback which fires when at the start of a bundle. This is
called with the bundle’s timestamp and user_data.</li>
<li><strong>end_handler</strong> – a callback which fires when at the end of a bundle. This is called
with user_data.</li>
<li><strong>user_data</strong> – data to pass to the handlers.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.10.0.</span></p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="liblo.Server.url">
<code class="descname">url</code><a class="headerlink" href="#liblo.Server.url" title="Permalink to this definition">¶</a></dt>
<dd><p>The server’s URL.</p>
</dd></dl>
<dl class="attribute">
<dt id="liblo.Server.port">
<code class="descname">port</code><a class="headerlink" href="#liblo.Server.port" title="Permalink to this definition">¶</a></dt>
<dd><p>The server’s port number.</p>
</dd></dl>
<dl class="attribute">
<dt id="liblo.Server.protocol">
<code class="descname">protocol</code><a class="headerlink" href="#liblo.Server.protocol" title="Permalink to this definition">¶</a></dt>
<dd><p>The server’s protocol (one of the constants <code class="xref py py-const docutils literal"><span class="pre">UDP</span></code>,
<code class="xref py py-const docutils literal"><span class="pre">TCP</span></code>, or <code class="xref py py-const docutils literal"><span class="pre">UNIX</span></code>).</p>
</dd></dl>
<dl class="method">
<dt id="liblo.Server.fileno">
<code class="descname">fileno</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#liblo.Server.fileno" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the file descriptor of the server socket, or -1 if not
supported by the underlying server protocol.</p>
</dd></dl>
<dl class="method">
<dt id="liblo.Server.free">
<code class="descname">free</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#liblo.Server.free" title="Permalink to this definition">¶</a></dt>
<dd><p>Free the underlying server object and close its port. Note that this
will also happen automatically when the server is deallocated.</p>
</dd></dl>
</dd></dl>
<hr class="docutils" />
<dl class="class">
<dt id="liblo.ServerThread">
<em class="property">class </em><code class="descname">ServerThread</code><a class="headerlink" href="#liblo.ServerThread" title="Permalink to this definition">¶</a></dt>
<dd><p>Unlike <a class="reference internal" href="#liblo.Server" title="liblo.Server"><code class="xref py py-class docutils literal"><span class="pre">Server</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">ServerThread</span></code> uses its own thread which
runs in the background to dispatch messages.
<code class="xref py py-class docutils literal"><span class="pre">ServerThread</span></code> has the same methods as <code class="xref py py-class docutils literal"><span class="pre">Server</span></code>, with the
exception of <a class="reference internal" href="#liblo.Server.recv" title="liblo.Server.recv"><code class="xref py py-meth docutils literal"><span class="pre">Server.recv()</span></code></a>. Instead, it defines two additional
methods <a class="reference internal" href="#liblo.ServerThread.start" title="liblo.ServerThread.start"><code class="xref py py-meth docutils literal"><span class="pre">start()</span></code></a> and <a class="reference internal" href="#liblo.ServerThread.stop" title="liblo.ServerThread.stop"><code class="xref py py-meth docutils literal"><span class="pre">stop()</span></code></a>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Because liblo creates its own thread to receive and dispatch
messages, callback functions will not be run in the main Python
thread!</p>
</div>
<dl class="method">
<dt id="liblo.ServerThread.ServerThread">
<code class="descname">ServerThread</code><span class="sig-paren">(</span><em>port</em><span class="optional">[</span>, <em>proto</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#liblo.ServerThread.ServerThread" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new <code class="xref py py-class docutils literal"><span class="pre">ServerThread</span></code> object, which can receive OSC messages.
Unlike <a class="reference internal" href="#liblo.Server" title="liblo.Server"><code class="xref py py-class docutils literal"><span class="pre">Server</span></code></a>, <a class="reference internal" href="#liblo.ServerThread" title="liblo.ServerThread"><code class="xref py py-class docutils literal"><span class="pre">ServerThread</span></code></a> uses its own thread which
runs in the background to dispatch messages. Note that callback methods
will not be run in the main Python thread!</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>port</strong> – a decimal port number or a UNIX socket path. If omitted, an
arbitrary free UDP port will be used.</li>
<li><strong>proto</strong> – one of the constants <code class="xref py py-const docutils literal"><span class="pre">UDP</span></code>, <code class="xref py py-const docutils literal"><span class="pre">TCP</span></code>, or <code class="xref py py-const docutils literal"><span class="pre">UNIX</span></code>;
default is <code class="xref py py-const docutils literal"><span class="pre">UDP</span></code>.</li>
<li><strong>reg_methods</strong> – <code class="docutils literal"><span class="pre">False</span></code> if you don’t want the init function to automatically
register callbacks defined with the make_method decorator
(keyword argument only).</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>ServerError</strong> – if creating the server fails, e.g. because the given port could not
be opened.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="liblo.ServerThread.start">
<code class="descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#liblo.ServerThread.start" title="Permalink to this definition">¶</a></dt>
<dd><p>Start the server thread. liblo will now start to dispatch any messages
it receives.</p>
</dd></dl>
<dl class="method">
<dt id="liblo.ServerThread.stop">
<code class="descname">stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#liblo.ServerThread.stop" title="Permalink to this definition">¶</a></dt>
<dd><p>Stop the server thread.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="liblo.make_method">
<em class="property">class </em><code class="descname">make_method</code><a class="headerlink" href="#liblo.make_method" title="Permalink to this definition">¶</a></dt>
<dd><p>A decorator that serves as a more convenient alternative to
<a class="reference internal" href="#liblo.Server.add_method" title="liblo.Server.add_method"><code class="xref py py-meth docutils literal"><span class="pre">Server.add_method()</span></code></a>.</p>
<dl class="method">
<dt id="liblo.make_method.make_method">
<code class="descname">make_method</code><span class="sig-paren">(</span><em>path</em>, <em>typespec</em><span class="optional">[</span>, <em>user_data</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#liblo.make_method.make_method" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the path and argument types for which the decorated method
is to be registered.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>path</strong> – the message path to be handled by the registered method.
<code class="docutils literal"><span class="pre">None</span></code> may be used as a wildcard to match any OSC message.</li>
<li><strong>typespec</strong> – the argument types to be handled by the registered method.
<code class="docutils literal"><span class="pre">None</span></code> may be used as a wildcard to match any OSC message.</li>
<li><strong>user_data</strong> – An arbitrary object that will be passed on to the decorated
method every time a matching message is received.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="utility-classes">
<h2>Utility Classes<a class="headerlink" href="#utility-classes" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="liblo.Address">
<em class="property">class </em><code class="descname">Address</code><a class="headerlink" href="#liblo.Address" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="liblo.Address.Address">
<code class="descname">Address</code><span class="sig-paren">(</span><em>hostname</em>, <em>port</em><span class="optional">[</span>, <em>proto</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#liblo.Address.Address" title="Permalink to this definition">¶</a></dt>
<dt>
<code class="descname">Address</code><span class="sig-paren">(</span><em>port</em><span class="sig-paren">)</span></dt>
<dt>
<code class="descname">Address</code><span class="sig-paren">(</span><em>url</em><span class="sig-paren">)</span></dt>
<dd><p>Create a new <code class="xref py py-class docutils literal"><span class="pre">Address</span></code> object from the given hostname/port
or URL.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>hostname</strong> – the target’s hostname.</li>
<li><strong>port</strong> – the port number on the target.</li>
<li><strong>proto</strong> – one of the constants <code class="xref py py-const docutils literal"><span class="pre">UDP</span></code>, <code class="xref py py-const docutils literal"><span class="pre">TCP</span></code>, or <code class="xref py py-const docutils literal"><span class="pre">UNIX</span></code>.</li>
<li><strong>url</strong> – a URL in liblo notation, e.g. <code class="docutils literal"><span class="pre">'osc.udp://hostname:1234/'</span></code>.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>AddressError</strong> – if the given parameters do not represent a valid address.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="liblo.Address.url">
<code class="descname">url</code><a class="headerlink" href="#liblo.Address.url" title="Permalink to this definition">¶</a></dt>
<dd><p>The address’s URL.</p>
</dd></dl>
<dl class="attribute">
<dt id="liblo.Address.hostname">
<code class="descname">hostname</code><a class="headerlink" href="#liblo.Address.hostname" title="Permalink to this definition">¶</a></dt>
<dd><p>The address’s hostname.</p>
</dd></dl>
<dl class="attribute">
<dt id="liblo.Address.port">
<code class="descname">port</code><a class="headerlink" href="#liblo.Address.port" title="Permalink to this definition">¶</a></dt>
<dd><p>The address’s port number.</p>
</dd></dl>
<dl class="attribute">
<dt id="liblo.Address.protocol">
<code class="descname">protocol</code><a class="headerlink" href="#liblo.Address.protocol" title="Permalink to this definition">¶</a></dt>
<dd><p>The address’s protocol (one of the constants <code class="xref py py-const docutils literal"><span class="pre">UDP</span></code>,
<code class="xref py py-const docutils literal"><span class="pre">TCP</span></code>, or <code class="xref py py-const docutils literal"><span class="pre">UNIX</span></code>).</p>
</dd></dl>
</dd></dl>
<hr class="docutils" />
<dl class="class">
<dt id="liblo.Message">
<em class="property">class </em><code class="descname">Message</code><a class="headerlink" href="#liblo.Message" title="Permalink to this definition">¶</a></dt>
<dd><p>An OSC message, consisting of a path and arbitrary arguments.</p>
<dl class="method">
<dt id="liblo.Message.Message">
<code class="descname">Message</code><span class="sig-paren">(</span><em>path</em>, <em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#liblo.Message.Message" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new <code class="xref py py-class docutils literal"><span class="pre">Message</span></code> object.</p>
</dd></dl>
<dl class="method">
<dt id="liblo.Message.add">
<code class="descname">add</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#liblo.Message.add" title="Permalink to this definition">¶</a></dt>
<dd><p>Append the given arguments to the message.
Arguments can be single values or <code class="docutils literal"><span class="pre">(typetag,</span> <span class="pre">data)</span></code> tuples.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="liblo.Bundle">
<em class="property">class </em><code class="descname">Bundle</code><a class="headerlink" href="#liblo.Bundle" title="Permalink to this definition">¶</a></dt>
<dd><p>A bundle of one or more messages to be sent and dispatched together.</p>
<dl class="method">
<dt id="liblo.Bundle.Bundle">
<code class="descname">Bundle</code><span class="sig-paren">(</span><span class="optional">[</span><em>timetag</em>, <span class="optional">]</span><em>*messages</em><span class="sig-paren">)</span><a class="headerlink" href="#liblo.Bundle.Bundle" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new <a class="reference internal" href="#liblo.Bundle" title="liblo.Bundle"><code class="xref py py-class docutils literal"><span class="pre">Bundle</span></code></a> object. You can optionally specify a
time at which the messages should be dispatched (as an OSC timetag
float), and any number of messages to be included in the bundle.</p>
</dd></dl>
<dl class="method">
<dt id="liblo.Bundle.add">
<code class="descname">add</code><span class="sig-paren">(</span><em>*messages</em><span class="sig-paren">)</span><a class="headerlink" href="#liblo.Bundle.add" title="Permalink to this definition">¶</a></dt>
<dt>
<code class="descname">add</code><span class="sig-paren">(</span><em>path</em>, <em>*args</em><span class="sig-paren">)</span></dt>
<dd><p>Add one or more messages to the bundle.</p>
</dd></dl>
</dd></dl>
<hr class="docutils" />
<dl class="exception">
<dt id="liblo.ServerError">
<em class="property">exception </em><code class="descname">ServerError</code><a class="headerlink" href="#liblo.ServerError" title="Permalink to this definition">¶</a></dt>
<dd><p>Raised when creating a liblo OSC server fails.</p>
</dd></dl>
<dl class="exception">
<dt id="liblo.AddressError">
<em class="property">exception </em><code class="descname">AddressError</code><a class="headerlink" href="#liblo.AddressError" title="Permalink to this definition">¶</a></dt>
<dd><p>Raised when trying to create an invalid <a class="reference internal" href="#liblo.Address" title="liblo.Address"><code class="xref py py-class docutils literal"><span class="pre">Address</span></code></a> object.</p>
</dd></dl>
</div>
<div class="section" id="mapping-between-osc-and-python-data-types">
<h2>Mapping between OSC and Python data types<a class="headerlink" href="#mapping-between-osc-and-python-data-types" title="Permalink to this headline">¶</a></h2>
<p>When constructing a message, pyliblo automatically converts
arguments to an appropriate OSC data type.
To explicitly specify the OSC data type to be transmitted, pass a
<code class="docutils literal"><span class="pre">(typetag,</span> <span class="pre">data)</span></code> tuple instead. Some types can’t be unambiguously
recognized, so they can only be sent that way.</p>
<p>The mapping between OSC and Python data types is shown in the following table:</p>
<table border="1" class="docutils">
<colgroup>
<col width="9%" />
<col width="15%" />
<col width="76%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">typetag</th>
<th class="head">OSC data type</th>
<th class="head">Python data type</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'i'</span></code></td>
<td>int32</td>
<td><code class="xref py py-class docutils literal"><span class="pre">int</span></code></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'h'</span></code></td>
<td>int64</td>
<td><code class="xref py py-class docutils literal"><span class="pre">long</span></code> (Python 2.x), <code class="xref py py-class docutils literal"><span class="pre">int</span></code> (Python 3.x)</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'f'</span></code></td>
<td>float</td>
<td><code class="xref py py-class docutils literal"><span class="pre">float</span></code></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'d'</span></code></td>
<td>double</td>
<td><code class="xref py py-class docutils literal"><span class="pre">float</span></code></td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'c'</span></code></td>
<td>char</td>
<td><code class="xref py py-class docutils literal"><span class="pre">str</span></code> (single character)</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'s'</span></code></td>
<td>string</td>
<td><code class="xref py py-class docutils literal"><span class="pre">str</span></code></td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'S'</span></code></td>
<td>symbol</td>
<td><code class="xref py py-class docutils literal"><span class="pre">str</span></code></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'m'</span></code></td>
<td>midi</td>
<td><code class="xref py py-class docutils literal"><span class="pre">tuple</span></code> of four <code class="xref py py-class docutils literal"><span class="pre">int</span></code>s</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'t'</span></code></td>
<td>timetag</td>
<td><code class="xref py py-class docutils literal"><span class="pre">float</span></code></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'T'</span></code></td>
<td>true</td>
<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'F'</span></code></td>
<td>false</td>
<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'N'</span></code></td>
<td>nil</td>
<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">'I'</span></code></td>
<td>infinitum</td>
<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'b'</span></code></td>
<td>blob</td>
<td><code class="xref py py-class docutils literal"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal"><span class="pre">int</span></code>s (Python 2.x), <code class="xref py py-class docutils literal"><span class="pre">bytes</span></code> (Python 3.x)</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">pyliblo 0.10 API Documentation</a><ul>
<li><a class="reference internal" href="#module-level-functions">Module-level Functions</a></li>
<li><a class="reference internal" href="#osc-server-classes">OSC Server Classes</a></li>
<li><a class="reference internal" href="#utility-classes">Utility Classes</a></li>
<li><a class="reference internal" href="#mapping-between-osc-and-python-data-types">Mapping between OSC and Python data types</a></li>
</ul>
</li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="#">pyliblo documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2007-2017, Dominic Sacré.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.9.
</div>
</body>
</html>
|