3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4
<title>rb-recorder</title>
5
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
6
<link rel="start" href="index.html" title="Rhythmbox Development Reference Manual">
7
<link rel="up" href="ch04.html" title="Player">
8
<link rel="prev" href="rhythmbox-rb-player.html" title="rb-player">
9
<link rel="next" href="ch05.html" title="RhythmDB">
10
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
11
<link rel="stylesheet" href="style.css" type="text/css">
12
<link rel="chapter" href="ch01.html" title="IRadio UI">
13
<link rel="chapter" href="ch02.html" title="Lib">
14
<link rel="chapter" href="ch03.html" title="Metadata">
15
<link rel="chapter" href="ch04.html" title="Player">
16
<link rel="chapter" href="ch05.html" title="RhythmDB">
17
<link rel="chapter" href="ch06.html" title="Shell">
18
<link rel="chapter" href="ch07.html" title="Sources">
19
<link rel="chapter" href="ch08.html" title="Widgets">
21
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
22
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
23
<td><a accesskey="p" href="rhythmbox-rb-player.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
24
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
25
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
26
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
27
<td><a accesskey="n" href="ch05.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
29
<div class="refentry" lang="en">
30
<a name="rhythmbox-rb-recorder"></a><div class="titlepage"></div>
31
<div class="refnamediv"><table width="100%"><tr>
33
<h2><span class="refentrytitle">rb-recorder</span></h2>
34
<p>rb-recorder — </p>
36
<td valign="top" align="right"></td>
38
<div class="refsynopsisdiv">
40
<pre class="synopsis">
44
enum <a href="rhythmbox-rb-recorder.html#RBRecorderError">RBRecorderError</a>;
45
enum <a href="rhythmbox-rb-recorder.html#RBRecorderAction">RBRecorderAction</a>;
46
enum <a href="rhythmbox-rb-recorder.html#RBRecorderResponse">RBRecorderResponse</a>;
47
enum <a href="rhythmbox-rb-recorder.html#RBRecorderResult">RBRecorderResult</a>;
48
#define <a href="rhythmbox-rb-recorder.html#RB-RECORDER-ERROR:CAPS">RB_RECORDER_ERROR</a>
49
GQuark <a href="rhythmbox-rb-recorder.html#rb-recorder-error-quark">rb_recorder_error_quark</a> (void);
50
<a href="rhythmbox-rb-recorder.html#RBRecorderPrivate">RBRecorderPrivate</a>;
51
RBRecorder* <a href="rhythmbox-rb-recorder.html#rb-recorder-new">rb_recorder_new</a> (GError **error);
52
void <a href="rhythmbox-rb-recorder.html#rb-recorder-open">rb_recorder_open</a> (RBRecorder *recorder,
56
gboolean <a href="rhythmbox-rb-recorder.html#rb-recorder-opened">rb_recorder_opened</a> (RBRecorder *recorder);
57
void <a href="rhythmbox-rb-recorder.html#rb-recorder-close">rb_recorder_close</a> (RBRecorder *recorder,
59
void <a href="rhythmbox-rb-recorder.html#rb-recorder-write">rb_recorder_write</a> (RBRecorder *recorder,
61
void <a href="rhythmbox-rb-recorder.html#rb-recorder-pause">rb_recorder_pause</a> (RBRecorder *recorder,
63
char* <a href="rhythmbox-rb-recorder.html#rb-recorder-get-default-device">rb_recorder_get_default_device</a> (void);
64
char* <a href="rhythmbox-rb-recorder.html#rb-recorder-get-device">rb_recorder_get_device</a> (RBRecorder *recorder,
66
gboolean <a href="rhythmbox-rb-recorder.html#rb-recorder-set-device">rb_recorder_set_device</a> (RBRecorder *recorder,
69
void <a href="rhythmbox-rb-recorder.html#rb-recorder-set-tmp-dir">rb_recorder_set_tmp_dir</a> (RBRecorder *recorder,
72
gint64 <a href="rhythmbox-rb-recorder.html#rb-recorder-get-media-length">rb_recorder_get_media_length</a> (RBRecorder *recorder,
74
int <a href="rhythmbox-rb-recorder.html#rb-recorder-burn">rb_recorder_burn</a> (RBRecorder *recorder,
77
int <a href="rhythmbox-rb-recorder.html#rb-recorder-burn-cancel">rb_recorder_burn_cancel</a> (RBRecorder *recorder);
78
gboolean <a href="rhythmbox-rb-recorder.html#rb-recorder-enabled">rb_recorder_enabled</a> (void);
82
<div class="refsect1" lang="en">
83
<a name="id2535841"></a><h2>Description</h2>
88
<div class="refsect1" lang="en">
89
<a name="id2535852"></a><h2>Details</h2>
90
<div class="refsect2" lang="en">
91
<a name="id2535858"></a><h3>
92
<a name="RBRecorderError"></a>enum RBRecorderError</h3>
93
<a class="indexterm" name="id2535868"></a><pre class="programlisting">typedef enum
95
RB_RECORDER_ERROR_NO_INPUT_PLUGIN,
96
RB_RECORDER_ERROR_NO_TYPEFIND_PLUGIN,
97
RB_RECORDER_ERROR_NO_DEMUX_PLUGIN,
98
RB_RECORDER_ERROR_NO_AUDIO,
99
RB_RECORDER_ERROR_GENERAL,
100
RB_RECORDER_ERROR_INTERNAL
108
<div class="refsect2" lang="en">
109
<a name="id2535888"></a><h3>
110
<a name="RBRecorderAction"></a>enum RBRecorderAction</h3>
111
<a class="indexterm" name="id2535898"></a><pre class="programlisting">typedef enum {
112
RB_RECORDER_ACTION_UNKNOWN,
113
RB_RECORDER_ACTION_FILE_CONVERTING,
114
RB_RECORDER_ACTION_DISC_PREPARING_WRITE,
115
RB_RECORDER_ACTION_DISC_WRITING,
116
RB_RECORDER_ACTION_DISC_FIXATING,
117
RB_RECORDER_ACTION_DISC_BLANKING
125
<div class="refsect2" lang="en">
126
<a name="id2535918"></a><h3>
127
<a name="RBRecorderResponse"></a>enum RBRecorderResponse</h3>
128
<a class="indexterm" name="id2535928"></a><pre class="programlisting">typedef enum {
129
RB_RECORDER_RESPONSE_NONE = 0,
130
RB_RECORDER_RESPONSE_CANCEL = -1,
131
RB_RECORDER_RESPONSE_ERASE = -2,
132
RB_RECORDER_RESPONSE_RETRY = -3
133
} RBRecorderResponse;
140
<div class="refsect2" lang="en">
141
<a name="id2535946"></a><h3>
142
<a name="RBRecorderResult"></a>enum RBRecorderResult</h3>
143
<a class="indexterm" name="id2535956"></a><pre class="programlisting">typedef enum {
144
RB_RECORDER_RESULT_ERROR,
145
RB_RECORDER_RESULT_CANCEL,
146
RB_RECORDER_RESULT_FINISHED,
147
RB_RECORDER_RESULT_RETRY
155
<div class="refsect2" lang="en">
156
<a name="id2535974"></a><h3>
157
<a name="RB-RECORDER-ERROR:CAPS"></a>RB_RECORDER_ERROR</h3>
158
<a class="indexterm" name="id2535983"></a><pre class="programlisting">#define RB_RECORDER_ERROR rb_recorder_error_quark ()
165
<div class="refsect2" lang="en">
166
<a name="id2536000"></a><h3>
167
<a name="rb-recorder-error-quark"></a>rb_recorder_error_quark ()</h3>
168
<a class="indexterm" name="id2536009"></a><pre class="programlisting">GQuark rb_recorder_error_quark (void);</pre>
172
<div class="variablelist"><table border="0">
173
<col align="left" valign="top">
176
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
185
<div class="refsect2" lang="en">
186
<a name="id2536045"></a><h3>
187
<a name="RBRecorderPrivate"></a>RBRecorderPrivate</h3>
188
<a class="indexterm" name="id2562650"></a><pre class="programlisting">typedef struct _RBRecorderPrivate RBRecorderPrivate;</pre>
194
<div class="refsect2" lang="en">
195
<a name="id2562666"></a><h3>
196
<a name="rb-recorder-new"></a>rb_recorder_new ()</h3>
197
<a class="indexterm" name="id2562677"></a><pre class="programlisting">RBRecorder* rb_recorder_new (GError **error);</pre>
201
<div class="variablelist"><table border="0">
202
<col align="left" valign="top">
206
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
212
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
222
<div class="refsect2" lang="en">
223
<a name="id2562732"></a><h3>
224
<a name="rb-recorder-open"></a>rb_recorder_open ()</h3>
225
<a class="indexterm" name="id2562742"></a><pre class="programlisting">void rb_recorder_open (RBRecorder *recorder,
228
GError **error);</pre>
232
<div class="variablelist"><table border="0">
233
<col align="left" valign="top">
237
<span class="term"><em class="parameter"><code>recorder</code></em> :</span></td>
243
<span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
249
<span class="term"><em class="parameter"><code>cdtext</code></em> :</span></td>
255
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
265
<div class="refsect2" lang="en">
266
<a name="id2562851"></a><h3>
267
<a name="rb-recorder-opened"></a>rb_recorder_opened ()</h3>
268
<a class="indexterm" name="id2562861"></a><pre class="programlisting">gboolean rb_recorder_opened (RBRecorder *recorder);</pre>
272
<div class="variablelist"><table border="0">
273
<col align="left" valign="top">
277
<span class="term"><em class="parameter"><code>recorder</code></em> :</span></td>
283
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
293
<div class="refsect2" lang="en">
294
<a name="id2562916"></a><h3>
295
<a name="rb-recorder-close"></a>rb_recorder_close ()</h3>
296
<a class="indexterm" name="id2567008"></a><pre class="programlisting">void rb_recorder_close (RBRecorder *recorder,
297
GError **error);</pre>
301
<div class="variablelist"><table border="0">
302
<col align="left" valign="top">
306
<span class="term"><em class="parameter"><code>recorder</code></em> :</span></td>
312
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
322
<div class="refsect2" lang="en">
323
<a name="id2567067"></a><h3>
324
<a name="rb-recorder-write"></a>rb_recorder_write ()</h3>
325
<a class="indexterm" name="id2567076"></a><pre class="programlisting">void rb_recorder_write (RBRecorder *recorder,
326
GError **error);</pre>
330
<div class="variablelist"><table border="0">
331
<col align="left" valign="top">
335
<span class="term"><em class="parameter"><code>recorder</code></em> :</span></td>
341
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
351
<div class="refsect2" lang="en">
352
<a name="id2567136"></a><h3>
353
<a name="rb-recorder-pause"></a>rb_recorder_pause ()</h3>
354
<a class="indexterm" name="id2567146"></a><pre class="programlisting">void rb_recorder_pause (RBRecorder *recorder,
355
GError **error);</pre>
359
<div class="variablelist"><table border="0">
360
<col align="left" valign="top">
364
<span class="term"><em class="parameter"><code>recorder</code></em> :</span></td>
370
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
380
<div class="refsect2" lang="en">
381
<a name="id2567212"></a><h3>
382
<a name="rb-recorder-get-default-device"></a>rb_recorder_get_default_device ()</h3>
383
<a class="indexterm" name="id2567223"></a><pre class="programlisting">char* rb_recorder_get_default_device (void);</pre>
387
<div class="variablelist"><table border="0">
388
<col align="left" valign="top">
391
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
400
<div class="refsect2" lang="en">
401
<a name="id2567260"></a><h3>
402
<a name="rb-recorder-get-device"></a>rb_recorder_get_device ()</h3>
403
<a class="indexterm" name="id2567269"></a><pre class="programlisting">char* rb_recorder_get_device (RBRecorder *recorder,
404
GError **error);</pre>
408
<div class="variablelist"><table border="0">
409
<col align="left" valign="top">
413
<span class="term"><em class="parameter"><code>recorder</code></em> :</span></td>
419
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
425
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
435
<div class="refsect2" lang="en">
436
<a name="id2567346"></a><h3>
437
<a name="rb-recorder-set-device"></a>rb_recorder_set_device ()</h3>
438
<a class="indexterm" name="id2567355"></a><pre class="programlisting">gboolean rb_recorder_set_device (RBRecorder *recorder,
440
GError **error);</pre>
444
<div class="variablelist"><table border="0">
445
<col align="left" valign="top">
449
<span class="term"><em class="parameter"><code>recorder</code></em> :</span></td>
455
<span class="term"><em class="parameter"><code>device</code></em> :</span></td>
461
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
467
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
477
<div class="refsect2" lang="en">
478
<a name="id2567425"></a><h3>
479
<a name="rb-recorder-set-tmp-dir"></a>rb_recorder_set_tmp_dir ()</h3>
480
<a class="indexterm" name="id2567434"></a><pre class="programlisting">void rb_recorder_set_tmp_dir (RBRecorder *recorder,
482
GError **error);</pre>
486
<div class="variablelist"><table border="0">
487
<col align="left" valign="top">
491
<span class="term"><em class="parameter"><code>recorder</code></em> :</span></td>
497
<span class="term"><em class="parameter"><code>path</code></em> :</span></td>
503
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
513
<div class="refsect2" lang="en">
514
<a name="id2567512"></a><h3>
515
<a name="rb-recorder-get-media-length"></a>rb_recorder_get_media_length ()</h3>
516
<a class="indexterm" name="id2567523"></a><pre class="programlisting">gint64 rb_recorder_get_media_length (RBRecorder *recorder,
517
GError **error);</pre>
521
<div class="variablelist"><table border="0">
522
<col align="left" valign="top">
526
<span class="term"><em class="parameter"><code>recorder</code></em> :</span></td>
532
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
538
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
548
<div class="refsect2" lang="en">
549
<a name="id2567592"></a><h3>
550
<a name="rb-recorder-burn"></a>rb_recorder_burn ()</h3>
551
<a class="indexterm" name="id2567601"></a><pre class="programlisting">int rb_recorder_burn (RBRecorder *recorder,
553
GError **error);</pre>
557
<div class="variablelist"><table border="0">
558
<col align="left" valign="top">
562
<span class="term"><em class="parameter"><code>recorder</code></em> :</span></td>
568
<span class="term"><em class="parameter"><code>speed</code></em> :</span></td>
574
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
580
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
590
<div class="refsect2" lang="en">
591
<a name="id2567689"></a><h3>
592
<a name="rb-recorder-burn-cancel"></a>rb_recorder_burn_cancel ()</h3>
593
<a class="indexterm" name="id2567697"></a><pre class="programlisting">int rb_recorder_burn_cancel (RBRecorder *recorder);</pre>
597
<div class="variablelist"><table border="0">
598
<col align="left" valign="top">
602
<span class="term"><em class="parameter"><code>recorder</code></em> :</span></td>
608
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
618
<div class="refsect2" lang="en">
619
<a name="id2567747"></a><h3>
620
<a name="rb-recorder-enabled"></a>rb_recorder_enabled ()</h3>
621
<a class="indexterm" name="id2567756"></a><pre class="programlisting">gboolean rb_recorder_enabled (void);</pre>
625
<div class="variablelist"><table border="0">
626
<col align="left" valign="top">
629
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
639
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
640
<td align="left"><a accesskey="p" href="rhythmbox-rb-player.html"><b><< rb-player</b></a></td>
641
<td align="right"><a accesskey="n" href="ch05.html"><b>RhythmDB >></b></a></td>