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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BtSong: 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="ch03.html" title="Song Class Reference">
<link rel="prev" href="BtSinkMachine.html" title="BtSinkMachine">
<link rel="next" href="BtSongInfo.html" title="BtSongInfo">
<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="#BtSong.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#BtSong.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#BtSong.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#BtSong.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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="BtSinkMachine.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="BtSongInfo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="BtSong"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="BtSong.top_of_page"></a>BtSong</span></h2>
<p>BtSong — class of a song project object (contains <a class="link" href="BtSongInfo.html" title="BtSongInfo"><span class="type">BtSongInfo</span></a>,
<a class="link" href="BtSetup.html" title="BtSetup"><span class="type">BtSetup</span></a>, <a class="link" href="BtSequence.html" title="BtSequence"><span class="type">BtSequence</span></a> and <a class="link" href="BtWavetable.html" title="BtWavetable"><span class="type">BtWavetable</span></a>)</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="BtSong.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="BtSong.html#bt-song-continue" title="bt_song_continue ()">bt_song_continue</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="BtSong.html" title="BtSong"><span class="returnvalue">BtSong</span></a> *
</td>
<td class="function_name">
<a class="link" href="BtSong.html#bt-song-new" title="bt_song_new ()">bt_song_new</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="BtSong.html#bt-song-pause" title="bt_song_pause ()">bt_song_pause</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="BtSong.html#bt-song-play" title="bt_song_play ()">bt_song_play</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="BtSong.html#bt-song-stop" title="bt_song_stop ()">bt_song_stop</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="BtSong.html#bt-song-update-playback-position" title="bt_song_update_playback_position ()">bt_song_update_playback_position</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtSong.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 class="link" href="BtApplication.html" title="BtApplication"><span class="type">BtApplication</span></a> *</td>
<td class="property_name"><a class="link" href="BtSong.html#BtSong--app" title="The “app” property">app</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<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="BtSong.html#BtSong--bin" title="The “bin” property">bin</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="BtSong.html#BtSong--is-idle" title="The “is-idle” property">is-idle</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="BtSong.html#BtSong--is-playing" title="The “is-playing” property">is-playing</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="BtSinkMachine.html" title="BtSinkMachine"><span class="type">BtSinkMachine</span></a> *</td>
<td class="property_name"><a class="link" href="BtSong.html#BtSong--master" title="The “master” property">master</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gulong"><span class="type">gulong</span></a></td>
<td class="property_name"><a class="link" href="BtSong.html#BtSong--play-pos" title="The “play-pos” property">play-pos</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="BtSong.html#BtSong--play-rate" title="The “play-rate” property">play-rate</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="BtSequence.html" title="BtSequence"><span class="type">BtSequence</span></a> *</td>
<td class="property_name"><a class="link" href="BtSong.html#BtSong--sequence" title="The “sequence” property">sequence</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="BtSetup.html" title="BtSetup"><span class="type">BtSetup</span></a> *</td>
<td class="property_name"><a class="link" href="BtSong.html#BtSong--setup" title="The “setup” property">setup</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="BtSongInfo.html" title="BtSongInfo"><span class="type">BtSongInfo</span></a> *</td>
<td class="property_name"><a class="link" href="BtSong.html#BtSong--song-info" title="The “song-info” property">song-info</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="BtSongIO.html" title="BtSongIO"><span class="type">BtSongIO</span></a> *</td>
<td class="property_name"><a class="link" href="BtSong.html#BtSong--song-io" title="The “song-io” property">song-io</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="BtWavetable.html" title="BtWavetable"><span class="type">BtWavetable</span></a> *</td>
<td class="property_name"><a class="link" href="BtSong.html#BtSong--wavetable" title="The “wavetable” property">wavetable</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtSong.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="BtSong.html#BtSong-struct" title="struct BtSong">BtSong</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="BtSong.html#BtSongClass" title="struct BtSongClass">BtSongClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtSong.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> BtSong
</pre>
</div>
<div class="refsect1">
<a name="BtSong.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
BtSong implements
<a class="link" href="BtPersistence.html" title="BtPersistence">BtPersistence</a>.</p>
</div>
<div class="refsect1">
<a name="BtSong.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libbtcore/core.h>
</pre>
</div>
<div class="refsect1">
<a name="BtSong.description"></a><h2>Description</h2>
<p>A song is the top-level container object to manage all song-related objects.
The <a class="link" href="BtSetup.html" title="BtSetup"><span class="type">BtSetup</span></a> contains the machines and their connections, the <a class="link" href="BtSequence.html" title="BtSequence"><span class="type">BtSequence</span></a>
contains the overall time-line, the <a class="link" href="BtWavetable.html" title="BtWavetable"><span class="type">BtWavetable</span></a> holds a list of audio
snippets and the <a class="link" href="BtSongInfo.html" title="BtSongInfo"><span class="type">BtSongInfo</span></a> has a couple of meta-data items for the song. </p>
<p>To load or save a song, use a <a class="link" href="BtSongIO.html" title="BtSongIO"><span class="type">BtSongIO</span></a> object. These implement loading and
saving for different file-formats.</p>
<p>One can seek in a song by setting the <a class="link" href="BtSong.html#BtSong--play-pos" title="The “play-pos” property"><span class="type">“play-pos”</span></a> property. Likewise one
can watch the property to display the playback position.</p>
<p>The <a class="link" href="BtSong.html#BtSong--play-rate" title="The “play-rate” property"><span class="type">“play-rate”</span></a> property can be used to change the playback speed and
direction.</p>
</div>
<div class="refsect1">
<a name="BtSong.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="bt-song-continue"></a><h3>bt_song_continue ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
bt_song_continue (<em class="parameter"><code>const <a class="link" href="BtSong.html" title="BtSong"><span class="type">BtSong</span></a> * const self</code></em>);</pre>
<p>Continues the playback of the specified song instance.</p>
<div class="refsect3">
<a name="id-1.4.4.12.10.2.5"></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 that should be paused</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.12.10.2.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for success</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bt-song-new"></a><h3>bt_song_new ()</h3>
<pre class="programlisting"><a class="link" href="BtSong.html" title="BtSong"><span class="returnvalue">BtSong</span></a> *
bt_song_new (<em class="parameter"><code>const <a class="link" href="BtApplication.html" title="BtApplication"><span class="type">BtApplication</span></a> * const app</code></em>);</pre>
<p>Create a new instance.
The new song instance automatically has one instance of <a class="link" href="BtSetup.html" title="BtSetup"><span class="type">BtSetup</span></a>, <a class="link" href="BtSequence.html" title="BtSequence"><span class="type">BtSequence</span></a>
and <a class="link" href="BtSongInfo.html" title="BtSongInfo"><span class="type">BtSongInfo</span></a>. These instances can be retrieved via the respecting
properties.</p>
<p>For example use following code to retrive a BtSequence from the song class:</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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">BtSequence</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">sequence</span><span class="symbol">;</span>
<span class="symbol">...</span>
<span class="function"><a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#g-object-get">g_object_get</a></span><span class="symbol">(</span><span class="function">BT_SONG</span><span class="symbol">(</span><span class="normal">song</span><span class="symbol">),</span><span class="normal"> </span><span class="string">"sequence"</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">sequence</span><span class="symbol">,</span><span class="normal"> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<div class="refsect3">
<a name="id-1.4.4.12.10.3.7"></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>app</p></td>
<td class="parameter_description"><p>the application object the songs belongs to.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.12.10.3.8"></a><h4>Returns</h4>
<p> the new instance or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case of an error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bt-song-pause"></a><h3>bt_song_pause ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
bt_song_pause (<em class="parameter"><code>const <a class="link" href="BtSong.html" title="BtSong"><span class="type">BtSong</span></a> * const self</code></em>);</pre>
<p>Pauses the playback of the specified song instance.</p>
<div class="refsect3">
<a name="id-1.4.4.12.10.4.5"></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 that should be paused</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.12.10.4.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for success</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bt-song-play"></a><h3>bt_song_play ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
bt_song_play (<em class="parameter"><code>const <a class="link" href="BtSong.html" title="BtSong"><span class="type">BtSong</span></a> * const self</code></em>);</pre>
<p>Starts to play the specified song instance from beginning.
This methods toggles the <a class="link" href="BtSong.html#BtSong--is-playing" title="The “is-playing” property"><span class="type">“is-playing”</span></a> property.</p>
<div class="refsect3">
<a name="id-1.4.4.12.10.5.5"></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 that should be played</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.12.10.5.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for success</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bt-song-stop"></a><h3>bt_song_stop ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
bt_song_stop (<em class="parameter"><code>const <a class="link" href="BtSong.html" title="BtSong"><span class="type">BtSong</span></a> * const self</code></em>);</pre>
<p>Stops the playback of the specified song instance.</p>
<div class="refsect3">
<a name="id-1.4.4.12.10.6.5"></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 that should be stopped</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.12.10.6.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for success</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bt-song-update-playback-position"></a><h3>bt_song_update_playback_position ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
bt_song_update_playback_position (<em class="parameter"><code>const <a class="link" href="BtSong.html" title="BtSong"><span class="type">BtSong</span></a> * const self</code></em>);</pre>
<p>Updates the playback-position counter to fire all <a class="link" href="BtSong.html#BtSong--play-pos" title="The “play-pos” property"><span class="type">“play-pos”</span></a> notify
handlers.</p>
<div class="refsect3">
<a name="id-1.4.4.12.10.7.5"></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 that should update its playback-pos counter</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.12.10.7.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the song is not playing</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="BtSong.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="BtSong-struct"></a><h3>struct BtSong</h3>
<pre class="programlisting">struct BtSong;</pre>
<p>Song project object
(contains <a class="link" href="BtSongInfo.html" title="BtSongInfo"><span class="type">BtSongInfo</span></a>, <a class="link" href="BtSetup.html" title="BtSetup"><span class="type">BtSetup</span></a> and <a class="link" href="BtSequence.html" title="BtSequence"><span class="type">BtSequence</span></a>)</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSongClass"></a><h3>struct BtSongClass</h3>
<pre class="programlisting">struct BtSongClass {
const GObjectClass parent;
};
</pre>
<p>Base class for songs</p>
<div class="refsect3">
<a name="id-1.4.4.12.11.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 href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="BtSongClass.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 class="refsect1">
<a name="BtSong.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="BtSong--app"></a><h3>The <code class="literal">“app”</code> property</h3>
<pre class="programlisting"> “app” <a class="link" href="BtApplication.html" title="BtApplication"><span class="type">BtApplication</span></a> *</pre>
<p>set application object, the song belongs to.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSong--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>songs top-level GstElement container.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSong--is-idle"></a><h3>The <code class="literal">“is-idle”</code> property</h3>
<pre class="programlisting"> “is-idle” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>request that the song should idle-loop if not playing.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSong--is-playing"></a><h3>The <code class="literal">“is-playing”</code> property</h3>
<pre class="programlisting"> “is-playing” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>tell whether the song is playing right now or not.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSong--master"></a><h3>The <code class="literal">“master”</code> property</h3>
<pre class="programlisting"> “master” <a class="link" href="BtSinkMachine.html" title="BtSinkMachine"><span class="type">BtSinkMachine</span></a> *</pre>
<p>songs audio_sink.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSong--play-pos"></a><h3>The <code class="literal">“play-pos”</code> property</h3>
<pre class="programlisting"> “play-pos” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gulong"><span class="type">gulong</span></a></pre>
<p>position of the play cursor of the sequence in timeline bars.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: <= G_MAXINT64</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSong--play-rate"></a><h3>The <code class="literal">“play-rate”</code> property</h3>
<pre class="programlisting"> “play-rate” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>playback rate of the sequence.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [-5,5]</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSong--sequence"></a><h3>The <code class="literal">“sequence”</code> property</h3>
<pre class="programlisting"> “sequence” <a class="link" href="BtSequence.html" title="BtSequence"><span class="type">BtSequence</span></a> *</pre>
<p>songs sequence sub object.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSong--setup"></a><h3>The <code class="literal">“setup”</code> property</h3>
<pre class="programlisting"> “setup” <a class="link" href="BtSetup.html" title="BtSetup"><span class="type">BtSetup</span></a> *</pre>
<p>songs setup sub object.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSong--song-info"></a><h3>The <code class="literal">“song-info”</code> property</h3>
<pre class="programlisting"> “song-info” <a class="link" href="BtSongInfo.html" title="BtSongInfo"><span class="type">BtSongInfo</span></a> *</pre>
<p>songs metadata sub object.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSong--song-io"></a><h3>The <code class="literal">“song-io”</code> property</h3>
<pre class="programlisting"> “song-io” <a class="link" href="BtSongIO.html" title="BtSongIO"><span class="type">BtSongIO</span></a> *</pre>
<p>the song-io plugin during i/o operations.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="BtSong--wavetable"></a><h3>The <code class="literal">“wavetable”</code> property</h3>
<pre class="programlisting"> “wavetable” <a class="link" href="BtWavetable.html" title="BtWavetable"><span class="type">BtWavetable</span></a> *</pre>
<p>songs wavetable sub object.</p>
<p>Flags: Read</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>
|
