← Back to branch summary

~ubuntu-branches/ubuntu/utopic/rhythmbox/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-recorder.xml

Tags: upstream-0.9.2
Import upstream version 0.9.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/rb-recorder.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
<refentry id="rhythmbox-rb-recorder">
 
5
<refmeta>
 
6
<refentrytitle>rb-recorder</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>rb-recorder</refname><refpurpose></refpurpose>
 
13
</refnamediv>
 
14
 
 
15
<refsynopsisdiv><title>Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
enum        <link linkend="RBRecorderError">RBRecorderError</link>;
 
22
enum        <link linkend="RBRecorderAction">RBRecorderAction</link>;
 
23
enum        <link linkend="RBRecorderResponse">RBRecorderResponse</link>;
 
24
enum        <link linkend="RBRecorderResult">RBRecorderResult</link>;
 
25
#define     <link linkend="RB-RECORDER-ERROR:CAPS">RB_RECORDER_ERROR</link>
 
26
<link linkend="GQuark">GQuark</link>      <link linkend="rb-recorder-error-quark">rb_recorder_error_quark</link>         (void);
 
27
            <link linkend="RBRecorderPrivate">RBRecorderPrivate</link>;
 
28
<link linkend="RBRecorder">RBRecorder</link>* <link linkend="rb-recorder-new">rb_recorder_new</link>                 (<link linkend="GError">GError</link> **error);
 
29
<link linkend="void">void</link>        <link linkend="rb-recorder-open">rb_recorder_open</link>                (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
30
                                             const <link linkend="char">char</link> *uri,
 
31
                                             const <link linkend="char">char</link> *cdtext,
 
32
                                             <link linkend="GError">GError</link> **error);
 
33
<link linkend="gboolean">gboolean</link>    <link linkend="rb-recorder-opened">rb_recorder_opened</link>              (<link linkend="RBRecorder">RBRecorder</link> *recorder);
 
34
<link linkend="void">void</link>        <link linkend="rb-recorder-close">rb_recorder_close</link>               (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
35
                                             <link linkend="GError">GError</link> **error);
 
36
<link linkend="void">void</link>        <link linkend="rb-recorder-write">rb_recorder_write</link>               (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
37
                                             <link linkend="GError">GError</link> **error);
 
38
<link linkend="void">void</link>        <link linkend="rb-recorder-pause">rb_recorder_pause</link>               (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
39
                                             <link linkend="GError">GError</link> **error);
 
40
<link linkend="char">char</link>*       <link linkend="rb-recorder-get-default-device">rb_recorder_get_default_device</link>  (void);
 
41
<link linkend="char">char</link>*       <link linkend="rb-recorder-get-device">rb_recorder_get_device</link>          (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
42
                                             <link linkend="GError">GError</link> **error);
 
43
<link linkend="gboolean">gboolean</link>    <link linkend="rb-recorder-set-device">rb_recorder_set_device</link>          (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
44
                                             const <link linkend="char">char</link> *device,
 
45
                                             <link linkend="GError">GError</link> **error);
 
46
<link linkend="void">void</link>        <link linkend="rb-recorder-set-tmp-dir">rb_recorder_set_tmp_dir</link>         (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
47
                                             const <link linkend="char">char</link> *path,
 
48
                                             <link linkend="GError">GError</link> **error);
 
49
<link linkend="gint64">gint64</link>      <link linkend="rb-recorder-get-media-length">rb_recorder_get_media_length</link>    (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
50
                                             <link linkend="GError">GError</link> **error);
 
51
<link linkend="int">int</link>         <link linkend="rb-recorder-burn">rb_recorder_burn</link>                (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
52
                                             <link linkend="int">int</link> speed,
 
53
                                             <link linkend="GError">GError</link> **error);
 
54
<link linkend="int">int</link>         <link linkend="rb-recorder-burn-cancel">rb_recorder_burn_cancel</link>         (<link linkend="RBRecorder">RBRecorder</link> *recorder);
 
55
<link linkend="gboolean">gboolean</link>    <link linkend="rb-recorder-enabled">rb_recorder_enabled</link>             (void);
 
56
 
 
57
</synopsis>
 
58
</refsynopsisdiv>
 
59
 
 
60
 
 
61
 
 
62
 
 
63
 
 
64
 
 
65
 
 
66
 
 
67
 
 
68
<refsect1>
 
69
<title>Description</title>
 
70
<para>
 
71
 
 
72
</para>
 
73
</refsect1>
 
74
 
 
75
<refsect1>
 
76
<title>Details</title>
 
77
<refsect2>
 
78
<title><anchor id="RBRecorderError"/>enum RBRecorderError</title>
 
79
<indexterm><primary>RBRecorderError</primary></indexterm><programlisting>typedef enum
 
80
{
 
81
        RB_RECORDER_ERROR_NO_INPUT_PLUGIN,
 
82
        RB_RECORDER_ERROR_NO_TYPEFIND_PLUGIN,
 
83
        RB_RECORDER_ERROR_NO_DEMUX_PLUGIN,
 
84
        RB_RECORDER_ERROR_NO_AUDIO,
 
85
        RB_RECORDER_ERROR_GENERAL,
 
86
        RB_RECORDER_ERROR_INTERNAL
 
87
} RBRecorderError;
 
88
</programlisting>
 
89
<para>
 
90
 
 
91
</para></refsect2>
 
92
<refsect2>
 
93
<title><anchor id="RBRecorderAction"/>enum RBRecorderAction</title>
 
94
<indexterm><primary>RBRecorderAction</primary></indexterm><programlisting>typedef enum {
 
95
        RB_RECORDER_ACTION_UNKNOWN,
 
96
        RB_RECORDER_ACTION_FILE_CONVERTING,
 
97
        RB_RECORDER_ACTION_DISC_PREPARING_WRITE,
 
98
        RB_RECORDER_ACTION_DISC_WRITING,
 
99
        RB_RECORDER_ACTION_DISC_FIXATING,
 
100
        RB_RECORDER_ACTION_DISC_BLANKING
 
101
} RBRecorderAction;
 
102
</programlisting>
 
103
<para>
 
104
 
 
105
</para></refsect2>
 
106
<refsect2>
 
107
<title><anchor id="RBRecorderResponse"/>enum RBRecorderResponse</title>
 
108
<indexterm><primary>RBRecorderResponse</primary></indexterm><programlisting>typedef enum {
 
109
        RB_RECORDER_RESPONSE_NONE   =  0,
 
110
        RB_RECORDER_RESPONSE_CANCEL = -1,
 
111
        RB_RECORDER_RESPONSE_ERASE  = -2,
 
112
        RB_RECORDER_RESPONSE_RETRY  = -3
 
113
} RBRecorderResponse;
 
114
</programlisting>
 
115
<para>
 
116
 
 
117
</para></refsect2>
 
118
<refsect2>
 
119
<title><anchor id="RBRecorderResult"/>enum RBRecorderResult</title>
 
120
<indexterm><primary>RBRecorderResult</primary></indexterm><programlisting>typedef enum {
 
121
        RB_RECORDER_RESULT_ERROR,
 
122
        RB_RECORDER_RESULT_CANCEL,
 
123
        RB_RECORDER_RESULT_FINISHED,
 
124
        RB_RECORDER_RESULT_RETRY
 
125
} RBRecorderResult;
 
126
</programlisting>
 
127
<para>
 
128
 
 
129
</para></refsect2>
 
130
<refsect2>
 
131
<title><anchor id="RB-RECORDER-ERROR:CAPS"/>RB_RECORDER_ERROR</title>
 
132
<indexterm><primary>RB_RECORDER_ERROR</primary></indexterm><programlisting>#define RB_RECORDER_ERROR rb_recorder_error_quark ()
 
133
</programlisting>
 
134
<para>
 
135
 
 
136
</para></refsect2>
 
137
<refsect2>
 
138
<title><anchor id="rb-recorder-error-quark"/>rb_recorder_error_quark ()</title>
 
139
<indexterm><primary>rb_recorder_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link>      rb_recorder_error_quark         (void);</programlisting>
 
140
<para>
 
141
 
 
142
</para><variablelist role="params">
 
143
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
144
 
 
145
 
 
146
</simpara></listitem></varlistentry>
 
147
</variablelist></refsect2>
 
148
<refsect2>
 
149
<title><anchor id="RBRecorderPrivate"/>RBRecorderPrivate</title>
 
150
<indexterm><primary>RBRecorderPrivate</primary></indexterm><programlisting>typedef struct _RBRecorderPrivate RBRecorderPrivate;</programlisting>
 
151
<para>
 
152
 
 
153
</para></refsect2>
 
154
<refsect2>
 
155
<title><anchor id="rb-recorder-new"/>rb_recorder_new ()</title>
 
156
<indexterm><primary>rb_recorder_new</primary></indexterm><programlisting><link linkend="RBRecorder">RBRecorder</link>* rb_recorder_new                 (<link linkend="GError">GError</link> **error);</programlisting>
 
157
<para>
 
158
 
 
159
</para><variablelist role="params">
 
160
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
161
<listitem><simpara>
 
162
</simpara></listitem></varlistentry>
 
163
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
164
 
 
165
 
 
166
</simpara></listitem></varlistentry>
 
167
</variablelist></refsect2>
 
168
<refsect2>
 
169
<title><anchor id="rb-recorder-open"/>rb_recorder_open ()</title>
 
170
<indexterm><primary>rb_recorder_open</primary></indexterm><programlisting><link linkend="void">void</link>        rb_recorder_open                (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
171
                                             const <link linkend="char">char</link> *uri,
 
172
                                             const <link linkend="char">char</link> *cdtext,
 
173
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
174
<para>
 
175
 
 
176
</para><variablelist role="params">
 
177
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
178
<listitem><simpara>
 
179
</simpara></listitem></varlistentry>
 
180
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
181
<listitem><simpara>
 
182
</simpara></listitem></varlistentry>
 
183
<varlistentry><term><parameter>cdtext</parameter>&nbsp;:</term>
 
184
<listitem><simpara>
 
185
</simpara></listitem></varlistentry>
 
186
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
187
<listitem><simpara>
 
188
 
 
189
 
 
190
</simpara></listitem></varlistentry>
 
191
</variablelist></refsect2>
 
192
<refsect2>
 
193
<title><anchor id="rb-recorder-opened"/>rb_recorder_opened ()</title>
 
194
<indexterm><primary>rb_recorder_opened</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_recorder_opened              (<link linkend="RBRecorder">RBRecorder</link> *recorder);</programlisting>
 
195
<para>
 
196
 
 
197
</para><variablelist role="params">
 
198
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
199
<listitem><simpara>
 
200
</simpara></listitem></varlistentry>
 
201
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
202
 
 
203
 
 
204
</simpara></listitem></varlistentry>
 
205
</variablelist></refsect2>
 
206
<refsect2>
 
207
<title><anchor id="rb-recorder-close"/>rb_recorder_close ()</title>
 
208
<indexterm><primary>rb_recorder_close</primary></indexterm><programlisting><link linkend="void">void</link>        rb_recorder_close               (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
209
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
210
<para>
 
211
 
 
212
</para><variablelist role="params">
 
213
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
214
<listitem><simpara>
 
215
</simpara></listitem></varlistentry>
 
216
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
217
<listitem><simpara>
 
218
 
 
219
 
 
220
</simpara></listitem></varlistentry>
 
221
</variablelist></refsect2>
 
222
<refsect2>
 
223
<title><anchor id="rb-recorder-write"/>rb_recorder_write ()</title>
 
224
<indexterm><primary>rb_recorder_write</primary></indexterm><programlisting><link linkend="void">void</link>        rb_recorder_write               (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
225
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
226
<para>
 
227
 
 
228
</para><variablelist role="params">
 
229
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
230
<listitem><simpara>
 
231
</simpara></listitem></varlistentry>
 
232
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
233
<listitem><simpara>
 
234
 
 
235
 
 
236
</simpara></listitem></varlistentry>
 
237
</variablelist></refsect2>
 
238
<refsect2>
 
239
<title><anchor id="rb-recorder-pause"/>rb_recorder_pause ()</title>
 
240
<indexterm><primary>rb_recorder_pause</primary></indexterm><programlisting><link linkend="void">void</link>        rb_recorder_pause               (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
241
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
242
<para>
 
243
 
 
244
</para><variablelist role="params">
 
245
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
246
<listitem><simpara>
 
247
</simpara></listitem></varlistentry>
 
248
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
249
<listitem><simpara>
 
250
 
 
251
 
 
252
</simpara></listitem></varlistentry>
 
253
</variablelist></refsect2>
 
254
<refsect2>
 
255
<title><anchor id="rb-recorder-get-default-device"/>rb_recorder_get_default_device ()</title>
 
256
<indexterm><primary>rb_recorder_get_default_device</primary></indexterm><programlisting><link linkend="char">char</link>*       rb_recorder_get_default_device  (void);</programlisting>
 
257
<para>
 
258
 
 
259
</para><variablelist role="params">
 
260
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
261
 
 
262
 
 
263
</simpara></listitem></varlistentry>
 
264
</variablelist></refsect2>
 
265
<refsect2>
 
266
<title><anchor id="rb-recorder-get-device"/>rb_recorder_get_device ()</title>
 
267
<indexterm><primary>rb_recorder_get_device</primary></indexterm><programlisting><link linkend="char">char</link>*       rb_recorder_get_device          (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
268
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
269
<para>
 
270
 
 
271
</para><variablelist role="params">
 
272
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
273
<listitem><simpara>
 
274
</simpara></listitem></varlistentry>
 
275
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
276
<listitem><simpara>
 
277
</simpara></listitem></varlistentry>
 
278
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
279
 
 
280
 
 
281
</simpara></listitem></varlistentry>
 
282
</variablelist></refsect2>
 
283
<refsect2>
 
284
<title><anchor id="rb-recorder-set-device"/>rb_recorder_set_device ()</title>
 
285
<indexterm><primary>rb_recorder_set_device</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_recorder_set_device          (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
286
                                             const <link linkend="char">char</link> *device,
 
287
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
288
<para>
 
289
 
 
290
</para><variablelist role="params">
 
291
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
292
<listitem><simpara>
 
293
</simpara></listitem></varlistentry>
 
294
<varlistentry><term><parameter>device</parameter>&nbsp;:</term>
 
295
<listitem><simpara>
 
296
</simpara></listitem></varlistentry>
 
297
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
298
<listitem><simpara>
 
299
</simpara></listitem></varlistentry>
 
300
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
301
 
 
302
 
 
303
</simpara></listitem></varlistentry>
 
304
</variablelist></refsect2>
 
305
<refsect2>
 
306
<title><anchor id="rb-recorder-set-tmp-dir"/>rb_recorder_set_tmp_dir ()</title>
 
307
<indexterm><primary>rb_recorder_set_tmp_dir</primary></indexterm><programlisting><link linkend="void">void</link>        rb_recorder_set_tmp_dir         (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
308
                                             const <link linkend="char">char</link> *path,
 
309
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
310
<para>
 
311
 
 
312
</para><variablelist role="params">
 
313
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
314
<listitem><simpara>
 
315
</simpara></listitem></varlistentry>
 
316
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
317
<listitem><simpara>
 
318
</simpara></listitem></varlistentry>
 
319
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
320
<listitem><simpara>
 
321
 
 
322
 
 
323
</simpara></listitem></varlistentry>
 
324
</variablelist></refsect2>
 
325
<refsect2>
 
326
<title><anchor id="rb-recorder-get-media-length"/>rb_recorder_get_media_length ()</title>
 
327
<indexterm><primary>rb_recorder_get_media_length</primary></indexterm><programlisting><link linkend="gint64">gint64</link>      rb_recorder_get_media_length    (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
328
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
329
<para>
 
330
 
 
331
</para><variablelist role="params">
 
332
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
333
<listitem><simpara>
 
334
</simpara></listitem></varlistentry>
 
335
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
336
<listitem><simpara>
 
337
</simpara></listitem></varlistentry>
 
338
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
339
 
 
340
 
 
341
</simpara></listitem></varlistentry>
 
342
</variablelist></refsect2>
 
343
<refsect2>
 
344
<title><anchor id="rb-recorder-burn"/>rb_recorder_burn ()</title>
 
345
<indexterm><primary>rb_recorder_burn</primary></indexterm><programlisting><link linkend="int">int</link>         rb_recorder_burn                (<link linkend="RBRecorder">RBRecorder</link> *recorder,
 
346
                                             <link linkend="int">int</link> speed,
 
347
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
348
<para>
 
349
 
 
350
</para><variablelist role="params">
 
351
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
352
<listitem><simpara>
 
353
</simpara></listitem></varlistentry>
 
354
<varlistentry><term><parameter>speed</parameter>&nbsp;:</term>
 
355
<listitem><simpara>
 
356
</simpara></listitem></varlistentry>
 
357
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
358
<listitem><simpara>
 
359
</simpara></listitem></varlistentry>
 
360
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
361
 
 
362
 
 
363
</simpara></listitem></varlistentry>
 
364
</variablelist></refsect2>
 
365
<refsect2>
 
366
<title><anchor id="rb-recorder-burn-cancel"/>rb_recorder_burn_cancel ()</title>
 
367
<indexterm><primary>rb_recorder_burn_cancel</primary></indexterm><programlisting><link linkend="int">int</link>         rb_recorder_burn_cancel         (<link linkend="RBRecorder">RBRecorder</link> *recorder);</programlisting>
 
368
<para>
 
369
 
 
370
</para><variablelist role="params">
 
371
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
372
<listitem><simpara>
 
373
</simpara></listitem></varlistentry>
 
374
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
375
 
 
376
 
 
377
</simpara></listitem></varlistentry>
 
378
</variablelist></refsect2>
 
379
<refsect2>
 
380
<title><anchor id="rb-recorder-enabled"/>rb_recorder_enabled ()</title>
 
381
<indexterm><primary>rb_recorder_enabled</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_recorder_enabled             (void);</programlisting>
 
382
<para>
 
383
 
 
384
</para><variablelist role="params">
 
385
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
386
 
 
387
 
 
388
</simpara></listitem></varlistentry>
 
389
</variablelist></refsect2>
 
390
 
 
391
</refsect1>
 
392
 
 
393
 
 
394
 
 
395
 
 
396
</refentry>