← Back to branch summary

~ubuntu-branches/debian/wheezy/brasero/wheezy

« back to all changes in this revision

Viewing changes to docs/reference/libbrasero-burn/xml/brasero-session-span.xml

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Henriksson
  • Date: 2009-12-14 22:35:03 UTC
  • mfrom: (1.2.17 upstream)
  • Revision ID: james.westby@ubuntu.com-20091214223503-aa2l0jrjl85ar2ue
Tags: 2.28.3-1
New upstream bugfix release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libbrasero-burn/xml/brasero-session-span.xml
1
 
<refentry id="libbrasero-burn-BraseroSessionSpan">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="libbrasero-burn-BraseroSessionSpan.top_of_page">BraseroSessionSpan</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>LIBBRASERO-BURN Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>BraseroSessionSpan</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="libbrasero-burn-BraseroSessionSpan.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
                    <link linkend="BraseroSessionSpan">BraseroSessionSpan</link>;
18
 
<link linkend="BraseroSessionSpan">BraseroSessionSpan</link> * <link linkend="brasero-session-span-new">brasero_session_span_new</link>           (void);
19
 
<link linkend="BraseroBurnResult">BraseroBurnResult</link>   <link linkend="brasero-session-span-again">brasero_session_span_again</link>          (<link linkend="BraseroSessionSpan">BraseroSessionSpan</link> *session);
20
 
<link linkend="BraseroBurnResult">BraseroBurnResult</link>   <link linkend="brasero-session-span-possible">brasero_session_span_possible</link>       (<link linkend="BraseroSessionSpan">BraseroSessionSpan</link> *session);
21
 
<link linkend="BraseroBurnResult">BraseroBurnResult</link>   <link linkend="brasero-session-span-start">brasero_session_span_start</link>          (<link linkend="BraseroSessionSpan">BraseroSessionSpan</link> *session);
22
 
<link linkend="BraseroBurnResult">BraseroBurnResult</link>   <link linkend="brasero-session-span-next">brasero_session_span_next</link>           (<link linkend="BraseroSessionSpan">BraseroSessionSpan</link> *session);
23
 
<link linkend="void">void</link>                <link linkend="brasero-session-span-stop">brasero_session_span_stop</link>           (<link linkend="BraseroSessionSpan">BraseroSessionSpan</link> *session);
24
 
</synopsis>
25
 
</refsynopsisdiv>
26
 
 
27
 
 
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
<refsect1 id="libbrasero-burn-BraseroSessionSpan.description" role="desc">
36
 
<title role="desc.title">Description</title>
37
 
<para>
38
 
</para>
39
 
</refsect1>
40
 
 
41
 
<refsect1 id="libbrasero-burn-BraseroSessionSpan.details" role="details">
42
 
<title role="details.title">Details</title>
43
 
<refsect2 id="BraseroSessionSpan" role="struct">
44
 
<title>BraseroSessionSpan</title>
45
 
<indexterm zone="BraseroSessionSpan"><primary sortas="BraseroSessionSpan">BraseroSessionSpan</primary></indexterm><programlisting>typedef struct {
46
 
        BraseroBurnSession parent_instance;
47
 
} BraseroSessionSpan;
48
 
</programlisting>
49
 
<para>
50
 
</para></refsect2>
51
 
<refsect2 id="brasero-session-span-new" role="function">
52
 
<title>brasero_session_span_new ()</title>
53
 
<indexterm zone="brasero-session-span-new"><primary sortas="brasero_session_span_new">brasero_session_span_new</primary></indexterm><programlisting><link linkend="BraseroSessionSpan">BraseroSessionSpan</link> * brasero_session_span_new           (void);</programlisting>
54
 
<para>
55
 
Creates a new <link linkend="BraseroSessionSpan"><type>BraseroSessionSpan</type></link> object.</para>
56
 
<para>
57
 
</para><variablelist role="params">
58
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroSessionSpan"><type>BraseroSessionSpan</type></link> object
59
 
</simpara></listitem></varlistentry>
60
 
</variablelist></refsect2>
61
 
<refsect2 id="brasero-session-span-again" role="function">
62
 
<title>brasero_session_span_again ()</title>
63
 
<indexterm zone="brasero-session-span-again"><primary sortas="brasero_session_span_again">brasero_session_span_again</primary></indexterm><programlisting><link linkend="BraseroBurnResult">BraseroBurnResult</link>   brasero_session_span_again          (<link linkend="BraseroSessionSpan">BraseroSessionSpan</link> *session);</programlisting>
64
 
<para>
65
 
Checks whether some data were not included during calls to <link linkend="brasero-session-span-next"><function>brasero_session_span_next()</function></link>.</para>
66
 
<para>
67
 
</para><variablelist role="params">
68
 
<varlistentry><term><parameter>session</parameter>&#160;:</term>
69
 
<listitem><simpara> a <link linkend="BraseroSessionSpan"><type>BraseroSessionSpan</type></link>
70
 
</simpara></listitem></varlistentry>
71
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroBurnResult"><type>BraseroBurnResult</type></link>. BRASERO_BURN_OK if there is not anymore data.
72
 
BRASERO_BURN_RETRY if the operation was successful and a new <link linkend="BraseroTrackDataCfg"><type>BraseroTrackDataCfg</type></link> was created.
73
 
BRASERO_BURN_ERR otherwise.
74
 
</simpara></listitem></varlistentry>
75
 
</variablelist></refsect2>
76
 
<refsect2 id="brasero-session-span-possible" role="function">
77
 
<title>brasero_session_span_possible ()</title>
78
 
<indexterm zone="brasero-session-span-possible"><primary sortas="brasero_session_span_possible">brasero_session_span_possible</primary></indexterm><programlisting><link linkend="BraseroBurnResult">BraseroBurnResult</link>   brasero_session_span_possible       (<link linkend="BraseroSessionSpan">BraseroSessionSpan</link> *session);</programlisting>
79
 
<para>
80
 
Checks if a new <link linkend="BraseroTrackData"><type>BraseroTrackData</type></link> can be created from the files remaining in the tree 
81
 
after calls to <link linkend="brasero-session-span-next"><function>brasero_session_span_next()</function></link>. The maximum size of the data will be the one
82
 
of the medium inserted in the <link linkend="BraseroDrive"><type>BraseroDrive</type></link> set for <parameter>session</parameter> (see <link linkend="brasero-burn-session-set-burner"><function>brasero_burn_session_set_burner()</function></link>).</para>
83
 
<para>
84
 
</para><variablelist role="params">
85
 
<varlistentry><term><parameter>session</parameter>&#160;:</term>
86
 
<listitem><simpara> a <link linkend="BraseroSessionSpan"><type>BraseroSessionSpan</type></link>
87
 
</simpara></listitem></varlistentry>
88
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroBurnResult"><type>BraseroBurnResult</type></link>. BRASERO_BURN_OK if there is not anymore data.
89
 
BRASERO_BURN_RETRY if the operation was successful and a new <link linkend="BraseroTrackDataCfg"><type>BraseroTrackDataCfg</type></link> was created.
90
 
BRASERO_BURN_ERR otherwise.
91
 
</simpara></listitem></varlistentry>
92
 
</variablelist></refsect2>
93
 
<refsect2 id="brasero-session-span-start" role="function">
94
 
<title>brasero_session_span_start ()</title>
95
 
<indexterm zone="brasero-session-span-start"><primary sortas="brasero_session_span_start">brasero_session_span_start</primary></indexterm><programlisting><link linkend="BraseroBurnResult">BraseroBurnResult</link>   brasero_session_span_start          (<link linkend="BraseroSessionSpan">BraseroSessionSpan</link> *session);</programlisting>
96
 
<para>
97
 
Get the object ready for spanning a <link linkend="BraseroBurnSession"><type>BraseroBurnSession</type></link> object. This function
98
 
must be called before <link linkend="brasero-session-span-next"><function>brasero_session_span_next()</function></link>.</para>
99
 
<para>
100
 
</para><variablelist role="params">
101
 
<varlistentry><term><parameter>session</parameter>&#160;:</term>
102
 
<listitem><simpara> a <link linkend="BraseroSessionSpan"><type>BraseroSessionSpan</type></link>
103
 
</simpara></listitem></varlistentry>
104
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroBurnResult"><type>BraseroBurnResult</type></link>. BRASERO_BURN_OK if successful.
105
 
</simpara></listitem></varlistentry>
106
 
</variablelist></refsect2>
107
 
<refsect2 id="brasero-session-span-next" role="function">
108
 
<title>brasero_session_span_next ()</title>
109
 
<indexterm zone="brasero-session-span-next"><primary sortas="brasero_session_span_next">brasero_session_span_next</primary></indexterm><programlisting><link linkend="BraseroBurnResult">BraseroBurnResult</link>   brasero_session_span_next           (<link linkend="BraseroSessionSpan">BraseroSessionSpan</link> *session);</programlisting>
110
 
<para>
111
 
Sets the next batch of data to be burnt onto the medium inserted in the <link linkend="BraseroDrive"><type>BraseroDrive</type></link>
112
 
set for <parameter>session</parameter> (see <link linkend="brasero-burn-session-set-burner"><function>brasero_burn_session_set_burner()</function></link>). Its free space or it capacity
113
 
will be used as the maximum amount of data to be burnt.</para>
114
 
<para>
115
 
</para><variablelist role="params">
116
 
<varlistentry><term><parameter>session</parameter>&#160;:</term>
117
 
<listitem><simpara> a <link linkend="BraseroSessionSpan"><type>BraseroSessionSpan</type></link>
118
 
</simpara></listitem></varlistentry>
119
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroBurnResult"><type>BraseroBurnResult</type></link>. BRASERO_BURN_OK if successful.
120
 
</simpara></listitem></varlistentry>
121
 
</variablelist></refsect2>
122
 
<refsect2 id="brasero-session-span-stop" role="function">
123
 
<title>brasero_session_span_stop ()</title>
124
 
<indexterm zone="brasero-session-span-stop"><primary sortas="brasero_session_span_stop">brasero_session_span_stop</primary></indexterm><programlisting><link linkend="void">void</link>                brasero_session_span_stop           (<link linkend="BraseroSessionSpan">BraseroSessionSpan</link> *session);</programlisting>
125
 
<para>
126
 
Ends and cleans a spanning operation started with <link linkend="brasero-session-span-start"><function>brasero_session_span_start()</function></link>.</para>
127
 
<para>
128
 
</para><variablelist role="params">
129
 
<varlistentry><term><parameter>session</parameter>&#160;:</term>
130
 
<listitem><simpara> a <link linkend="BraseroSessionSpan"><type>BraseroSessionSpan</type></link>
131
 
</simpara></listitem></varlistentry>
132
 
</variablelist></refsect2>
133
 
 
134
 
</refsect1>
135
 
 
136
 
 
137
 
 
138
 
 
139
 
</refentry>