← Back to branch summary

~mfisch/brasero/update-to-3.8.0

« back to all changes in this revision

Viewing changes to docs/reference/libbrasero-burn/xml/brasero-track-stream.xml

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2009-09-08 09:33:41 UTC
  • mfrom: (1.1.29 upstream)
  • Revision ID: james.westby@ubuntu.com-20090908093341-jh02q5ba0q8jyu9l
Tags: 2.27.92-0ubuntu1
https://launchpad.net/bugs/425998
https://launchpad.net/bugs/354995
* New upstream release (LP: #425998)
  - Some improvements when handling DVD-RW sequential
  - #593829 - Brasero gets stuck in a loop at "Getting size" while burning another session on a multi-session disk
  - #578466 - Unable to overburn
  - #593314 - Brasero is failing to burn from sftp
  - #593492 - Compilation must be ordered by file name
  - #587122 - Copying DVD - "Error while reading video DVD (no error)"
  - #592026 - brasero crashes when eject a medium
  - #592025 - brasero crashes on detecting src images on a NFS path when preparing burning an image
  - #591880 - Image checksumming causes internal error (LP: #354995)
  - #591397 - Brasero Main window pops up after exiting from Image Burning window.
  - Translation updates
  - lots of small fixes and improvements

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libbrasero-burn/xml/brasero-track-stream.xml
 
1
<refentry id="libbrasero-burn-BraseroTrackStream">
 
2
<refmeta>
 
3
<refentrytitle role="top_of_page" id="libbrasero-burn-BraseroTrackStream.top_of_page">BraseroTrackStream</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>LIBBRASERO-BURN Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>BraseroTrackStream</refname>
 
10
<refpurpose></refpurpose>
 
11
</refnamediv>
 
12
 
 
13
<refsynopsisdiv id="libbrasero-burn-BraseroTrackStream.synopsis" role="synopsis">
 
14
<title role="synopsis.title">Synopsis</title>
 
15
 
 
16
<synopsis>
 
17
                    <link linkend="BraseroTrackStream">BraseroTrackStream</link>;
 
18
<link linkend="BraseroTrackStream">BraseroTrackStream</link> * <link linkend="brasero-track-stream-new">brasero_track_stream_new</link>           (void);
 
19
<link linkend="BraseroBurnResult">BraseroBurnResult</link>   <link linkend="brasero-track-stream-set-source">brasero_track_stream_set_source</link>     (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track,
 
20
                                                         const <link linkend="gchar">gchar</link> *uri);
 
21
<link linkend="BraseroBurnResult">BraseroBurnResult</link>   <link linkend="brasero-track-stream-set-format">brasero_track_stream_set_format</link>     (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track,
 
22
                                                         <link linkend="BraseroStreamFormat">BraseroStreamFormat</link> format);
 
23
<link linkend="BraseroBurnResult">BraseroBurnResult</link>   <link linkend="brasero-track-stream-set-boundaries">brasero_track_stream_set_boundaries</link> (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track,
 
24
                                                         <link linkend="gint64">gint64</link> start,
 
25
                                                         <link linkend="gint64">gint64</link> end,
 
26
                                                         <link linkend="gint64">gint64</link> gap);
 
27
<link linkend="gchar">gchar</link> *             <link linkend="brasero-track-stream-get-source">brasero_track_stream_get_source</link>     (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track,
 
28
                                                         <link linkend="gboolean">gboolean</link> uri);
 
29
<link linkend="BraseroBurnResult">BraseroBurnResult</link>   <link linkend="brasero-track-stream-get-length">brasero_track_stream_get_length</link>     (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track,
 
30
                                                         <link linkend="guint64">guint64</link> *length);
 
31
<link linkend="guint64">guint64</link>             <link linkend="brasero-track-stream-get-start">brasero_track_stream_get_start</link>      (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track);
 
32
<link linkend="guint64">guint64</link>             <link linkend="brasero-track-stream-get-end">brasero_track_stream_get_end</link>        (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track);
 
33
<link linkend="guint64">guint64</link>             <link linkend="brasero-track-stream-get-gap">brasero_track_stream_get_gap</link>        (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track);
 
34
<link linkend="BraseroStreamFormat">BraseroStreamFormat</link>  <link linkend="brasero-track-stream-get-format">brasero_track_stream_get_format</link>    (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track);
 
35
</synopsis>
 
36
</refsynopsisdiv>
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
<refsect1 id="libbrasero-burn-BraseroTrackStream.description" role="desc">
 
47
<title role="desc.title">Description</title>
 
48
<para>
 
49
</para>
 
50
</refsect1>
 
51
 
 
52
<refsect1 id="libbrasero-burn-BraseroTrackStream.details" role="details">
 
53
<title role="details.title">Details</title>
 
54
<refsect2 id="BraseroTrackStream" role="struct">
 
55
<title>BraseroTrackStream</title>
 
56
<indexterm zone="BraseroTrackStream"><primary sortas="BraseroTrackStream">BraseroTrackStream</primary></indexterm><programlisting>typedef struct {
 
57
        BraseroTrack parent_instance;
 
58
} BraseroTrackStream;
 
59
</programlisting>
 
60
<para>
 
61
</para></refsect2>
 
62
<refsect2 id="brasero-track-stream-new" role="function">
 
63
<title>brasero_track_stream_new ()</title>
 
64
<indexterm zone="brasero-track-stream-new"><primary sortas="brasero_track_stream_new">brasero_track_stream_new</primary></indexterm><programlisting><link linkend="BraseroTrackStream">BraseroTrackStream</link> * brasero_track_stream_new           (void);</programlisting>
 
65
<para>
 
66
Creates a new <link linkend="BraseroTrackStream"><type>BraseroTrackStream</type></link> object.
 
67
</para>
 
68
<para>
 
69
This type of tracks is used to burn audio or
 
70
video files.</para>
 
71
<para>
 
72
</para><variablelist role="params">
 
73
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroTrackStream"><type>BraseroTrackStream</type></link> object.
 
74
</simpara></listitem></varlistentry>
 
75
</variablelist></refsect2>
 
76
<refsect2 id="brasero-track-stream-set-source" role="function">
 
77
<title>brasero_track_stream_set_source ()</title>
 
78
<indexterm zone="brasero-track-stream-set-source"><primary sortas="brasero_track_stream_set_source">brasero_track_stream_set_source</primary></indexterm><programlisting><link linkend="BraseroBurnResult">BraseroBurnResult</link>   brasero_track_stream_set_source     (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track,
 
79
                                                         const <link linkend="gchar">gchar</link> *uri);</programlisting>
 
80
<para>
 
81
Sets the stream (song or video) uri.</para>
 
82
<para>
 
83
</para><variablelist role="params">
 
84
<varlistentry><term><parameter>track</parameter>&#160;:</term>
 
85
<listitem><simpara> a <link linkend="BraseroTrackStream"><type>BraseroTrackStream</type></link>
 
86
</simpara></listitem></varlistentry>
 
87
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
 
88
<listitem><simpara> a <link linkend="gchar"><type>gchar</type></link>
 
89
</simpara></listitem></varlistentry>
 
90
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroBurnResult"><type>BraseroBurnResult</type></link>. BRASERO_BURN_OK if it is successful.
 
91
</simpara></listitem></varlistentry>
 
92
</variablelist></refsect2>
 
93
<refsect2 id="brasero-track-stream-set-format" role="function">
 
94
<title>brasero_track_stream_set_format ()</title>
 
95
<indexterm zone="brasero-track-stream-set-format"><primary sortas="brasero_track_stream_set_format">brasero_track_stream_set_format</primary></indexterm><programlisting><link linkend="BraseroBurnResult">BraseroBurnResult</link>   brasero_track_stream_set_format     (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track,
 
96
                                                         <link linkend="BraseroStreamFormat">BraseroStreamFormat</link> format);</programlisting>
 
97
<para>
 
98
Sets the format of the stream.</para>
 
99
<para>
 
100
</para><variablelist role="params">
 
101
<varlistentry><term><parameter>track</parameter>&#160;:</term>
 
102
<listitem><simpara> a <link linkend="BraseroTrackStream"><type>BraseroTrackStream</type></link>
 
103
</simpara></listitem></varlistentry>
 
104
<varlistentry><term><parameter>format</parameter>&#160;:</term>
 
105
<listitem><simpara> a <link linkend="BraseroStreamFormat"><type>BraseroStreamFormat</type></link>
 
106
</simpara></listitem></varlistentry>
 
107
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroBurnResult"><type>BraseroBurnResult</type></link>. BRASERO_BURN_OK if it is successful.
 
108
</simpara></listitem></varlistentry>
 
109
</variablelist></refsect2>
 
110
<refsect2 id="brasero-track-stream-set-boundaries" role="function">
 
111
<title>brasero_track_stream_set_boundaries ()</title>
 
112
<indexterm zone="brasero-track-stream-set-boundaries"><primary sortas="brasero_track_stream_set_boundaries">brasero_track_stream_set_boundaries</primary></indexterm><programlisting><link linkend="BraseroBurnResult">BraseroBurnResult</link>   brasero_track_stream_set_boundaries (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track,
 
113
                                                         <link linkend="gint64">gint64</link> start,
 
114
                                                         <link linkend="gint64">gint64</link> end,
 
115
                                                         <link linkend="gint64">gint64</link> gap);</programlisting>
 
116
<para>
 
117
Sets the boundaries of the stream (where it starts, ends in the file;
 
118
how long is the gap with the next track) in nano seconds.</para>
 
119
<para>
 
120
</para><variablelist role="params">
 
121
<varlistentry><term><parameter>track</parameter>&#160;:</term>
 
122
<listitem><simpara> a <link linkend="BraseroTrackStream"><type>BraseroTrackStream</type></link>
 
123
</simpara></listitem></varlistentry>
 
124
<varlistentry><term><parameter>start</parameter>&#160;:</term>
 
125
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> or -1 to ignore
 
126
</simpara></listitem></varlistentry>
 
127
<varlistentry><term><parameter>end</parameter>&#160;:</term>
 
128
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> or -1 to ignore
 
129
</simpara></listitem></varlistentry>
 
130
<varlistentry><term><parameter>gap</parameter>&#160;:</term>
 
131
<listitem><simpara> a <link linkend="gint64"><type>gint64</type></link> or -1 to ignore
 
132
</simpara></listitem></varlistentry>
 
133
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroBurnResult"><type>BraseroBurnResult</type></link>. BRASERO_BURN_OK if it is successful.
 
134
</simpara></listitem></varlistentry>
 
135
</variablelist></refsect2>
 
136
<refsect2 id="brasero-track-stream-get-source" role="function">
 
137
<title>brasero_track_stream_get_source ()</title>
 
138
<indexterm zone="brasero-track-stream-get-source"><primary sortas="brasero_track_stream_get_source">brasero_track_stream_get_source</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             brasero_track_stream_get_source     (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track,
 
139
                                                         <link linkend="gboolean">gboolean</link> uri);</programlisting>
 
140
<para>
 
141
This function returns the path or the URI (if <parameter>uri</parameter> is TRUE)
 
142
of the stream (song or video file).</para>
 
143
<para>
 
144
</para><variablelist role="params">
 
145
<varlistentry><term><parameter>track</parameter>&#160;:</term>
 
146
<listitem><simpara> a <link linkend="BraseroTrackStream"><type>BraseroTrackStream</type></link>
 
147
</simpara></listitem></varlistentry>
 
148
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
 
149
<listitem><simpara> a <link linkend="gboolean"><type>gboolean</type></link>
 
150
</simpara></listitem></varlistentry>
 
151
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="gchar"><type>gchar</type></link>.
 
152
</simpara></listitem></varlistentry>
 
153
</variablelist></refsect2>
 
154
<refsect2 id="brasero-track-stream-get-length" role="function">
 
155
<title>brasero_track_stream_get_length ()</title>
 
156
<indexterm zone="brasero-track-stream-get-length"><primary sortas="brasero_track_stream_get_length">brasero_track_stream_get_length</primary></indexterm><programlisting><link linkend="BraseroBurnResult">BraseroBurnResult</link>   brasero_track_stream_get_length     (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track,
 
157
                                                         <link linkend="guint64">guint64</link> *length);</programlisting>
 
158
<para>
 
159
This function returns the length of the stream (in nano seconds)
 
160
taking into account the start and end time as well as the length
 
161
of the gap. It stores it in <parameter>length</parameter>.</para>
 
162
<para>
 
163
</para><variablelist role="params">
 
164
<varlistentry><term><parameter>track</parameter>&#160;:</term>
 
165
<listitem><simpara> a <link linkend="BraseroTrackStream"><type>BraseroTrackStream</type></link>
 
166
</simpara></listitem></varlistentry>
 
167
<varlistentry><term><parameter>length</parameter>&#160;:</term>
 
168
<listitem><simpara> a <link linkend="guint64"><type>guint64</type></link>
 
169
</simpara></listitem></varlistentry>
 
170
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroBurnResult"><type>BraseroBurnResult</type></link>. BRASERO_BURN_OK if <parameter>length</parameter> was set.
 
171
</simpara></listitem></varlistentry>
 
172
</variablelist></refsect2>
 
173
<refsect2 id="brasero-track-stream-get-start" role="function">
 
174
<title>brasero_track_stream_get_start ()</title>
 
175
<indexterm zone="brasero-track-stream-get-start"><primary sortas="brasero_track_stream_get_start">brasero_track_stream_get_start</primary></indexterm><programlisting><link linkend="guint64">guint64</link>             brasero_track_stream_get_start      (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track);</programlisting>
 
176
<para>
 
177
This function returns start time in the stream (in nano seconds).</para>
 
178
<para>
 
179
</para><variablelist role="params">
 
180
<varlistentry><term><parameter>track</parameter>&#160;:</term>
 
181
<listitem><simpara> a <link linkend="BraseroTrackStream"><type>BraseroTrackStream</type></link>
 
182
</simpara></listitem></varlistentry>
 
183
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="guint64"><type>guint64</type></link>.
 
184
</simpara></listitem></varlistentry>
 
185
</variablelist></refsect2>
 
186
<refsect2 id="brasero-track-stream-get-end" role="function">
 
187
<title>brasero_track_stream_get_end ()</title>
 
188
<indexterm zone="brasero-track-stream-get-end"><primary sortas="brasero_track_stream_get_end">brasero_track_stream_get_end</primary></indexterm><programlisting><link linkend="guint64">guint64</link>             brasero_track_stream_get_end        (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track);</programlisting>
 
189
<para>
 
190
This function returns end time in the stream (in nano seconds).</para>
 
191
<para>
 
192
</para><variablelist role="params">
 
193
<varlistentry><term><parameter>track</parameter>&#160;:</term>
 
194
<listitem><simpara> a <link linkend="BraseroTrackStream"><type>BraseroTrackStream</type></link>
 
195
</simpara></listitem></varlistentry>
 
196
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="guint64"><type>guint64</type></link>.
 
197
</simpara></listitem></varlistentry>
 
198
</variablelist></refsect2>
 
199
<refsect2 id="brasero-track-stream-get-gap" role="function">
 
200
<title>brasero_track_stream_get_gap ()</title>
 
201
<indexterm zone="brasero-track-stream-get-gap"><primary sortas="brasero_track_stream_get_gap">brasero_track_stream_get_gap</primary></indexterm><programlisting><link linkend="guint64">guint64</link>             brasero_track_stream_get_gap        (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track);</programlisting>
 
202
<para>
 
203
This function returns length of the gap (in nano seconds).</para>
 
204
<para>
 
205
</para><variablelist role="params">
 
206
<varlistentry><term><parameter>track</parameter>&#160;:</term>
 
207
<listitem><simpara> a <link linkend="BraseroTrackStream"><type>BraseroTrackStream</type></link>
 
208
</simpara></listitem></varlistentry>
 
209
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="guint64"><type>guint64</type></link>.
 
210
</simpara></listitem></varlistentry>
 
211
</variablelist></refsect2>
 
212
<refsect2 id="brasero-track-stream-get-format" role="function">
 
213
<title>brasero_track_stream_get_format ()</title>
 
214
<indexterm zone="brasero-track-stream-get-format"><primary sortas="brasero_track_stream_get_format">brasero_track_stream_get_format</primary></indexterm><programlisting><link linkend="BraseroStreamFormat">BraseroStreamFormat</link>  brasero_track_stream_get_format    (<link linkend="BraseroTrackStream">BraseroTrackStream</link> *track);</programlisting>
 
215
<para>
 
216
This function returns the format of the stream.</para>
 
217
<para>
 
218
</para><variablelist role="params">
 
219
<varlistentry><term><parameter>track</parameter>&#160;:</term>
 
220
<listitem><simpara> a <link linkend="BraseroTrackStream"><type>BraseroTrackStream</type></link>
 
221
</simpara></listitem></varlistentry>
 
222
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroStreamFormat"><type>BraseroStreamFormat</type></link>.
 
223
</simpara></listitem></varlistentry>
 
224
</variablelist></refsect2>
 
225
 
 
226
</refsect1>
 
227
 
 
228
 
 
229
 
 
230
 
 
231
</refentry>