File: chap6.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 (70 lines) | stat: -rw-r--r-- 2,328 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
<?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 node controller</title>
  <para>
    The <command>/node</command> context path returns the value assigned to node. The response type
    tag matches the port value type held.
  </para>

  <sect1>
    <title>Type tag and parameters</title>
    <para>
      The type tag of the request looks like following: <parameter class="command">,s</parameter>.
    </para>

    <table border="1">
      <caption>Type tag description</caption>
      <tgroup cols="3" align="left" colsep="1" rowsep="1">
	<colspec colnum="1" colname="col1" colwidth="1*"/>
	<colspec colnum="2" colname="col2" colwidth="1*"/>
	<colspec colnum="3" colname="col3" colwidth="3*"/>
	<thead>
	  <row>
	    <entry>index</entry>
	    <entry>type indentifier</entry>
            <entry>value</entry>
	  </row>
	</thead>
	<tbody>
	  <row>
	    <entry>#0</entry>
	    <entry>s</entry>
            <entry>Path is any valid accessor for properties or port value.</entry>
	  </row>
	</tbody>
      </tgroup>
    </table>

    <para>
      The path supports indices, ranges, wildcard or some even names as accessors. This 2 examples shows you
      the access to an AgsAudio port and AgsChannel:
    </para>

    <itemizedlist>
      <listitem>
	/AgsSoundProvider/AgsAudio[0]/AgsMuteAudio[0]/AgsPort["./muted[0]"]:value
      </listitem>
      <listitem>
	/AgsSoundProvider/AgsAudio[0]/AgsInput[0]/AgsVolumeChannel[0]/AgsPort["./volume[0]"]:value
      </listitem>
    </itemizedlist>

    <para>
      The response contains as first argument of the type the tag the matching path. Followed by type or array
      of types requested. The requested value follows the path argument.
    </para>
  </sect1>
</chapter>