File: BtApplication.html

package info (click to toggle)
buzztrax 0.10.2-10
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 19,984 kB
  • sloc: ansic: 109,707; sh: 12,875; cpp: 10,882; xml: 6,081; makefile: 508; javascript: 338; asm: 116
file content (147 lines) | stat: -rw-r--r-- 8,068 bytes parent folder | download | duplicates (6)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BtApplication: Buzztrax Bt-Core Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Buzztrax Bt-Core Reference Manual">
<link rel="up" href="ch02.html" title="Core Class Reference">
<link rel="prev" href="buzztrax-core-libbtcore.html" title="libbtcore">
<link rel="next" href="BtAudioSession.html" title="BtAudioSession">
<meta name="generator" content="GTK-Doc V1.24.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#BtApplication.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#BtApplication.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#BtApplication.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="buzztrax-core-libbtcore.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="BtAudioSession.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="BtApplication"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="BtApplication.top_of_page"></a>BtApplication</span></h2>
<p>BtApplication — base class for a buzztrax based application</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="BtApplication.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/gstreamer-1.0GstBin.html#GstBin-struct"><span class="type">GstBin</span></a> *</td>
<td class="property_name"><a class="link" href="BtApplication.html#BtApplication--bin" title="The “bin” property">bin</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="BtSettings.html" title="BtSettings"><span class="type">BtSettings</span></a> *</td>
<td class="property_name"><a class="link" href="BtApplication.html#BtApplication--settings" title="The “settings” property">settings</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtApplication.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="BtApplication.html#BtApplication-struct" title="struct BtApplication">BtApplication</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtApplication.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> BtApplication
</pre>
</div>
<div class="refsect1">
<a name="BtApplication.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libbtcore/core.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="BtApplication.description"></a><h2>Description</h2>
<p>Every application using the libbtcore library should inherit from this class.
Implementations should implement the singleton pattern.</p>
<p>The base class automatically creates a <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstBin.html#GstBin-struct"><span class="type">GstBin</span></a> element as a container for the
song. This can be retrieved via the <a class="link" href="BtApplication.html#BtApplication--bin" title="The “bin” property"><span class="type">“bin”</span></a> property.
When creating <a class="link" href="BtSong.html" title="BtSong"><span class="type">BtSong</span></a> instances, the <a class="link" href="BtApplication.html" title="BtApplication"><span class="type">BtApplication</span></a> instance needs to be
passed to the <a class="link" href="BtSong.html#bt-song-new" title="bt_song_new ()"><code class="function">bt_song_new()</code></a> constructor, so that it can retrieve the <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstBin.html#GstBin-struct"><span class="type">GstBin</span></a>
element.</p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="usertype">BtApplication</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">app</span><span class="symbol">;</span>
<span class="usertype">BtSong</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">song</span><span class="symbol">;</span>
<span class="symbol">...</span>
<span class="normal">song</span><span class="symbol">=</span><span class="function"><a href="../html/BtSong.html#bt-song-new">bt_song_new</a></span><span class="symbol">(</span><span class="normal">app</span><span class="symbol">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
<p>Another module the application base class maintains is a settings instance (see
<a class="link" href="BtSettings.html" title="BtSettings"><span class="type">BtSettings</span></a>), that manages application preferences.</p>
</div>
<div class="refsect1">
<a name="BtApplication.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="BtApplication.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="BtApplication-struct"></a><h3>struct BtApplication</h3>
<pre class="programlisting">struct BtApplication;</pre>
<p>base object for a buzztrax based application</p>
</div>
</div>
<div class="refsect1">
<a name="BtApplication.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="BtApplication--bin"></a><h3>The <code class="literal">“bin”</code> property</h3>
<pre class="programlisting">  “bin”                      <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstBin.html#GstBin-struct"><span class="type">GstBin</span></a> *</pre>
<p>The top-level gstreamer element for the song, e.g. a <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstPipeline.html#GstPipeline-struct"><span class="type">GstPipeline</span></a> or
<a href="/usr/share/gtk-doc/html/gstreamer-1.0GstBin.html#GstBin-struct"><span class="type">GstBin</span></a>.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="BtApplication--settings"></a><h3>The <code class="literal">“settings”</code> property</h3>
<pre class="programlisting">  “settings”                 <a class="link" href="BtSettings.html" title="BtSettings"><span class="type">BtSettings</span></a> *</pre>
<p>applications configuration settings.</p>
<p>Flags: Read</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>