← 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-burn-lib.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-burn-lib.xml
 
1
<refentry id="libbrasero-burn-brasero-burn-lib">
 
2
<refmeta>
 
3
<refentrytitle role="top_of_page" id="libbrasero-burn-brasero-burn-lib.top_of_page">brasero-burn-lib</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>LIBBRASERO-BURN Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>brasero-burn-lib</refname>
 
10
<refpurpose></refpurpose>
 
11
</refnamediv>
 
12
 
 
13
<refsynopsisdiv id="libbrasero-burn-brasero-burn-lib.synopsis" role="synopsis">
 
14
<title role="synopsis.title">Synopsis</title>
 
15
 
 
16
<synopsis>
 
17
#define             <link linkend="LIBBRASERO-BURN-VERSION-MAJOR--CAPS">LIBBRASERO_BURN_VERSION_MAJOR</link>
 
18
#define             <link linkend="LIBBRASERO-BURN-VERSION-MINOR--CAPS">LIBBRASERO_BURN_VERSION_MINOR</link>
 
19
#define             <link linkend="LIBBRASERO-BURN-VERSION-MICRO--CAPS">LIBBRASERO_BURN_VERSION_MICRO</link>
 
20
#define             <link linkend="LIBBRASERO-BURN-AGE--CAPS">LIBBRASERO_BURN_AGE</link>
 
21
<link linkend="gboolean">gboolean</link>            <link linkend="brasero-burn-library-start">brasero_burn_library_start</link>          (<link linkend="int">int</link> *argc,
 
22
                                                         <link linkend="char">char</link> **argv[]);
 
23
<link linkend="void">void</link>                <link linkend="brasero-burn-library-stop">brasero_burn_library_stop</link>           (void);
 
24
<link linkend="GOptionGroup">GOptionGroup</link> *      <link linkend="brasero-burn-library-get-option-group">brasero_burn_library_get_option_group</link>
 
25
                                                        (void);
 
26
<link linkend="GSList">GSList</link> *            <link linkend="brasero-burn-library-get-plugins-list">brasero_burn_library_get_plugins_list</link>
 
27
                                                        (void);
 
28
<link linkend="gboolean">gboolean</link>            <link linkend="brasero-burn-library-can-checksum">brasero_burn_library_can_checksum</link>   (void);
 
29
<link linkend="BraseroBurnResult">BraseroBurnResult</link>   <link linkend="brasero-burn-library-input-supported">brasero_burn_library_input_supported</link>
 
30
                                                        (<link linkend="BraseroTrackType">BraseroTrackType</link> *type);
 
31
<link linkend="BraseroMedia">BraseroMedia</link>        <link linkend="brasero-burn-library-get-media-capabilities">brasero_burn_library_get_media_capabilities</link>
 
32
                                                        (<link linkend="BraseroMedia">BraseroMedia</link> media);
 
33
</synopsis>
 
34
</refsynopsisdiv>
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
<refsect1 id="libbrasero-burn-brasero-burn-lib.description" role="desc">
 
45
<title role="desc.title">Description</title>
 
46
<para>
 
47
</para>
 
48
</refsect1>
 
49
 
 
50
<refsect1 id="libbrasero-burn-brasero-burn-lib.details" role="details">
 
51
<title role="details.title">Details</title>
 
52
<refsect2 id="LIBBRASERO-BURN-VERSION-MAJOR--CAPS" role="macro">
 
53
<title>LIBBRASERO_BURN_VERSION_MAJOR</title>
 
54
<indexterm zone="LIBBRASERO-BURN-VERSION-MAJOR--CAPS"><primary sortas="LIBBRASERO_BURN_VERSION_MAJOR">LIBBRASERO_BURN_VERSION_MAJOR</primary></indexterm><programlisting>#define             LIBBRASERO_BURN_VERSION_MAJOR</programlisting>
 
55
<para>
 
56
</para></refsect2>
 
57
<refsect2 id="LIBBRASERO-BURN-VERSION-MINOR--CAPS" role="macro">
 
58
<title>LIBBRASERO_BURN_VERSION_MINOR</title>
 
59
<indexterm zone="LIBBRASERO-BURN-VERSION-MINOR--CAPS"><primary sortas="LIBBRASERO_BURN_VERSION_MINOR">LIBBRASERO_BURN_VERSION_MINOR</primary></indexterm><programlisting>#define             LIBBRASERO_BURN_VERSION_MINOR</programlisting>
 
60
<para>
 
61
</para></refsect2>
 
62
<refsect2 id="LIBBRASERO-BURN-VERSION-MICRO--CAPS" role="macro">
 
63
<title>LIBBRASERO_BURN_VERSION_MICRO</title>
 
64
<indexterm zone="LIBBRASERO-BURN-VERSION-MICRO--CAPS"><primary sortas="LIBBRASERO_BURN_VERSION_MICRO">LIBBRASERO_BURN_VERSION_MICRO</primary></indexterm><programlisting>#define             LIBBRASERO_BURN_VERSION_MICRO</programlisting>
 
65
<para>
 
66
</para></refsect2>
 
67
<refsect2 id="LIBBRASERO-BURN-AGE--CAPS" role="macro">
 
68
<title>LIBBRASERO_BURN_AGE</title>
 
69
<indexterm zone="LIBBRASERO-BURN-AGE--CAPS"><primary sortas="LIBBRASERO_BURN_AGE">LIBBRASERO_BURN_AGE</primary></indexterm><programlisting>#define             LIBBRASERO_BURN_AGE</programlisting>
 
70
<para>
 
71
</para></refsect2>
 
72
<refsect2 id="brasero-burn-library-start" role="function">
 
73
<title>brasero_burn_library_start ()</title>
 
74
<indexterm zone="brasero-burn-library-start"><primary sortas="brasero_burn_library_start">brasero_burn_library_start</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            brasero_burn_library_start          (<link linkend="int">int</link> *argc,
 
75
                                                         <link linkend="char">char</link> **argv[]);</programlisting>
 
76
<para>
 
77
</para><variablelist role="params">
 
78
<varlistentry><term><parameter>argc</parameter>&#160;:</term>
 
79
<listitem><simpara>
 
80
</simpara></listitem></varlistentry>
 
81
<varlistentry><term><parameter>argv</parameter>&#160;:</term>
 
82
<listitem><simpara>
 
83
</simpara></listitem></varlistentry>
 
84
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
 
85
</simpara></listitem></varlistentry>
 
86
</variablelist></refsect2>
 
87
<refsect2 id="brasero-burn-library-stop" role="function">
 
88
<title>brasero_burn_library_stop ()</title>
 
89
<indexterm zone="brasero-burn-library-stop"><primary sortas="brasero_burn_library_stop">brasero_burn_library_stop</primary></indexterm><programlisting><link linkend="void">void</link>                brasero_burn_library_stop           (void);</programlisting>
 
90
<para>
 
91
</para></refsect2>
 
92
<refsect2 id="brasero-burn-library-get-option-group" role="function">
 
93
<title>brasero_burn_library_get_option_group ()</title>
 
94
<indexterm zone="brasero-burn-library-get-option-group"><primary sortas="brasero_burn_library_get_option_group">brasero_burn_library_get_option_group</primary></indexterm><programlisting><link linkend="GOptionGroup">GOptionGroup</link> *      brasero_burn_library_get_option_group
 
95
                                                        (void);</programlisting>
 
96
<para>
 
97
Returns a GOptionGroup for the commandline arguments recognized by libbrasero-burn.
 
98
You should add this to your GOptionContext if your are using <link linkend="g-option-context-parse"><function>g_option_context_parse()</function></link>
 
99
to parse your commandline arguments.</para>
 
100
<para>
 
101
</para><variablelist role="params">
 
102
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GOptionGroup"><type>GOptionGroup</type></link> *
 
103
</simpara></listitem></varlistentry>
 
104
</variablelist></refsect2>
 
105
<refsect2 id="brasero-burn-library-get-plugins-list" role="function">
 
106
<title>brasero_burn_library_get_plugins_list ()</title>
 
107
<indexterm zone="brasero-burn-library-get-plugins-list"><primary sortas="brasero_burn_library_get_plugins_list">brasero_burn_library_get_plugins_list</primary></indexterm><programlisting><link linkend="GSList">GSList</link> *            brasero_burn_library_get_plugins_list
 
108
                                                        (void);</programlisting>
 
109
<para>
 
110
This function returns the list of plugins that 
 
111
are available to libbrasero-burn.</para>
 
112
<para>
 
113
</para><variablelist role="params">
 
114
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GSList"><type>GSList</type></link> that must be destroyed when not needed and each object unreffed.
 
115
</simpara></listitem></varlistentry>
 
116
</variablelist></refsect2>
 
117
<refsect2 id="brasero-burn-library-can-checksum" role="function">
 
118
<title>brasero_burn_library_can_checksum ()</title>
 
119
<indexterm zone="brasero-burn-library-can-checksum"><primary sortas="brasero_burn_library_can_checksum">brasero_burn_library_can_checksum</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            brasero_burn_library_can_checksum   (void);</programlisting>
 
120
<para>
 
121
</para><variablelist role="params">
 
122
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
 
123
</simpara></listitem></varlistentry>
 
124
</variablelist></refsect2>
 
125
<refsect2 id="brasero-burn-library-input-supported" role="function">
 
126
<title>brasero_burn_library_input_supported ()</title>
 
127
<indexterm zone="brasero-burn-library-input-supported"><primary sortas="brasero_burn_library_input_supported">brasero_burn_library_input_supported</primary></indexterm><programlisting><link linkend="BraseroBurnResult">BraseroBurnResult</link>   brasero_burn_library_input_supported
 
128
                                                        (<link linkend="BraseroTrackType">BraseroTrackType</link> *type);</programlisting>
 
129
<para>
 
130
</para><variablelist role="params">
 
131
<varlistentry><term><parameter>type</parameter>&#160;:</term>
 
132
<listitem><simpara>
 
133
</simpara></listitem></varlistentry>
 
134
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
 
135
</simpara></listitem></varlistentry>
 
136
</variablelist></refsect2>
 
137
<refsect2 id="brasero-burn-library-get-media-capabilities" role="function">
 
138
<title>brasero_burn_library_get_media_capabilities ()</title>
 
139
<indexterm zone="brasero-burn-library-get-media-capabilities"><primary sortas="brasero_burn_library_get_media_capabilities">brasero_burn_library_get_media_capabilities</primary></indexterm><programlisting><link linkend="BraseroMedia">BraseroMedia</link>        brasero_burn_library_get_media_capabilities
 
140
                                                        (<link linkend="BraseroMedia">BraseroMedia</link> media);</programlisting>
 
141
<para>
 
142
</para><variablelist role="params">
 
143
<varlistentry><term><parameter>media</parameter>&#160;:</term>
 
144
<listitem><simpara>
 
145
</simpara></listitem></varlistentry>
 
146
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
 
147
</simpara></listitem></varlistentry>
 
148
</variablelist></refsect2>
 
149
 
 
150
</refsect1>
 
151
 
 
152
 
 
153
 
 
154
 
 
155
</refentry>