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
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="RBPlayer">
<refmeta>
<refentrytitle role="top_of_page" id="RBPlayer.top_of_page">rb-player</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rb-player</refname>
<refpurpose>playback backend interface</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="RBPlayer.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <rb-player.h>
<link linkend="RBPlayer-struct">RBPlayer</link>;
<link linkend="RBPlayerIface">RBPlayerIface</link>;
enum <link linkend="RBPlayerError">RBPlayerError</link>;
<link linkend="RBPlayer">RBPlayer</link>* <link linkend="rb-player-new">rb_player_new</link> (<link linkend="gboolean">gboolean</link> want_crossfade,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="rb-player-open">rb_player_open</link> (<link linkend="RBPlayer">RBPlayer</link> *player,
const <link linkend="char">char</link> *uri,
<link linkend="gpointer">gpointer</link> stream_data,
<link linkend="GDestroyNotify">GDestroyNotify</link> stream_data_destroy,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="rb-player-opened">rb_player_opened</link> (<link linkend="RBPlayer">RBPlayer</link> *player);
<link linkend="gboolean">gboolean</link> <link linkend="rb-player-close">rb_player_close</link> (<link linkend="RBPlayer">RBPlayer</link> *player,
const <link linkend="char">char</link> *uri,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="rb-player-play">rb_player_play</link> (<link linkend="RBPlayer">RBPlayer</link> *player,
<link linkend="gint">gint</link> crossfade,
<link linkend="GError">GError</link> **error);
<link linkend="void">void</link> <link linkend="rb-player-pause">rb_player_pause</link> (<link linkend="RBPlayer">RBPlayer</link> *player);
<link linkend="gboolean">gboolean</link> <link linkend="rb-player-playing">rb_player_playing</link> (<link linkend="RBPlayer">RBPlayer</link> *player);
<link linkend="void">void</link> <link linkend="rb-player-set-volume">rb_player_set_volume</link> (<link linkend="RBPlayer">RBPlayer</link> *player,
<link linkend="float">float</link> volume);
<link linkend="float">float</link> <link linkend="rb-player-get-volume">rb_player_get_volume</link> (<link linkend="RBPlayer">RBPlayer</link> *player);
<link linkend="void">void</link> <link linkend="rb-player-set-replaygain">rb_player_set_replaygain</link> (<link linkend="RBPlayer">RBPlayer</link> *player,
const <link linkend="char">char</link> *uri,
<link linkend="double">double</link> track_gain,
<link linkend="double">double</link> track_peak,
<link linkend="double">double</link> album_gain,
<link linkend="double">double</link> album_peak);
<link linkend="gboolean">gboolean</link> <link linkend="rb-player-seekable">rb_player_seekable</link> (<link linkend="RBPlayer">RBPlayer</link> *player);
<link linkend="void">void</link> <link linkend="rb-player-set-time">rb_player_set_time</link> (<link linkend="RBPlayer">RBPlayer</link> *player,
long <link linkend="newtime">newtime</link> );
<link linkend="long">long</link> <link linkend="rb-player-get-time">rb_player_get_time</link> (<link linkend="RBPlayer">RBPlayer</link> *player);
<link linkend="gboolean">gboolean</link> <link linkend="rb-player-multiple-open">rb_player_multiple_open</link> (<link linkend="RBPlayer">RBPlayer</link> *player);
</synopsis>
</refsynopsisdiv>
<refsect1 id="RBPlayer.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GInterface">GInterface</link>
+----RBPlayer
</synopsis>
</refsect1>
<refsect1 id="RBPlayer.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="RBPlayer-buffering">buffering</link>" : Run Last
"<link linkend="RBPlayer-eos">eos</link>" : Run Last / No Recursion
"<link linkend="RBPlayer-error">error</link>" : Run Last / No Recursion
"<link linkend="RBPlayer-event">event</link>" : Run Last / Has Details
"<link linkend="RBPlayer-info">info</link>" : Run Last
"<link linkend="RBPlayer-playing-stream">playing-stream</link>" : Run Last
"<link linkend="RBPlayer-tick">tick</link>" : Run Last
</synopsis>
</refsect1>
<refsect1 id="RBPlayer.description" role="desc">
<title role="desc.title">Description</title>
<para>
This is the interface implemented by the rhythmbox playback backends.
It allows the caller to control playback (open, play, pause, close),
seek (set_time), control volume (get_volume, set_volume, set_replaygain)
and receive playback state information (get_time, various signals).
</para>
<para>
The playback interface allows for multiple streams to be playing (or at
least open) concurrently. The caller associates some data with each stream
it opens (<link linkend="rb-player-open"><type>rb_player_open</type></link>), which is included in the paramters with each
signal emitted. The caller should not assume that the new stream is playing
immediately upon returning from <link linkend="rb-player-play"><type>rb_player_play</type></link>. Instead, it should use
the 'playing-stream' signal to determine that.
</para>
<para>
The player implementation should emit signals for metadata extracted from the
stream using the 'info' signal
</para>
<para>
While playing, the player implementation should emit 'tick' signals frequently
enough to update an elapsed/remaining time display consistently. The duration
value included in tick signal emissions is used to prepare the next stream before
the current stream reaches EOS, so it should be updated for each emission to account
for variable bitrate streams that produce inaccurate duration estimates early on.
</para>
<para>
When playing a stream from the network, the player can report buffering status
using the 'buffering' signal. The value included in the signal indicates the
percentage of the buffer that has been filled.
</para>
<para>
The 'event' signal can be used to communicate events from the player to the application.
For GStreamer-based player implementations, events are triggered by elements in the
pipeline posting application messages. The name of the message becomes the name of the
event.</para>
<para>
</para>
</refsect1>
<refsect1 id="RBPlayer.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBPlayer-struct" role="struct">
<title>RBPlayer</title>
<indexterm zone="RBPlayer-struct"><primary>RBPlayer</primary></indexterm><programlisting>typedef struct _RBPlayer RBPlayer;</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBPlayerIface" role="struct">
<title>RBPlayerIface</title>
<indexterm zone="RBPlayerIface"><primary>RBPlayerIface</primary></indexterm><programlisting>typedef struct {
GTypeInterface g_iface;
/* virtual functions */
gboolean (*open) (RBPlayer *player,
const char *uri,
gpointer stream_data,
GDestroyNotify stream_data_destroy,
GError **error);
gboolean (*opened) (RBPlayer *player);
gboolean (*close) (RBPlayer *player,
const char *uri,
GError **error);
gboolean (*play) (RBPlayer *player,
gint crossfade,
GError **error);
void (*pause) (RBPlayer *player);
gboolean (*playing) (RBPlayer *player);
void (*set_volume) (RBPlayer *player,
float volume);
float (*get_volume) (RBPlayer *player);
void (*set_replaygain) (RBPlayer *player,
const char *uri,
double track_gain,
double track_peak,
double album_gain,
double album_peak);
gboolean (*seekable) (RBPlayer *player);
void (*set_time) (RBPlayer *player,
long time);
long (*get_time) (RBPlayer *player);
gboolean (*multiple_open) (RBPlayer *player);
/* signals */
void (*playing_stream) (RBPlayer *player,
gpointer stream_data);
void (*eos) (RBPlayer *player,
gpointer stream_data);
void (*info) (RBPlayer *player,
gpointer stream_data,
RBMetaDataField field,
GValue *value);
void (*buffering) (RBPlayer *player,
gpointer stream_data,
guint progress);
void (*error) (RBPlayer *player,
gpointer stream_data,
GError *error);
void (*tick) (RBPlayer *player,
gpointer stream_data,
long elapsed,
long duration);
void (*event) (RBPlayer *player,
gpointer stream_data,
gpointer data);
} RBPlayerIface;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBPlayerError" role="enum">
<title>enum RBPlayerError</title>
<indexterm zone="RBPlayerError"><primary>RBPlayerError</primary></indexterm><programlisting>typedef enum
{
RB_PLAYER_ERROR_NO_AUDIO,
RB_PLAYER_ERROR_GENERAL,
RB_PLAYER_ERROR_INTERNAL
} RBPlayerError;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-player-new" role="function">
<title>rb_player_new ()</title>
<indexterm zone="rb-player-new"><primary>rb_player_new</primary></indexterm><programlisting><link linkend="RBPlayer">RBPlayer</link>* rb_player_new (<link linkend="gboolean">gboolean</link> want_crossfade,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Creates a new player object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>want_crossfade</parameter> :</term>
<listitem><simpara> if TRUE, try to use a backend that supports
crossfading and other track transitions.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> new player object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-player-open" role="function">
<title>rb_player_open ()</title>
<indexterm zone="rb-player-open"><primary>rb_player_open</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_player_open (<link linkend="RBPlayer">RBPlayer</link> *player,
const <link linkend="char">char</link> *uri,
<link linkend="gpointer">gpointer</link> stream_data,
<link linkend="GDestroyNotify">GDestroyNotify</link> stream_data_destroy,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Prepares a stream for playback. Depending on the player
implementation, this may stop any existing stream being
played. The stream preparation process may continue
asynchronously, in which case errors may be reported from
<link linkend="rb-player-play"><type>rb_player_play</type></link> or using the 'error' signal.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> URI to open
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stream_data</parameter> :</term>
<listitem><simpara> arbitrary data to associate with the stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stream_data_destroy</parameter> :</term>
<listitem><simpara> function to call to destroy the stream data
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the stream preparation was not unsuccessful
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-player-opened" role="function">
<title>rb_player_opened ()</title>
<indexterm zone="rb-player-opened"><primary>rb_player_opened</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_player_opened (<link linkend="RBPlayer">RBPlayer</link> *player);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if a stream is prepared for playback
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-player-close" role="function">
<title>rb_player_close ()</title>
<indexterm zone="rb-player-close"><primary>rb_player_close</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_player_close (<link linkend="RBPlayer">RBPlayer</link> *player,
const <link linkend="char">char</link> *uri,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
If a URI is specified, this will close the stream corresponding
to that URI and free any resources related resources. If <parameter>uri</parameter>
is NULL, this will close all streams.
</para>
<para>
If no streams remain open after this call, the audio device will
be released.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> optionally, the URI of the stream to close
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if a stream was found and closed
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-player-play" role="function">
<title>rb_player_play ()</title>
<indexterm zone="rb-player-play"><primary>rb_player_play</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_player_play (<link linkend="RBPlayer">RBPlayer</link> *player,
<link linkend="gint">gint</link> crossfade,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Starts playback of the most recently opened stream.
If <parameter>crossfade</parameter> is greater than zero, the player may attempt
to crossfade the new stream with any existing streams.
</para>
<para>
If <parameter>crossfade</parameter> is zero, the player may attempt to start the
stream immediately after the current playing stream reaches
EOS. This may or may not result in the phenomemon known
as 'gapless playback'.
</para>
<para>
If <parameter>crossfade</parameter> is less than zero, the player will stop any
existing stream before starting the new stream. It may do
this anyway, regardless of the value of <parameter>crossfade</parameter>.
</para>
<para>
The 'playing-stream' signal will be emitted when the new stream
is actually playing. This may be before or after control returns
to the caller.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>crossfade</parameter> :</term>
<listitem><simpara> requested crossfade duration
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if playback started successfully
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-player-pause" role="function">
<title>rb_player_pause ()</title>
<indexterm zone="rb-player-pause"><primary>rb_player_pause</primary></indexterm><programlisting><link linkend="void">void</link> rb_player_pause (<link linkend="RBPlayer">RBPlayer</link> *player);</programlisting>
<para>
Pauses playback of the most recently started stream. Any
streams being faded out may continue until the fade is
complete.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-player-playing" role="function">
<title>rb_player_playing ()</title>
<indexterm zone="rb-player-playing"><primary>rb_player_playing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_player_playing (<link linkend="RBPlayer">RBPlayer</link> *player);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBPlayer"><type>RBPlayer</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if a stream is currently being played (not paused
or being faded out).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-player-set-volume" role="function">
<title>rb_player_set_volume ()</title>
<indexterm zone="rb-player-set-volume"><primary>rb_player_set_volume</primary></indexterm><programlisting><link linkend="void">void</link> rb_player_set_volume (<link linkend="RBPlayer">RBPlayer</link> *player,
<link linkend="float">float</link> volume);</programlisting>
<para>
Adjusts the output volume level. This affects all streams.
The player may use a hardware volume control to implement
this volume adjustment.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>volume</parameter> :</term>
<listitem><simpara> new output volume level
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-player-get-volume" role="function">
<title>rb_player_get_volume ()</title>
<indexterm zone="rb-player-get-volume"><primary>rb_player_get_volume</primary></indexterm><programlisting><link linkend="float">float</link> rb_player_get_volume (<link linkend="RBPlayer">RBPlayer</link> *player);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> current output volume level
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-player-set-replaygain" role="function">
<title>rb_player_set_replaygain ()</title>
<indexterm zone="rb-player-set-replaygain"><primary>rb_player_set_replaygain</primary></indexterm><programlisting><link linkend="void">void</link> rb_player_set_replaygain (<link linkend="RBPlayer">RBPlayer</link> *player,
const <link linkend="char">char</link> *uri,
<link linkend="double">double</link> track_gain,
<link linkend="double">double</link> track_peak,
<link linkend="double">double</link> album_gain,
<link linkend="double">double</link> album_peak);</programlisting>
<para>
Sets ReplayGain values for a stream</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> URI of stream to adjust
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>track_gain</parameter> :</term>
<listitem><simpara> ReplayGain track gain level
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>track_peak</parameter> :</term>
<listitem><simpara> ReplayGain track peak level
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>album_gain</parameter> :</term>
<listitem><simpara> ReplayGain album gain level
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>album_peak</parameter> :</term>
<listitem><simpara> ReplayGain album peak level
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-player-seekable" role="function">
<title>rb_player_seekable ()</title>
<indexterm zone="rb-player-seekable"><primary>rb_player_seekable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_player_seekable (<link linkend="RBPlayer">RBPlayer</link> *player);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the current stream is seekable
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-player-set-time" role="function">
<title>rb_player_set_time ()</title>
<indexterm zone="rb-player-set-time"><primary>rb_player_set_time</primary></indexterm><programlisting><link linkend="void">void</link> rb_player_set_time (<link linkend="RBPlayer">RBPlayer</link> *player,
long <link linkend="newtime">newtime</link> );</programlisting>
<para>
Attempts to seek in the current stream. The player
may ignore this if the stream is not seekable.
The seek may take place asynchronously.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>Param2</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-player-get-time" role="function">
<title>rb_player_get_time ()</title>
<indexterm zone="rb-player-get-time"><primary>rb_player_get_time</primary></indexterm><programlisting><link linkend="long">long</link> rb_player_get_time (<link linkend="RBPlayer">RBPlayer</link> *player);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the current playback position in the current stream
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-player-multiple-open" role="function">
<title>rb_player_multiple_open ()</title>
<indexterm zone="rb-player-multiple-open"><primary>rb_player_multiple_open</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_player_multiple_open (<link linkend="RBPlayer">RBPlayer</link> *player);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the player supports multiple open streams
(not necessarily multiple playing streams, though)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="RBPlayer.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="RBPlayer-buffering"><title>The <literal>"buffering"</literal> signal</title>
<indexterm zone="RBPlayer-buffering"><primary>RBPlayer::buffering</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBPlayer">RBPlayer</link> *player,
<link linkend="gpointer">gpointer</link> stream_data,
<link linkend="guint">guint</link> progress,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
The 'buffering' signal is emitted while a stream is paused so
that a buffer can be filled. The progress value typically varies
from 0 to 100, and once it reaches 100, playback resumes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stream_data</parameter> :</term>
<listitem><simpara> the data associated with the buffering stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>progress</parameter> :</term>
<listitem><simpara> buffering percentage
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBPlayer-eos"><title>The <literal>"eos"</literal> signal</title>
<indexterm zone="RBPlayer-eos"><primary>RBPlayer::eos</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBPlayer">RBPlayer</link> *player,
<link linkend="gpointer">gpointer</link> stream_data,
<link linkend="gpointer">gpointer</link> user_data) : Run Last / No Recursion</programlisting>
<para>
The 'eos' signal is emitted when a stream finishes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stream_data</parameter> :</term>
<listitem><simpara> the data associated with the stream that finished
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBPlayer-error"><title>The <literal>"error"</literal> signal</title>
<indexterm zone="RBPlayer-error"><primary>RBPlayer::error</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBPlayer">RBPlayer</link> *player,
<link linkend="gpointer">gpointer</link> stream_data,
<link linkend="gpointer">gpointer</link> error,
<link linkend="gpointer">gpointer</link> user_data) : Run Last / No Recursion</programlisting>
<para>
The 'error' signal is emitted when an error is encountered
while opening or playing a stream.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stream_data</parameter> :</term>
<listitem><simpara> the data associated with the stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> description of the error
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBPlayer-event"><title>The <literal>"event"</literal> signal</title>
<indexterm zone="RBPlayer-event"><primary>RBPlayer::event</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBPlayer">RBPlayer</link> *player,
<link linkend="gpointer">gpointer</link> stream_data,
<link linkend="gpointer">gpointer</link> data,
<link linkend="gpointer">gpointer</link> user_data) : Run Last / Has Details</programlisting>
<para>
The 'event' signal provides a means for custom GStreamer
elements to communicate events back to the rest of the
application. The GStreamer element posts an application
message on the GStreamer bus, which is translated into an
event signal with the detail of the signal set to the name
of the structure found in the message.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stream_data</parameter> :</term>
<listitem><simpara> data associated with the stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> event data
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBPlayer-info"><title>The <literal>"info"</literal> signal</title>
<indexterm zone="RBPlayer-info"><primary>RBPlayer::info</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBPlayer">RBPlayer</link> *player,
<link linkend="gpointer">gpointer</link> stream_data,
<link linkend="gint">gint</link> field,
<link linkend="GValue">GValue</link> *value,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
The 'info' signal is emitted when a metadata value is found in
the stream.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stream_data</parameter> :</term>
<listitem><simpara> the data associated with the stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>field</parameter> :</term>
<listitem><simpara> the <link linkend="RBMetaDataField"><type>RBMetaDataField</type></link> corresponding to the stream info
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> the value of the stream info field
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBPlayer-playing-stream"><title>The <literal>"playing-stream"</literal> signal</title>
<indexterm zone="RBPlayer-playing-stream"><primary>RBPlayer::playing-stream</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBPlayer">RBPlayer</link> *player,
<link linkend="gpointer">gpointer</link> stream_data,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
The 'playing-stream' signal is emitted when the main playing stream
changes. It should be used to update the UI to show the new
stream. It can either be emitted before or after <link linkend="rb-player-play"><type>rb_player_play</type></link> returns,
depending on the player backend.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stream_data</parameter> :</term>
<listitem><simpara> data associated with the stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBPlayer-tick"><title>The <literal>"tick"</literal> signal</title>
<indexterm zone="RBPlayer-tick"><primary>RBPlayer::tick</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBPlayer">RBPlayer</link> *player,
<link linkend="gpointer">gpointer</link> stream_data,
<link linkend="glong">glong</link> elapsed,
<link linkend="glong">glong</link> duration,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
The 'tick' signal is emitted repeatedly while the stream is
playing. Signal handlers can use this to update UI and to
prepare new streams for crossfade or gapless playback.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBPlayer"><type>RBPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stream_data</parameter> :</term>
<listitem><simpara> the data associated with the stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>elapsed</parameter> :</term>
<listitem><simpara> playback position in the stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>duration</parameter> :</term>
<listitem><simpara> current estimate of the duration of the stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
