File: chap1.xml

package info (click to toggle)
gsequencer 7.7.5-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 71,040 kB
  • sloc: ansic: 1,145,949; xml: 31,016; cpp: 9,487; sh: 5,798; makefile: 3,845; perl: 155; sed: 16; python: 11
file content (81 lines) | stat: -rw-r--r-- 2,794 bytes parent folder | download | duplicates (2)
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
<?xml version='1.0' encoding="utf-8"?>
<!DOCTYPE chapter
[
<!ENTITY ags "Advanced Gtk+ Sequencer">
]>

<!-- Copyright (C) 2005-2018 Jo\u00EBl Kr\u00E4hemann -->
<!-- Permission is granted to copy, distribute and/or modify this document -->
<!-- under the terms of the GNU Free Documentation License, Version 1.3 -->
<!-- or any later version published by the Free Software Foundation; -->
<!-- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. -->
<!-- A copy of the license is included in the section entitled "GNU -->
<!-- Free Documentation License". -->

<chapter xmlns="http://docbook.org/ns/docbook" version="5.0">
  <title>The &ags; OSC server</title>
  <para>
    The OSC server implementation supports connections by UDP/TCP over IPv4 and IPv6. There are
    different server paths available. Each context path handled by its own OSC controller.
  </para>

  <sect1>
    <title>Context paths</title>
    <para>
      The context path is the address pattern of your OSC message. Every OSC message passes the front
      controller. Then it is scheduled and delegated to the matching controller. The OSC timetag specifies
      at what time the message should be dispatched. The OSC timetag is taken from your OSC bundle.
    </para>
    
    <para>
      Addressing nodes can be done by using ranges or wildcard. The context path matches the first
      string of your type tag. The common prefix is <literal>/AgsSoundProvider</literal>
      for accessing the audio layer of GSequencer.
    </para>

    <table border="1">
      <caption>OSC server context paths</caption>
      <tgroup cols="2" align="left" colsep="1" rowsep="1">
	<colspec colnum="1" colname="col1" colwidth="2*"/>
	<colspec colnum="2" colname="col2" colwidth="3*"/>
	<thead>
	  <row>
	    <entry>Context path</entry>
            <entry>description</entry>
	  </row>
	</thead>
	<tbody>
	  <row>
	    <entry><command>/info</command></entry>
            <entry>Provides OSC server identifier</entry>
	  </row>
	  <row>
	    <entry><command>/status</command></entry>
            <entry>Rerowieve OSC server status</entry>
	  </row>
	  <row>
	    <entry><command>/config</command></entry>
            <entry>Configure the GSequencer engine</entry>
	  </row>
	  <row>
	    <entry><command>/action</command></entry>
            <entry>Run tasks specified by action</entry>
	  </row>
	  <row>
	    <entry><command>/node</command></entry>
            <entry>Read values of nodes</entry>
	  </row>
	  <row>
	    <entry><command>/renew</command></entry>
            <entry>Modify values of nodes</entry>
	  </row>
	  <row>
	    <entry><command>/meter</command></entry>
            <entry>Continuing update meter values</entry>
	  </row>
	</tbody>
      </tgroup>
    </table>
  </sect1>
  
</chapter>