File: BtSongIONativeBZT.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 (226 lines) | stat: -rw-r--r-- 11,128 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
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
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BtSongIONativeBZT: 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="ch04.html" title="Song IO Reference">
<link rel="prev" href="BtSongIONative.html" title="BtSongIONative">
<link rel="next" href="BtSongIONativeXML.html" title="BtSongIONativeXML">
<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="#BtSongIONativeBZT.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#BtSongIONativeBZT.object-hierarchy" class="shortcut">Object Hierarchy</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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="BtSongIONative.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="BtSongIONativeXML.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="BtSongIONativeBZT"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="BtSongIONativeBZT.top_of_page"></a>BtSongIONativeBZT</span></h2>
<p>BtSongIONativeBZT — class for song input and output in builtin native format</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="BtSongIONativeBZT.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="BtSongIONativeBZT.html#bt-song-io-native-bzt-copy-from-uri" title="bt_song_io_native_bzt_copy_from_uri ()">bt_song_io_native_bzt_copy_from_uri</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="BtSongIONativeBZT.html#bt-song-io-native-bzt-copy-to-fd" title="bt_song_io_native_bzt_copy_to_fd ()">bt_song_io_native_bzt_copy_to_fd</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtSongIONativeBZT.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="BtSongIONativeBZT.html#BtSongIONativeBZT-struct" title="struct BtSongIONativeBZT">BtSongIONativeBZT</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="BtSongIONativeBZT.html#BtSongIONativeBZTClass" title="struct BtSongIONativeBZTClass">BtSongIONativeBZTClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtSongIONativeBZT.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> <a class="link" href="BtSongIO.html" title="BtSongIO">BtSongIO</a>
        <span class="lineart">╰──</span> <a class="link" href="BtSongIONative.html" title="BtSongIONative">BtSongIONative</a>
            <span class="lineart">╰──</span> BtSongIONativeBZT
</pre>
</div>
<div class="refsect1">
<a name="BtSongIONativeBZT.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libbtcore/core.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="BtSongIONativeBZT.description"></a><h2>Description</h2>
<p>This internal <a class="link" href="BtSongIONative.html" title="BtSongIONative"><span class="type">BtSongIONative</span></a> module implements loading and saving of an own
xml format with externals.
The format is an archive, that contains an XML file and optionally binary
data, such as audio samples.</p>
</div>
<div class="refsect1">
<a name="BtSongIONativeBZT.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="bt-song-io-native-bzt-copy-from-uri"></a><h3>bt_song_io_native_bzt_copy_from_uri ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
bt_song_io_native_bzt_copy_from_uri (<em class="parameter"><code>const <a class="link" href="BtSongIONativeBZT.html" title="BtSongIONativeBZT"><span class="type">BtSongIONativeBZT</span></a> * const self</code></em>,
                                     <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file_name</code></em>,
                                     <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>);</pre>
<p>Copies the file specified by <em class="parameter"><code>uri</code></em>
 to <em class="parameter"><code>file_name</code></em>
 into the song file.</p>
<p>This is a helper for <a class="link" href="BtSong.html" title="BtSong"><span class="type">BtSong</span></a> persistence.</p>
<div class="refsect3">
<a name="id-1.4.5.4.8.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the song-plugin</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file_name</p></td>
<td class="parameter_description"><p>the path to the file inside the song</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>location of the source file</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.5.4.8.2.7"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bt-song-io-native-bzt-copy-to-fd"></a><h3>bt_song_io_native_bzt_copy_to_fd ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
bt_song_io_native_bzt_copy_to_fd (<em class="parameter"><code>const <a class="link" href="BtSongIONativeBZT.html" title="BtSongIONativeBZT"><span class="type">BtSongIONativeBZT</span></a> * const self</code></em>,
                                  <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file_name</code></em>,
                                  <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a> fd</code></em>);</pre>
<p>Copies the file specified by <em class="parameter"><code>file_name</code></em>
 from the song file to the <em class="parameter"><code>fd</code></em>
.</p>
<p>This is a helper for <a class="link" href="BtSong.html" title="BtSong"><span class="type">BtSong</span></a> persistence.</p>
<div class="refsect3">
<a name="id-1.4.5.4.8.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the song-plugin</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file_name</p></td>
<td class="parameter_description"><p>the path to the file inside the song</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fd</p></td>
<td class="parameter_description"><p>a file-descriptor of an opened file to copy <em class="parameter"><code>file_name</code></em>
to</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.5.4.8.3.7"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="BtSongIONativeBZT.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="BtSongIONativeBZT-struct"></a><h3>struct BtSongIONativeBZT</h3>
<pre class="programlisting">struct BtSongIONativeBZT;</pre>
<p>object for song input and output in native zip/xml format</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSongIONativeBZTClass"></a><h3>struct BtSongIONativeBZTClass</h3>
<pre class="programlisting">struct BtSongIONativeBZTClass {
  const BtSongIONativeClass parent;
};
</pre>
<p>Class for song input and output in native zip/xml format</p>
<div class="refsect3">
<a name="id-1.4.5.4.9.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p>const <a class="link" href="BtSongIONative.html#BtSongIONativeClass" title="struct BtSongIONativeClass"><span class="type">BtSongIONativeClass</span></a> <em class="structfield"><code><a name="BtSongIONativeBZTClass.parent"></a>parent</code></em>;</p></td>
<td class="struct_member_description"><p>parent class type</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>