1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GUPnP DLNA Values</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GUPnP DLNA Reference Manual">
8 <link rel="up" href="ch01.html" title="GUPnP DLNA">
9 <link rel="prev" href="GUPnPDLNAInformation.html" title="GUPnPDLNAInformation">
10 <link rel="next" href="GUPnPDLNAAudioInformation.html" title="GUPnPDLNAAudioInformation">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="GUPnPDLNAInformation.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GUPnP DLNA Reference Manual</th>
21 <td><a accesskey="n" href="GUPnPDLNAAudioInformation.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gupnp-dlna-GUPnP-DLNA-Values.synopsis" class="shortcut">Top</a>
26 <a href="#gupnp-dlna-GUPnP-DLNA-Values.description" class="shortcut">Description</a>
29 <div class="refentry">
30 <a name="gupnp-dlna-GUPnP-DLNA-Values"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
33 <h2><span class="refentrytitle"><a name="gupnp-dlna-GUPnP-DLNA-Values.top_of_page"></a>GUPnP DLNA Values</span></h2>
34 <p>GUPnP DLNA Values — State values for metadata attributes.</p>
36 <td valign="top" align="right"></td>
38 <div class="refsynopsisdiv">
39 <a name="gupnp-dlna-GUPnP-DLNA-Values.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">#define <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPNP-DLNA-BOOL-VALUE-UNSET:CAPS" title="GUPNP_DLNA_BOOL_VALUE_UNSET">GUPNP_DLNA_BOOL_VALUE_UNSET</a>
41 #define <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPNP-DLNA-BOOL-VALUE-UNSUPPORTED:CAPS" title="GUPNP_DLNA_BOOL_VALUE_UNSUPPORTED">GUPNP_DLNA_BOOL_VALUE_UNSUPPORTED</a>
42 #define <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPNP-DLNA-FRACTION-VALUE-UNSET:CAPS" title="GUPNP_DLNA_FRACTION_VALUE_UNSET">GUPNP_DLNA_FRACTION_VALUE_UNSET</a>
43 #define <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPNP-DLNA-FRACTION-VALUE-UNSUPPORTED:CAPS" title="GUPNP_DLNA_FRACTION_VALUE_UNSUPPORTED">GUPNP_DLNA_FRACTION_VALUE_UNSUPPORTED</a>
44 #define <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPNP-DLNA-INT-VALUE-UNSET:CAPS" title="GUPNP_DLNA_INT_VALUE_UNSET">GUPNP_DLNA_INT_VALUE_UNSET</a>
45 #define <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPNP-DLNA-INT-VALUE-UNSUPPORTED:CAPS" title="GUPNP_DLNA_INT_VALUE_UNSUPPORTED">GUPNP_DLNA_INT_VALUE_UNSUPPORTED</a>
46 #define <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPNP-DLNA-STRING-VALUE-UNSET:CAPS" title="GUPNP_DLNA_STRING_VALUE_UNSET">GUPNP_DLNA_STRING_VALUE_UNSET</a>
47 #define <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPNP-DLNA-STRING-VALUE-UNSUPPORTED:CAPS" title="GUPNP_DLNA_STRING_VALUE_UNSUPPORTED">GUPNP_DLNA_STRING_VALUE_UNSUPPORTED</a>
48 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNABoolValue" title="GUPnPDLNABoolValue">GUPnPDLNABoolValue</a>;
49 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAFractionValue" title="GUPnPDLNAFractionValue">GUPnPDLNAFractionValue</a>;
50 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue">GUPnPDLNAIntValue</a>;
51 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue">GUPnPDLNAStringValue</a>;
52 enum <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAValueState" title="enum GUPnPDLNAValueState">GUPnPDLNAValueState</a>;
55 <div class="refsect1">
56 <a name="gupnp-dlna-GUPnP-DLNA-Values.description"></a><h2>Description</h2>
58 The <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNABoolValue" title="GUPnPDLNABoolValue"><span class="type">GUPnPDLNABoolValue</span></a>, <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAFractionValue" title="GUPnPDLNAFractionValue"><span class="type">GUPnPDLNAFractionValue</span></a>,
59 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue"><span class="type">GUPnPDLNAIntValue</span></a> and <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue"><span class="type">GUPnPDLNAStringValue</span></a> hold respectively
60 boolean, fraction, integer and string values.
63 The value can be in one of three possible states - set, unset or
64 unsupported. When value is in set state it is possible to use the
65 underlying value it holds. In other states using such value is
69 Main difference between unset state and unsupported state is that
70 the former is set when metadata extractor is capable of extracting
71 some attribute in general, but current media file does not have
72 such attribute, while the latter means that metadata extractor has
73 no idea how to extract such attribute at all.
76 One note on <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue"><span class="type">GUPnPDLNAStringValue</span></a> - it holds a string that has to
77 be allocated with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-malloc"><code class="function">g_malloc()</code></a> (that is - <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strdup"><code class="function">g_strdup()</code></a> and others are
78 fine as well as they use <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-malloc"><code class="function">g_malloc()</code></a> internally). The string is
82 <div class="refsect1">
83 <a name="gupnp-dlna-GUPnP-DLNA-Values.details"></a><h2>Details</h2>
84 <div class="refsect2">
85 <a name="GUPNP-DLNA-BOOL-VALUE-UNSET:CAPS"></a><h3>GUPNP_DLNA_BOOL_VALUE_UNSET</h3>
86 <pre class="programlisting">#define GUPNP_DLNA_BOOL_VALUE_UNSET</pre>
88 Static initializer for unset <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNABoolValue" title="GUPnPDLNABoolValue"><span class="type">GUPnPDLNABoolValue</span></a>. Can be used in
93 <div class="informalexample"><pre class="programlisting">
94 GUPnPDLNABoolValue value = GUPNP_DLNA_BOOL_VALUE_UNSET;
103 <div class="informalexample"><pre class="programlisting">
104 return GUPNP_DLNA_BOOL_VALUE_UNSET;
110 <div class="refsect2">
111 <a name="GUPNP-DLNA-BOOL-VALUE-UNSUPPORTED:CAPS"></a><h3>GUPNP_DLNA_BOOL_VALUE_UNSUPPORTED</h3>
112 <pre class="programlisting">#define GUPNP_DLNA_BOOL_VALUE_UNSUPPORTED</pre>
114 Static initializer for unsupported <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNABoolValue" title="GUPnPDLNABoolValue"><span class="type">GUPnPDLNABoolValue</span></a>. Can be used
119 <div class="informalexample"><pre class="programlisting">
120 GUPnPDLNABoolValue value = GUPNP_DLNA_BOOL_VALUE_UNSUPPORTED;
129 <div class="informalexample"><pre class="programlisting">
130 return GUPNP_DLNA_BOOL_VALUE_UNSUPPORTED;
136 <div class="refsect2">
137 <a name="GUPNP-DLNA-FRACTION-VALUE-UNSET:CAPS"></a><h3>GUPNP_DLNA_FRACTION_VALUE_UNSET</h3>
138 <pre class="programlisting">#define GUPNP_DLNA_FRACTION_VALUE_UNSET</pre>
140 Static initializer for unset <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAFractionValue" title="GUPnPDLNAFractionValue"><span class="type">GUPnPDLNAFractionValue</span></a>. Can be used
145 <div class="informalexample"><pre class="programlisting">
146 GUPnPDLNAFractionValue value = GUPNP_DLNA_FRACTION_VALUE_UNSET;
155 <div class="informalexample"><pre class="programlisting">
156 return GUPNP_DLNA_FRACTION_VALUE_UNSET;
162 <div class="refsect2">
163 <a name="GUPNP-DLNA-FRACTION-VALUE-UNSUPPORTED:CAPS"></a><h3>GUPNP_DLNA_FRACTION_VALUE_UNSUPPORTED</h3>
164 <pre class="programlisting">#define GUPNP_DLNA_FRACTION_VALUE_UNSUPPORTED</pre>
166 Static initializer for unsupported <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAFractionValue" title="GUPnPDLNAFractionValue"><span class="type">GUPnPDLNAFractionValue</span></a>. Can be
171 <div class="informalexample"><pre class="programlisting">
172 GUPnPDLNAFractionValue value = GUPNP_DLNA_FRACTION_VALUE_UNSUPPORTED;
181 <div class="informalexample"><pre class="programlisting">
182 return GUPNP_DLNA_FRACTION_VALUE_UNSUPPORTED;
188 <div class="refsect2">
189 <a name="GUPNP-DLNA-INT-VALUE-UNSET:CAPS"></a><h3>GUPNP_DLNA_INT_VALUE_UNSET</h3>
190 <pre class="programlisting">#define GUPNP_DLNA_INT_VALUE_UNSET</pre>
192 Static initializer for unset <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue"><span class="type">GUPnPDLNAIntValue</span></a>. Can be used in
197 <div class="informalexample"><pre class="programlisting">
198 GUPnPDLNAIntValue value = GUPNP_DLNA_INT_VALUE_UNSET;
207 <div class="informalexample"><pre class="programlisting">
208 return GUPNP_DLNA_INT_VALUE_UNSET;
214 <div class="refsect2">
215 <a name="GUPNP-DLNA-INT-VALUE-UNSUPPORTED:CAPS"></a><h3>GUPNP_DLNA_INT_VALUE_UNSUPPORTED</h3>
216 <pre class="programlisting">#define GUPNP_DLNA_INT_VALUE_UNSUPPORTED</pre>
218 Static initializer for unsupported <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue"><span class="type">GUPnPDLNAIntValue</span></a>. Can be used in
223 <div class="informalexample"><pre class="programlisting">
224 GUPnPDLNAIntValue value = GUPNP_DLNA_INT_VALUE_UNSUPPORTED;
233 <div class="informalexample"><pre class="programlisting">
234 return GUPNP_DLNA_INT_VALUE_UNSUPPORTED;
240 <div class="refsect2">
241 <a name="GUPNP-DLNA-STRING-VALUE-UNSET:CAPS"></a><h3>GUPNP_DLNA_STRING_VALUE_UNSET</h3>
242 <pre class="programlisting">#define GUPNP_DLNA_STRING_VALUE_UNSET</pre>
244 Static initializer for unset <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue"><span class="type">GUPnPDLNAStringValue</span></a>. Can be used in
249 <div class="informalexample"><pre class="programlisting">
250 GUPnPDLNAStringValue value = GUPNP_DLNA_STRING_VALUE_UNSET;
259 <div class="informalexample"><pre class="programlisting">
260 return GUPNP_DLNA_STRING_VALUE_UNSET;
266 <div class="refsect2">
267 <a name="GUPNP-DLNA-STRING-VALUE-UNSUPPORTED:CAPS"></a><h3>GUPNP_DLNA_STRING_VALUE_UNSUPPORTED</h3>
268 <pre class="programlisting">#define GUPNP_DLNA_STRING_VALUE_UNSUPPORTED</pre>
270 Static initializer for unsupported <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue"><span class="type">GUPnPDLNAStringValue</span></a>. Can be
275 <div class="informalexample"><pre class="programlisting">
276 GUPnPDLNAStringValue value = GUPNP_DLNA_STRING_VALUE_UNSUPPORTED;
285 <div class="informalexample"><pre class="programlisting">
286 return GUPNP_DLNA_STRING_VALUE_UNSUPPORTED;
292 <div class="refsect2">
293 <a name="GUPnPDLNABoolValue"></a><h3>GUPnPDLNABoolValue</h3>
294 <pre class="programlisting">typedef struct {
296 GUPnPDLNAValueState state;
297 } GUPnPDLNABoolValue;
300 GUPnP DLNA Value representing a boolean value of some metadata attribute.
302 <div class="variablelist"><table border="0">
303 <col align="left" valign="top">
306 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="GUPnPDLNABoolValue.value"></a>value</code></em>;</span></p></td>
307 <td>The boolean value.</td>
310 <td><p><span class="term"><a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAValueState" title="enum GUPnPDLNAValueState"><span class="type">GUPnPDLNAValueState</span></a> <em class="structfield"><code><a name="GUPnPDLNABoolValue.state"></a>state</code></em>;</span></p></td>
311 <td>The state of <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNABoolValue" title="GUPnPDLNABoolValue"><span class="type">GUPnPDLNABoolValue</span></a>.</td>
317 <div class="refsect2">
318 <a name="GUPnPDLNAFractionValue"></a><h3>GUPnPDLNAFractionValue</h3>
319 <pre class="programlisting">typedef struct {
322 GUPnPDLNAValueState state;
323 } GUPnPDLNAFractionValue;
326 GUPnP DLNA Value representing a fraction value of some metadata attribute.
328 <div class="variablelist"><table border="0">
329 <col align="left" valign="top">
332 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GUPnPDLNAFractionValue.numerator"></a>numerator</code></em>;</span></p></td>
333 <td>The numerator of fraction.</td>
336 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GUPnPDLNAFractionValue.denominator"></a>denominator</code></em>;</span></p></td>
337 <td>The denominator of fraction.</td>
340 <td><p><span class="term"><a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAValueState" title="enum GUPnPDLNAValueState"><span class="type">GUPnPDLNAValueState</span></a> <em class="structfield"><code><a name="GUPnPDLNAFractionValue.state"></a>state</code></em>;</span></p></td>
341 <td>The state of <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAFractionValue" title="GUPnPDLNAFractionValue"><span class="type">GUPnPDLNAFractionValue</span></a>.</td>
347 <div class="refsect2">
348 <a name="GUPnPDLNAIntValue"></a><h3>GUPnPDLNAIntValue</h3>
349 <pre class="programlisting">typedef struct {
351 GUPnPDLNAValueState state;
355 GUPnP DLNA Value representing an integer value of some metadata attribute.
357 <div class="variablelist"><table border="0">
358 <col align="left" valign="top">
361 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GUPnPDLNAIntValue.value"></a>value</code></em>;</span></p></td>
362 <td>The integer value.</td>
365 <td><p><span class="term"><a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAValueState" title="enum GUPnPDLNAValueState"><span class="type">GUPnPDLNAValueState</span></a> <em class="structfield"><code><a name="GUPnPDLNAIntValue.state"></a>state</code></em>;</span></p></td>
366 <td>The state of <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue"><span class="type">GUPnPDLNAIntValue</span></a>.</td>
372 <div class="refsect2">
373 <a name="GUPnPDLNAStringValue"></a><h3>GUPnPDLNAStringValue</h3>
374 <pre class="programlisting">typedef struct {
376 GUPnPDLNAValueState state;
377 } GUPnPDLNAStringValue;
380 GUPnP DLNA Value representing a string value of some metadata
383 <div class="variablelist"><table border="0">
384 <col align="left" valign="top">
387 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GUPnPDLNAStringValue.value"></a>value</code></em>;</span></p></td>
388 <td>The string value.</td>
391 <td><p><span class="term"><a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAValueState" title="enum GUPnPDLNAValueState"><span class="type">GUPnPDLNAValueState</span></a> <em class="structfield"><code><a name="GUPnPDLNAStringValue.state"></a>state</code></em>;</span></p></td>
392 <td>The state of <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue"><span class="type">GUPnPDLNAStringValue</span></a>.</td>
398 <div class="refsect2">
399 <a name="GUPnPDLNAValueState"></a><h3>enum GUPnPDLNAValueState</h3>
400 <pre class="programlisting">typedef enum {
401 GUPNP_DLNA_VALUE_STATE_SET,
402 GUPNP_DLNA_VALUE_STATE_UNSET,
403 GUPNP_DLNA_VALUE_STATE_UNSUPPORTED
404 } GUPnPDLNAValueState;
407 Flags describing a state of GUPnP DLNA Value.
409 <div class="variablelist"><table border="0">
410 <col align="left" valign="top">
413 <td><p><a name="GUPNP-DLNA-VALUE-STATE-SET:CAPS"></a><span class="term"><code class="literal">GUPNP_DLNA_VALUE_STATE_SET</code></span></p></td>
418 <td><p><a name="GUPNP-DLNA-VALUE-STATE-UNSET:CAPS"></a><span class="term"><code class="literal">GUPNP_DLNA_VALUE_STATE_UNSET</code></span></p></td>
423 <td><p><a name="GUPNP-DLNA-VALUE-STATE-UNSUPPORTED:CAPS"></a><span class="term"><code class="literal">GUPNP_DLNA_VALUE_STATE_UNSUPPORTED</code></span></p></td>
424 <td>Value is unsupported.
434 Generated by GTK-Doc V1.18</div>