← 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-track-image-cfg.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-track-image-cfg.xml
1
 
<refentry id="libbrasero-burn-BraseroTrackImageCfg">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="libbrasero-burn-BraseroTrackImageCfg.top_of_page">BraseroTrackImageCfg</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>LIBBRASERO-BURN Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>BraseroTrackImageCfg</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="libbrasero-burn-BraseroTrackImageCfg.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
                    <link linkend="BraseroTrackImageCfg">BraseroTrackImageCfg</link>;
18
 
<link linkend="BraseroTrackImageCfg">BraseroTrackImageCfg</link> * <link linkend="brasero-track-image-cfg-new">brasero_track_image_cfg_new</link>      (void);
19
 
<link linkend="BraseroBurnResult">BraseroBurnResult</link>   <link linkend="brasero-track-image-cfg-set-source">brasero_track_image_cfg_set_source</link>  (<link linkend="BraseroTrackImageCfg">BraseroTrackImageCfg</link> *track,
20
 
                                                         const <link linkend="gchar">gchar</link> *uri);
21
 
<link linkend="BraseroBurnResult">BraseroBurnResult</link>   <link linkend="brasero-track-image-cfg-force-format">brasero_track_image_cfg_force_format</link>
22
 
                                                        (<link linkend="BraseroTrackImageCfg">BraseroTrackImageCfg</link> *track,
23
 
                                                         <link linkend="BraseroImageFormat">BraseroImageFormat</link> format);
24
 
<link linkend="BraseroImageFormat">BraseroImageFormat</link>  <link linkend="brasero-track-image-cfg-get-forced-format">brasero_track_image_cfg_get_forced_format</link>
25
 
                                                        (<link linkend="BraseroTrackImageCfg">BraseroTrackImageCfg</link> *track);
26
 
</synopsis>
27
 
</refsynopsisdiv>
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
<refsect1 id="libbrasero-burn-BraseroTrackImageCfg.description" role="desc">
38
 
<title role="desc.title">Description</title>
39
 
<para>
40
 
</para>
41
 
</refsect1>
42
 
 
43
 
<refsect1 id="libbrasero-burn-BraseroTrackImageCfg.details" role="details">
44
 
<title role="details.title">Details</title>
45
 
<refsect2 id="BraseroTrackImageCfg" role="struct">
46
 
<title>BraseroTrackImageCfg</title>
47
 
<indexterm zone="BraseroTrackImageCfg"><primary sortas="BraseroTrackImageCfg">BraseroTrackImageCfg</primary></indexterm><programlisting>typedef struct {
48
 
        BraseroTrackImage parent_instance;
49
 
} BraseroTrackImageCfg;
50
 
</programlisting>
51
 
<para>
52
 
</para></refsect2>
53
 
<refsect2 id="brasero-track-image-cfg-new" role="function">
54
 
<title>brasero_track_image_cfg_new ()</title>
55
 
<indexterm zone="brasero-track-image-cfg-new"><primary sortas="brasero_track_image_cfg_new">brasero_track_image_cfg_new</primary></indexterm><programlisting><link linkend="BraseroTrackImageCfg">BraseroTrackImageCfg</link> * brasero_track_image_cfg_new      (void);</programlisting>
56
 
<para>
57
 
Creates a new <link linkend="BraseroTrackImageCfg"><type>BraseroTrackImageCfg</type></link> object.</para>
58
 
<para>
59
 
</para><variablelist role="params">
60
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroTrackImageCfg"><type>BraseroTrackImageCfg</type></link> object.
61
 
</simpara></listitem></varlistentry>
62
 
</variablelist></refsect2>
63
 
<refsect2 id="brasero-track-image-cfg-set-source" role="function">
64
 
<title>brasero_track_image_cfg_set_source ()</title>
65
 
<indexterm zone="brasero-track-image-cfg-set-source"><primary sortas="brasero_track_image_cfg_set_source">brasero_track_image_cfg_set_source</primary></indexterm><programlisting><link linkend="BraseroBurnResult">BraseroBurnResult</link>   brasero_track_image_cfg_set_source  (<link linkend="BraseroTrackImageCfg">BraseroTrackImageCfg</link> *track,
66
 
                                                         const <link linkend="gchar">gchar</link> *uri);</programlisting>
67
 
<para>
68
 
Sets the image uri or path (absolute or relative). <parameter>track</parameter> will then identify its format and retrieve its size.</para>
69
 
<para>
70
 
</para><variablelist role="params">
71
 
<varlistentry><term><parameter>track</parameter>&#160;:</term>
72
 
<listitem><simpara> a <link linkend="BraseroTrackImageCfg"><type>BraseroTrackImageCfg</type></link>
73
 
</simpara></listitem></varlistentry>
74
 
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
75
 
<listitem><simpara> a <link linkend="gchar"><type>gchar</type></link>
76
 
</simpara></listitem></varlistentry>
77
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroBurnResult"><type>BraseroBurnResult</type></link>. BRASERO_BURN_OK if it is successful.
78
 
</simpara></listitem></varlistentry>
79
 
</variablelist></refsect2>
80
 
<refsect2 id="brasero-track-image-cfg-force-format" role="function">
81
 
<title>brasero_track_image_cfg_force_format ()</title>
82
 
<indexterm zone="brasero-track-image-cfg-force-format"><primary sortas="brasero_track_image_cfg_force_format">brasero_track_image_cfg_force_format</primary></indexterm><programlisting><link linkend="BraseroBurnResult">BraseroBurnResult</link>   brasero_track_image_cfg_force_format
83
 
                                                        (<link linkend="BraseroTrackImageCfg">BraseroTrackImageCfg</link> *track,
84
 
                                                         <link linkend="BraseroImageFormat">BraseroImageFormat</link> format);</programlisting>
85
 
<para>
86
 
This function allows to prevents the identification of the format of the image.
87
 
It does not cancel size retrieval.
88
 
If <parameter>format</parameter> is BRASERO_IMAGE_FORMAT_NONE then the format of the image
89
 
will be retrieved.</para>
90
 
<para>
91
 
</para><variablelist role="params">
92
 
<varlistentry><term><parameter>track</parameter>&#160;:</term>
93
 
<listitem><simpara> a <link linkend="BraseroTrackImageCfg"><type>BraseroTrackImageCfg</type></link>
94
 
</simpara></listitem></varlistentry>
95
 
<varlistentry><term><parameter>format</parameter>&#160;:</term>
96
 
<listitem><simpara> a <link linkend="BraseroImageFormat"><type>BraseroImageFormat</type></link>
97
 
</simpara></listitem></varlistentry>
98
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroBurnResult"><type>BraseroBurnResult</type></link>. BRASERO_BURN_OK if it is successful.
99
 
</simpara></listitem></varlistentry>
100
 
</variablelist></refsect2>
101
 
<refsect2 id="brasero-track-image-cfg-get-forced-format" role="function">
102
 
<title>brasero_track_image_cfg_get_forced_format ()</title>
103
 
<indexterm zone="brasero-track-image-cfg-get-forced-format"><primary sortas="brasero_track_image_cfg_get_forced_format">brasero_track_image_cfg_get_forced_format</primary></indexterm><programlisting><link linkend="BraseroImageFormat">BraseroImageFormat</link>  brasero_track_image_cfg_get_forced_format
104
 
                                                        (<link linkend="BraseroTrackImageCfg">BraseroTrackImageCfg</link> *track);</programlisting>
105
 
<para>
106
 
This function returns the <link linkend="BraseroImageFormat"><type>BraseroImageFormat</type></link> that was set for the image.
107
 
See <link linkend="brasero-track-image-cfg-force-format"><function>brasero_track_image_cfg_force_format()</function></link>.</para>
108
 
<para>
109
 
</para><variablelist role="params">
110
 
<varlistentry><term><parameter>track</parameter>&#160;:</term>
111
 
<listitem><simpara> a <link linkend="BraseroTrackImageCfg"><type>BraseroTrackImageCfg</type></link>
112
 
</simpara></listitem></varlistentry>
113
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="BraseroBurnResult"><type>BraseroBurnResult</type></link>. BRASERO_BURN_OK if it is successful.
114
 
</simpara></listitem></varlistentry>
115
 
</variablelist></refsect2>
116
 
 
117
 
</refsect1>
118
 
 
119
 
 
120
 
 
121
 
 
122
 
</refentry>