← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/brasero/oneiric

« back to all changes in this revision

Viewing changes to docs/reference/libbrasero-burn/html/libbrasero-burn-BraseroBurnSession.html

  • Committer: Package Import Robot
  • Author(s): Rodrigo Moya
  • Date: 2011-09-09 12:27:41 UTC
  • mfrom: (1.1.48 upstream)
  • Revision ID: package-import@ubuntu.com-20110909122741-j98wdzlqbbzcgwl2
Tags: 3.1.90-0ubuntu1
* New upstream release
* debian/watch:
  - Watch .bz2 tarballs
* debian/control:
  - Bump libunity-dev build requirement
* debian/patches/012_appindicator.patch:
* debian/patches/013_unity_launcher_progress.patch:
  - Rebased patches

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libbrasero-burn/html/libbrasero-burn-BraseroBurnSession.html
67
67
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
68
68
<a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-tag-remove" title="brasero_burn_session_tag_remove ()">brasero_burn_session_tag_remove</a>     (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
69
69
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tag</code></em>);
70
 
<a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="returnvalue">BraseroDrive</span></a> *      <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-get-burner" title="brasero_burn_session_get_burner ()">brasero_burn_session_get_burner</a>     (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>);
 
70
<a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="returnvalue">BraseroDrive</span></a> *      <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-get-burner" title="brasero_burn_session_get_burner ()">brasero_burn_session_get_burner</a>     (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>);
71
71
<span class="returnvalue">void</span>                <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-set-burner" title="brasero_burn_session_set_burner ()">brasero_burn_session_set_burner</a>     (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
72
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> *drive</code></em>);
 
72
                                                         <em class="parameter"><code><a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> *drive</code></em>);
73
73
<a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-set-image-output-full" title="brasero_burn_session_set_image_output_full ()">brasero_burn_session_set_image_output_full</a>
74
74
                                                        (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
75
75
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroImageFormat" title="enum BraseroImageFormat"><span class="type">BraseroImageFormat</span></a> format</code></em>,
107
107
<a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a>   <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-output-supported" title="brasero_burn_session_output_supported ()">brasero_burn_session_output_supported</a>
108
108
                                                        (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
109
109
                                                         <em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-track-type.html#BraseroTrackType" title="BraseroTrackType"><span class="type">BraseroTrackType</span></a> *output</code></em>);
110
 
<a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="returnvalue">BraseroMedia</span></a>        <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-get-required-media-type" title="brasero_burn_session_get_required_media_type ()">brasero_burn_session_get_required_media_type</a>
 
110
<a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="returnvalue">BraseroMedia</span></a>        <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-get-required-media-type" title="brasero_burn_session_get_required_media_type ()">brasero_burn_session_get_required_media_type</a>
111
111
                                                        (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>);
112
112
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-get-possible-output-formats" title="brasero_burn_session_get_possible_output_formats ()">brasero_burn_session_get_possible_output_formats</a>
113
113
                                                        (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
510
510
<hr>
511
511
<div class="refsect2">
512
512
<a name="brasero-burn-session-get-burner"></a><h3>brasero_burn_session_get_burner ()</h3>
513
 
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="returnvalue">BraseroDrive</span></a> *      brasero_burn_session_get_burner     (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>);</pre>
 
513
<pre class="programlisting"><a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="returnvalue">BraseroDrive</span></a> *      brasero_burn_session_get_burner     (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>);</pre>
514
514
<p>
515
 
Returns the <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> that should be used to burn the session contents.
 
515
Returns the <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> that should be used to burn the session contents.
516
516
</p>
517
517
<div class="variablelist"><table border="0">
518
518
<col align="left" valign="top">
524
524
</tr>
525
525
<tr>
526
526
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
527
 
<td>a <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> or NULL. Do not unref after use. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
527
<td>a <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> or NULL. Do not unref after use. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
528
528
</td>
529
529
</tr>
530
530
</tbody>
534
534
<div class="refsect2">
535
535
<a name="brasero-burn-session-set-burner"></a><h3>brasero_burn_session_set_burner ()</h3>
536
536
<pre class="programlisting"><span class="returnvalue">void</span>                brasero_burn_session_set_burner     (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
537
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> *drive</code></em>);</pre>
 
537
                                                         <em class="parameter"><code><a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> *drive</code></em>);</pre>
538
538
<p>
539
 
Sets the <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> that should be used to burn the session contents.
 
539
Sets the <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> that should be used to burn the session contents.
540
540
</p>
541
541
<div class="variablelist"><table border="0">
542
542
<col align="left" valign="top">
548
548
</tr>
549
549
<tr>
550
550
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
551
 
<td>a <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a>
 
551
<td>a <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a>
552
552
</td>
553
553
</tr>
554
554
</tbody>
569
569
necessary) and its format.
570
570
</p>
571
571
<p>
572
 
NOTE: after a call to this function the <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> for
573
 
<em class="parameter"><code>session</code></em> will be the fake <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a>.
 
572
NOTE: after a call to this function the <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> for
 
573
<em class="parameter"><code>session</code></em> will be the fake <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a>.
574
574
</p>
575
575
<div class="variablelist"><table border="0">
576
576
<col align="left" valign="top">
614
614
<em class="parameter"><code>image</code></em> and <em class="parameter"><code>toc</code></em> should be freed if not used anymore.
615
615
</p>
616
616
<p>
617
 
NOTE: before using this function a <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> should have been
 
617
NOTE: before using this function a <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> should have been
618
618
set with <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-set-burner" title="brasero_burn_session_set_burner ()"><code class="function">brasero_burn_session_set_burner()</code></a> and it should be the
619
 
fake drive (see <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#brasero-drive-is-fake"><code class="function">brasero_drive_is_fake()</code></a>).
 
619
fake drive (see <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#brasero-drive-is-fake"><code class="function">brasero_drive_is_fake()</code></a>).
620
620
</p>
621
621
<div class="variablelist"><table border="0">
622
622
<col align="left" valign="top">
653
653
file then this function returns the format of the image to write.
654
654
</p>
655
655
<p>
656
 
NOTE: before using this function a <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> should have been
 
656
NOTE: before using this function a <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> should have been
657
657
set with <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-set-burner" title="brasero_burn_session_set_burner ()"><code class="function">brasero_burn_session_set_burner()</code></a> and it should be the
658
 
fake drive (see <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#brasero-drive-is-fake"><code class="function">brasero_drive_is_fake()</code></a>).
 
658
fake drive (see <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#brasero-drive-is-fake"><code class="function">brasero_drive_is_fake()</code></a>).
659
659
</p>
660
660
<div class="variablelist"><table border="0">
661
661
<col align="left" valign="top">
867
867
stores in <em class="parameter"><code>supported</code></em> and <em class="parameter"><code>compulsory</code></em>, the flags
868
868
that can be used (<em class="parameter"><code>supported</code></em>) and must be used
869
869
(<em class="parameter"><code>compulsory</code></em>) when blanking the medium in the
870
 
<a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> (set with <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-set-burner" title="brasero_burn_session_set_burner ()"><code class="function">brasero_burn_session_set_burner()</code></a>).
 
870
<a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> (set with <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-set-burner" title="brasero_burn_session_set_burner ()"><code class="function">brasero_burn_session_set_burner()</code></a>).
871
871
</p>
872
872
<div class="variablelist"><table border="0">
873
873
<col align="left" valign="top">
903
903
<p>
904
904
Given the various parameters stored in <em class="parameter"><code>session</code></em>, this
905
905
function checks whether the medium in the
906
 
<a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> (set with <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-set-burner" title="brasero_burn_session_set_burner ()"><code class="function">brasero_burn_session_set_burner()</code></a>)
 
906
<a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> (set with <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-set-burner" title="brasero_burn_session_set_burner ()"><code class="function">brasero_burn_session_set_burner()</code></a>)
907
907
can be blanked.
908
908
</p>
909
909
<div class="variablelist"><table border="0">
931
931
<p>
932
932
Given the various parameters stored in <em class="parameter"><code>session</code></em>, this
933
933
function checks whether the data contained in <em class="parameter"><code>session</code></em>
934
 
can be burnt to the medium in the <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> (set 
 
934
can be burnt to the medium in the <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> (set 
935
935
through <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-set-burner" title="brasero_burn_session_set_burner ()"><code class="function">brasero_burn_session_set_burner()</code></a>).
936
936
If <em class="parameter"><code>check_flags</code></em> determine the behavior of this function.
937
937
</p>
967
967
<p>
968
968
Given the various parameters stored in <em class="parameter"><code>session</code></em>, this
969
969
function checks whether a session with the data type
970
 
<em class="parameter"><code>type</code></em> could be burnt to the medium in the <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> (set 
 
970
<em class="parameter"><code>type</code></em> could be burnt to the medium in the <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> (set 
971
971
through <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-set-burner" title="brasero_burn_session_set_burner ()"><code class="function">brasero_burn_session_set_burner()</code></a>).
972
972
If <em class="parameter"><code>check_flags</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, then flags are taken into account
973
973
and are not if it is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
1030
1030
<hr>
1031
1031
<div class="refsect2">
1032
1032
<a name="brasero-burn-session-get-required-media-type"></a><h3>brasero_burn_session_get_required_media_type ()</h3>
1033
 
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="returnvalue">BraseroMedia</span></a>        brasero_burn_session_get_required_media_type
 
1033
<pre class="programlisting"><a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="returnvalue">BraseroMedia</span></a>        brasero_burn_session_get_required_media_type
1034
1034
                                                        (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>);</pre>
1035
1035
<p>
1036
1036
Return the medium types that could be used to burn
1046
1046
</tr>
1047
1047
<tr>
1048
1048
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1049
 
<td>a <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a>
 
1049
<td>a <a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a>
1050
1050
</td>
1051
1051
</tr>
1052
1052
</tbody>
1160
1160
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> rate</code></em>);</pre>
1161
1161
<p>
1162
1162
Sets the speed at which the medium should be burnt.
1163
 
NOTE: before using this function a <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> should have been
 
1163
NOTE: before using this function a <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> should have been
1164
1164
set with <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-set-burner" title="brasero_burn_session_set_burner ()"><code class="function">brasero_burn_session_set_burner()</code></a>.
1165
1165
</p>
1166
1166
<div class="variablelist"><table border="0">
1190
1190
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a>             brasero_burn_session_get_rate       (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>);</pre>
1191
1191
<p>
1192
1192
Returns the speed at which the medium should be burnt.
1193
 
NOTE: before using this function a <a href="/usr/share/gtk-doc/html/libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> should have been
 
1193
NOTE: before using this function a <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a> should have been
1194
1194
set with <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-set-burner" title="brasero_burn_session_set_burner ()"><code class="function">brasero_burn_session_set_burner()</code></a>.
1195
1195
</p>
1196
1196
<div class="variablelist"><table border="0">