← Back to branch summary

~ubuntu-branches/ubuntu/raring/rygel/raring

« back to all changes in this revision

Viewing changes to doc/reference/librygel-server/gtkdoc/html/RygelMediaContainer.html

  • Committer: Package Import Robot
  • Author(s): Andreas Henriksson
  • Date: 2012-09-26 22:34:15 UTC
  • mfrom: (1.3.2)
  • mto: (14.1.10 sid)
  • mto: This revision was merged to the branch mainline in revision 27.
  • Revision ID: package-import@ubuntu.com-20120926223415-mem27auv86jjrj9k
Imported Upstream version 0.16.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/librygel-server/gtkdoc/html/RygelMediaContainer.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>RygelMediaContainer</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="librygel-server Reference Manual">
 
8
<link rel="up" href="ch01.html" title="librygel-server API Reference">
 
9
<link rel="prev" href="RygelMediaItem.html" title="RygelMediaItem">
 
10
<link rel="next" href="librygel-server-rygel-content-directory.html" title="rygel-content-directory">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
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">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="RygelMediaItem.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">librygel-server Reference Manual</th>
 
21
<td><a accesskey="n" href="librygel-server-rygel-content-directory.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#RygelMediaContainer.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#RygelMediaContainer.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#RygelMediaContainer.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#RygelMediaContainer.derived-interfaces" class="shortcut">Known Derived Interfaces</a>
 
31
                   | 
 
32
                  <a href="#RygelMediaContainer.properties" class="shortcut">Properties</a>
 
33
                   | 
 
34
                  <a href="#RygelMediaContainer.signals" class="shortcut">Signals</a>
 
35
</td></tr>
 
36
</table>
 
37
<div class="refentry">
 
38
<a name="RygelMediaContainer"></a><div class="titlepage"></div>
 
39
<div class="refnamediv"><table width="100%"><tr>
 
40
<td valign="top">
 
41
<h2><span class="refentrytitle"><a name="RygelMediaContainer.top_of_page"></a>RygelMediaContainer</span></h2>
 
42
<p>RygelMediaContainer — This is a container (folder) for media items and child containers.</p>
 
43
</td>
 
44
<td valign="top" align="right"></td>
 
45
</tr></table></div>
 
46
<div class="refsynopsisdiv">
 
47
<a name="RygelMediaContainer.synopsis"></a><h2>Synopsis</h2>
 
48
<pre class="synopsis">#define             <a class="link" href="RygelMediaContainer.html#RYGEL-TYPE-MEDIA-CONTAINER:CAPS" title="RYGEL_TYPE_MEDIA_CONTAINER">RYGEL_TYPE_MEDIA_CONTAINER</a>
 
49
<span class="returnvalue">void</span>                <a class="link" href="RygelMediaContainer.html#rygel-media-container-get-children" title="rygel_media_container_get_children ()">rygel_media_container_get_children</a>  (<em class="parameter"><code><a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *self</code></em>,
 
50
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> offset</code></em>,
 
51
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> max_count</code></em>,
 
52
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *sort_criteria</code></em>,
 
53
                                                         <em class="parameter"><code><a href="../gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
54
                                                         <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> _callback_</code></em>,
 
55
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> _user_data_</code></em>);
 
56
<a class="link" href="RygelMediaObjects.html" title="RygelMediaObjects"><span class="returnvalue">RygelMediaObjects</span></a> * <a class="link" href="RygelMediaContainer.html#rygel-media-container-get-children-finish" title="rygel_media_container_get_children_finish ()">rygel_media_container_get_children_finish</a>
 
57
                                                        (<em class="parameter"><code><a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *self</code></em>,
 
58
                                                         <em class="parameter"><code><a href="../gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *_res_</code></em>,
 
59
                                                         <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
60
<span class="returnvalue">void</span>                <a class="link" href="RygelMediaContainer.html#rygel-media-container-find-object" title="rygel_media_container_find_object ()">rygel_media_container_find_object</a>   (<em class="parameter"><code><a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *self</code></em>,
 
61
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>,
 
62
                                                         <em class="parameter"><code><a href="../gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
63
                                                         <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> _callback_</code></em>,
 
64
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> _user_data_</code></em>);
 
65
<a class="link" href="RygelMediaObject.html" title="RygelMediaObject"><span class="returnvalue">RygelMediaObject</span></a> *  <a class="link" href="RygelMediaContainer.html#rygel-media-container-find-object-finish" title="rygel_media_container_find_object_finish ()">rygel_media_container_find_object_finish</a>
 
66
                                                        (<em class="parameter"><code><a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *self</code></em>,
 
67
                                                         <em class="parameter"><code><a href="../gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *_res_</code></em>,
 
68
                                                         <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
69
<span class="returnvalue">void</span>                <a class="link" href="RygelMediaContainer.html#rygel-media-container-updated" title="rygel_media_container_updated ()">rygel_media_container_updated</a>       (<em class="parameter"><code><a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *self</code></em>);
 
70
#define             <a class="link" href="RygelMediaContainer.html#RYGEL-MEDIA-CONTAINER-UPNP-CLASS:CAPS" title="RYGEL_MEDIA_CONTAINER_UPNP_CLASS">RYGEL_MEDIA_CONTAINER_UPNP_CLASS</a>
 
71
#define             <a class="link" href="RygelMediaContainer.html#RYGEL-MEDIA-CONTAINER-STORAGE-FOLDER:CAPS" title="RYGEL_MEDIA_CONTAINER_STORAGE_FOLDER">RYGEL_MEDIA_CONTAINER_STORAGE_FOLDER</a>
 
72
#define             <a class="link" href="RygelMediaContainer.html#RYGEL-MEDIA-CONTAINER-MUSIC-ALBUM:CAPS" title="RYGEL_MEDIA_CONTAINER_MUSIC_ALBUM">RYGEL_MEDIA_CONTAINER_MUSIC_ALBUM</a>
 
73
#define             <a class="link" href="RygelMediaContainer.html#RYGEL-MEDIA-CONTAINER-MUSIC-ARTIST:CAPS" title="RYGEL_MEDIA_CONTAINER_MUSIC_ARTIST">RYGEL_MEDIA_CONTAINER_MUSIC_ARTIST</a>
 
74
#define             <a class="link" href="RygelMediaContainer.html#RYGEL-MEDIA-CONTAINER-MUSIC-GENRE:CAPS" title="RYGEL_MEDIA_CONTAINER_MUSIC_GENRE">RYGEL_MEDIA_CONTAINER_MUSIC_GENRE</a>
 
75
#define             <a class="link" href="RygelMediaContainer.html#RYGEL-MEDIA-CONTAINER-ALBUM-SORT-CRITERIA:CAPS" title="RYGEL_MEDIA_CONTAINER_ALBUM_SORT_CRITERIA">RYGEL_MEDIA_CONTAINER_ALBUM_SORT_CRITERIA</a>
 
76
const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="RygelMediaContainer.html#rygel-media-container-get-sort-criteria" title="rygel_media_container_get_sort_criteria ()">rygel_media_container_get_sort_criteria</a>
 
77
                                                        (<em class="parameter"><code><a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *self</code></em>);
 
78
<span class="returnvalue">void</span>                <a class="link" href="RygelMediaContainer.html#rygel-media-container-set-sort-criteria" title="rygel_media_container_set_sort_criteria ()">rygel_media_container_set_sort_criteria</a>
 
79
                                                        (<em class="parameter"><code><a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *self</code></em>,
 
80
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);
 
81
struct              <a class="link" href="RygelMediaContainer.html#RygelMediaContainer-struct" title="struct RygelMediaContainer">RygelMediaContainer</a>;
 
82
struct              <a class="link" href="RygelMediaContainer.html#RygelMediaContainerClass" title="struct RygelMediaContainerClass">RygelMediaContainerClass</a>;
 
83
</pre>
 
84
</div>
 
85
<div class="refsect1">
 
86
<a name="RygelMediaContainer.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
87
<pre class="synopsis">
 
88
  <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
89
   +----<a class="link" href="RygelMediaObject.html" title="RygelMediaObject">RygelMediaObject</a>
 
90
         +----RygelMediaContainer
 
91
               +----<a class="link" href="RygelSimpleContainer.html" title="RygelSimpleContainer">RygelSimpleContainer</a>
 
92
</pre>
 
93
</div>
 
94
<div class="refsect1">
 
95
<a name="RygelMediaContainer.derived-interfaces"></a><h2>Known Derived Interfaces</h2>
 
96
<p>
 
97
RygelMediaContainer is required by
 
98
 <a class="link" href="RygelSearchableContainer.html" title="RygelSearchableContainer">RygelSearchableContainer</a> and  <a class="link" href="RygelWritableContainer.html" title="RygelWritableContainer">RygelWritableContainer</a>.</p>
 
99
</div>
 
100
<div class="refsect1">
 
101
<a name="RygelMediaContainer.properties"></a><h2>Properties</h2>
 
102
<pre class="synopsis">
 
103
  "<a class="link" href="RygelMediaContainer.html#RygelMediaContainer--ocm-flags" title='The "ocm-flags" property'>ocm-flags</a>"                <a href="../gupnp-av/GUPnPDIDLLiteObject.html#GUPnPOCMFlags"><span class="type">GUPnPOCMFlags</span></a>         : Read
 
104
  "<a class="link" href="RygelMediaContainer.html#RygelMediaContainer--sort-criteria" title='The "sort-criteria" property'>sort-criteria</a>"            <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
 
105
</pre>
 
106
</div>
 
107
<div class="refsect1">
 
108
<a name="RygelMediaContainer.signals"></a><h2>Signals</h2>
 
109
<pre class="synopsis">
 
110
  "<a class="link" href="RygelMediaContainer.html#RygelMediaContainer-container-updated" title='The "container-updated" signal'>container-updated</a>"                              : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
111
</pre>
 
112
</div>
 
113
<div class="refsect1">
 
114
<a name="RygelMediaContainer.description"></a><h2>Description</h2>
 
115
<p>
 
116
</p>
 
117
<p>It provides a basic serialization implementation (to DIDLLiteWriter).</p>
 
118
<p>A derived class should provide a working implementation of get_children and should emit the container_updated signal.</p>
 
119
<p>
 
120
</p>
 
121
</div>
 
122
<div class="refsect1">
 
123
<a name="RygelMediaContainer.details"></a><h2>Details</h2>
 
124
<div class="refsect2">
 
125
<a name="RYGEL-TYPE-MEDIA-CONTAINER:CAPS"></a><h3>RYGEL_TYPE_MEDIA_CONTAINER</h3>
 
126
<pre class="programlisting">#define RYGEL_TYPE_MEDIA_CONTAINER (rygel_media_container_get_type ())
 
127
</pre>
 
128
<p>
 
129
The type for <a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a>.
 
130
</p>
 
131
</div>
 
132
<hr>
 
133
<div class="refsect2">
 
134
<a name="rygel-media-container-get-children"></a><h3>rygel_media_container_get_children ()</h3>
 
135
<pre class="programlisting"><span class="returnvalue">void</span>                rygel_media_container_get_children  (<em class="parameter"><code><a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *self</code></em>,
 
136
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> offset</code></em>,
 
137
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> max_count</code></em>,
 
138
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *sort_criteria</code></em>,
 
139
                                                         <em class="parameter"><code><a href="../gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
140
                                                         <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> _callback_</code></em>,
 
141
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> _user_data_</code></em>);</pre>
 
142
<p>
 
143
Fetches the list of media objects directly under this container.
 
144
</p>
 
145
<p>
 
146
<span class="emphasis"><em>See also</em></span>: <a class="link" href="RygelMediaContainer.html#rygel-media-container-get-children-finish" title="rygel_media_container_get_children_finish ()"><code class="function"><a class="link" href="RygelMediaContainer.html#rygel-media-container-get-children-finish" title="rygel_media_container_get_children_finish ()"><code class="function">rygel_media_container_get_children_finish()</code></a></code></a>
 
147
</p>
 
148
<div class="variablelist"><table border="0">
 
149
<col align="left" valign="top">
 
150
<tbody>
 
151
<tr>
 
152
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
153
<td>the <a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> instance</td>
 
154
</tr>
 
155
<tr>
 
156
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
 
157
<td>zero-based index of the first item to return. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
 
158
</td>
 
159
</tr>
 
160
<tr>
 
161
<td><p><span class="term"><em class="parameter"><code>max_count</code></em> :</span></p></td>
 
162
<td>maximum number of objects to return. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
 
163
</td>
 
164
</tr>
 
165
<tr>
 
166
<td><p><span class="term"><em class="parameter"><code>sort_criteria</code></em> :</span></p></td>
 
167
<td>sorting order of objects to return. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
 
168
</td>
 
169
</tr>
 
170
<tr>
 
171
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
172
<td>optional cancellable for this operation. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
173
</td>
 
174
</tr>
 
175
<tr>
 
176
<td><p><span class="term"><em class="parameter"><code>_callback_</code></em> :</span></p></td>
 
177
<td>callback to call when the request is satisfied. <span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span>
 
178
</td>
 
179
</tr>
 
180
<tr>
 
181
<td><p><span class="term"><em class="parameter"><code>_user_data_</code></em> :</span></p></td>
 
182
<td>the data to pass to <em class="parameter"><code>_callback_</code></em> function. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
 
183
</td>
 
184
</tr>
 
185
</tbody>
 
186
</table></div>
 
187
</div>
 
188
<hr>
 
189
<div class="refsect2">
 
190
<a name="rygel-media-container-get-children-finish"></a><h3>rygel_media_container_get_children_finish ()</h3>
 
191
<pre class="programlisting"><a class="link" href="RygelMediaObjects.html" title="RygelMediaObjects"><span class="returnvalue">RygelMediaObjects</span></a> * rygel_media_container_get_children_finish
 
192
                                                        (<em class="parameter"><code><a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *self</code></em>,
 
193
                                                         <em class="parameter"><code><a href="../gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *_res_</code></em>,
 
194
                                                         <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
195
<p>
 
196
Fetches the list of media objects directly under this container.
 
197
</p>
 
198
<p>
 
199
<span class="emphasis"><em>See also</em></span>: <a class="link" href="RygelMediaContainer.html#rygel-media-container-get-children" title="rygel_media_container_get_children ()"><code class="function"><a class="link" href="RygelMediaContainer.html#rygel-media-container-get-children" title="rygel_media_container_get_children ()"><code class="function">rygel_media_container_get_children()</code></a></code></a>
 
200
</p>
 
201
<div class="variablelist"><table border="0">
 
202
<col align="left" valign="top">
 
203
<tbody>
 
204
<tr>
 
205
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
206
<td>the <a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> instance</td>
 
207
</tr>
 
208
<tr>
 
209
<td><p><span class="term"><em class="parameter"><code>_res_</code></em> :</span></p></td>
 
210
<td>a <a href="../gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a>
 
211
</td>
 
212
</tr>
 
213
<tr>
 
214
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
215
<td>location to store the error occuring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>
 
216
</tr>
 
217
<tr>
 
218
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
219
<td>A list of media objects.</td>
 
220
</tr>
 
221
</tbody>
 
222
</table></div>
 
223
</div>
 
224
<hr>
 
225
<div class="refsect2">
 
226
<a name="rygel-media-container-find-object"></a><h3>rygel_media_container_find_object ()</h3>
 
227
<pre class="programlisting"><span class="returnvalue">void</span>                rygel_media_container_find_object   (<em class="parameter"><code><a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *self</code></em>,
 
228
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>,
 
229
                                                         <em class="parameter"><code><a href="../gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
230
                                                         <em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> _callback_</code></em>,
 
231
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> _user_data_</code></em>);</pre>
 
232
<p>
 
233
Recursively searches this container for a media object with the given ID.
 
234
</p>
 
235
<p>
 
236
<span class="emphasis"><em>See also</em></span>: <a class="link" href="RygelMediaContainer.html#rygel-media-container-find-object-finish" title="rygel_media_container_find_object_finish ()"><code class="function"><a class="link" href="RygelMediaContainer.html#rygel-media-container-find-object-finish" title="rygel_media_container_find_object_finish ()"><code class="function">rygel_media_container_find_object_finish()</code></a></code></a>
 
237
</p>
 
238
<div class="variablelist"><table border="0">
 
239
<col align="left" valign="top">
 
240
<tbody>
 
241
<tr>
 
242
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
243
<td>the <a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> instance</td>
 
244
</tr>
 
245
<tr>
 
246
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 
247
<td>ID of the media object to search for. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
 
248
</td>
 
249
</tr>
 
250
<tr>
 
251
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
252
<td>optional cancellable for this operation. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
253
</td>
 
254
</tr>
 
255
<tr>
 
256
<td><p><span class="term"><em class="parameter"><code>_callback_</code></em> :</span></p></td>
 
257
<td>callback to call when the request is satisfied. <span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span>
 
258
</td>
 
259
</tr>
 
260
<tr>
 
261
<td><p><span class="term"><em class="parameter"><code>_user_data_</code></em> :</span></p></td>
 
262
<td>the data to pass to <em class="parameter"><code>_callback_</code></em> function. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
 
263
</td>
 
264
</tr>
 
265
</tbody>
 
266
</table></div>
 
267
</div>
 
268
<hr>
 
269
<div class="refsect2">
 
270
<a name="rygel-media-container-find-object-finish"></a><h3>rygel_media_container_find_object_finish ()</h3>
 
271
<pre class="programlisting"><a class="link" href="RygelMediaObject.html" title="RygelMediaObject"><span class="returnvalue">RygelMediaObject</span></a> *  rygel_media_container_find_object_finish
 
272
                                                        (<em class="parameter"><code><a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *self</code></em>,
 
273
                                                         <em class="parameter"><code><a href="../gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *_res_</code></em>,
 
274
                                                         <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
275
<p>
 
276
Recursively searches this container for a media object with the given ID.
 
277
</p>
 
278
<p>
 
279
<span class="emphasis"><em>See also</em></span>: <a class="link" href="RygelMediaContainer.html#rygel-media-container-find-object" title="rygel_media_container_find_object ()"><code class="function"><a class="link" href="RygelMediaContainer.html#rygel-media-container-find-object" title="rygel_media_container_find_object ()"><code class="function">rygel_media_container_find_object()</code></a></code></a>
 
280
</p>
 
281
<div class="variablelist"><table border="0">
 
282
<col align="left" valign="top">
 
283
<tbody>
 
284
<tr>
 
285
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
286
<td>the <a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> instance</td>
 
287
</tr>
 
288
<tr>
 
289
<td><p><span class="term"><em class="parameter"><code>_res_</code></em> :</span></p></td>
 
290
<td>a <a href="../gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a>
 
291
</td>
 
292
</tr>
 
293
<tr>
 
294
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
295
<td>location to store the error occuring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>
 
296
</tr>
 
297
<tr>
 
298
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
299
<td>the found media object.</td>
 
300
</tr>
 
301
</tbody>
 
302
</table></div>
 
303
</div>
 
304
<hr>
 
305
<div class="refsect2">
 
306
<a name="rygel-media-container-updated"></a><h3>rygel_media_container_updated ()</h3>
 
307
<pre class="programlisting"><span class="returnvalue">void</span>                rygel_media_container_updated       (<em class="parameter"><code><a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *self</code></em>);</pre>
 
308
<p>
 
309
This method should be called each time this container is updated.
 
310
</p>
 
311
<p>
 
312
</p>
 
313
<p>For instance, this should be called if there are metadata changes for this container, if items under it are removed or added, if there are metadata changes to items under it, etc.</p>
 
314
<p>
 
315
</p>
 
316
<div class="variablelist"><table border="0">
 
317
<col align="left" valign="top">
 
318
<tbody><tr>
 
319
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
320
<td>the <a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> instance</td>
 
321
</tr></tbody>
 
322
</table></div>
 
323
</div>
 
324
<hr>
 
325
<div class="refsect2">
 
326
<a name="RYGEL-MEDIA-CONTAINER-UPNP-CLASS:CAPS"></a><h3>RYGEL_MEDIA_CONTAINER_UPNP_CLASS</h3>
 
327
<pre class="programlisting">#define RYGEL_MEDIA_CONTAINER_UPNP_CLASS "object.container"
 
328
</pre>
 
329
</div>
 
330
<hr>
 
331
<div class="refsect2">
 
332
<a name="RYGEL-MEDIA-CONTAINER-STORAGE-FOLDER:CAPS"></a><h3>RYGEL_MEDIA_CONTAINER_STORAGE_FOLDER</h3>
 
333
<pre class="programlisting">#define RYGEL_MEDIA_CONTAINER_STORAGE_FOLDER RYGEL_MEDIA_CONTAINER_UPNP_CLASS ".storageFolder"
 
334
</pre>
 
335
</div>
 
336
<hr>
 
337
<div class="refsect2">
 
338
<a name="RYGEL-MEDIA-CONTAINER-MUSIC-ALBUM:CAPS"></a><h3>RYGEL_MEDIA_CONTAINER_MUSIC_ALBUM</h3>
 
339
<pre class="programlisting">#define RYGEL_MEDIA_CONTAINER_MUSIC_ALBUM RYGEL_MEDIA_CONTAINER_UPNP_CLASS ".album.musicAlbum"
 
340
</pre>
 
341
</div>
 
342
<hr>
 
343
<div class="refsect2">
 
344
<a name="RYGEL-MEDIA-CONTAINER-MUSIC-ARTIST:CAPS"></a><h3>RYGEL_MEDIA_CONTAINER_MUSIC_ARTIST</h3>
 
345
<pre class="programlisting">#define RYGEL_MEDIA_CONTAINER_MUSIC_ARTIST RYGEL_MEDIA_CONTAINER_UPNP_CLASS ".person.musicArtist"
 
346
</pre>
 
347
</div>
 
348
<hr>
 
349
<div class="refsect2">
 
350
<a name="RYGEL-MEDIA-CONTAINER-MUSIC-GENRE:CAPS"></a><h3>RYGEL_MEDIA_CONTAINER_MUSIC_GENRE</h3>
 
351
<pre class="programlisting">#define RYGEL_MEDIA_CONTAINER_MUSIC_GENRE RYGEL_MEDIA_CONTAINER_UPNP_CLASS ".genre.musicGenre"
 
352
</pre>
 
353
</div>
 
354
<hr>
 
355
<div class="refsect2">
 
356
<a name="RYGEL-MEDIA-CONTAINER-ALBUM-SORT-CRITERIA:CAPS"></a><h3>RYGEL_MEDIA_CONTAINER_ALBUM_SORT_CRITERIA</h3>
 
357
<pre class="programlisting">#define RYGEL_MEDIA_CONTAINER_ALBUM_SORT_CRITERIA "+upnp:class," "+rygel:originalVolumeNumber," "+upnp:originalTrackNumber," "+dc:title"
 
358
</pre>
 
359
</div>
 
360
<hr>
 
361
<div class="refsect2">
 
362
<a name="rygel-media-container-get-sort-criteria"></a><h3>rygel_media_container_get_sort_criteria ()</h3>
 
363
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       rygel_media_container_get_sort_criteria
 
364
                                                        (<em class="parameter"><code><a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *self</code></em>);</pre>
 
365
<p>
 
366
Get and return the current value of the <a class="link" href="RygelMediaContainer.html#RygelMediaContainer--sort-criteria" title='The "sort-criteria" property'><span class="type">"sort-criteria"</span></a> property.
 
367
</p>
 
368
<div class="variablelist"><table border="0">
 
369
<col align="left" valign="top">
 
370
<tbody>
 
371
<tr>
 
372
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
373
<td>the <a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> instance to query</td>
 
374
</tr>
 
375
<tr>
 
376
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
377
<td>the value of the <a class="link" href="RygelMediaContainer.html#RygelMediaContainer--sort-criteria" title='The "sort-criteria" property'><span class="type">"sort-criteria"</span></a> property</td>
 
378
</tr>
 
379
</tbody>
 
380
</table></div>
 
381
</div>
 
382
<hr>
 
383
<div class="refsect2">
 
384
<a name="rygel-media-container-set-sort-criteria"></a><h3>rygel_media_container_set_sort_criteria ()</h3>
 
385
<pre class="programlisting"><span class="returnvalue">void</span>                rygel_media_container_set_sort_criteria
 
386
                                                        (<em class="parameter"><code><a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *self</code></em>,
 
387
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
 
388
<p>
 
389
Set the value of the <a class="link" href="RygelMediaContainer.html#RygelMediaContainer--sort-criteria" title='The "sort-criteria" property'><span class="type">"sort-criteria"</span></a> property to <em class="parameter"><code>value</code></em>.
 
390
</p>
 
391
<div class="variablelist"><table border="0">
 
392
<col align="left" valign="top">
 
393
<tbody>
 
394
<tr>
 
395
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
396
<td>the <a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> instance to modify</td>
 
397
</tr>
 
398
<tr>
 
399
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 
400
<td>the new value of the <a class="link" href="RygelMediaContainer.html#RygelMediaContainer--sort-criteria" title='The "sort-criteria" property'><span class="type">"sort-criteria"</span></a> property</td>
 
401
</tr>
 
402
</tbody>
 
403
</table></div>
 
404
</div>
 
405
<hr>
 
406
<div class="refsect2">
 
407
<a name="RygelMediaContainer-struct"></a><h3>struct RygelMediaContainer</h3>
 
408
<pre class="programlisting">struct RygelMediaContainer;</pre>
 
409
<p>
 
410
This is a container (folder) for media items and child containers.
 
411
</p>
 
412
<p>
 
413
</p>
 
414
<p>It provides a basic serialization implementation (to DIDLLiteWriter).</p>
 
415
<p>A derived class should provide a working implementation of get_children and should emit the container_updated signal.</p>
 
416
<p>
 
417
</p>
 
418
</div>
 
419
<hr>
 
420
<div class="refsect2">
 
421
<a name="RygelMediaContainerClass"></a><h3>struct RygelMediaContainerClass</h3>
 
422
<pre class="programlisting">struct RygelMediaContainerClass {
 
423
        RygelMediaObjectClass parent_class;
 
424
        void (*get_children) (RygelMediaContainer* self, guint offset, guint max_count, const gchar* sort_criteria, GCancellable* cancellable, GAsyncReadyCallback _callback_, gpointer _user_data_);
 
425
        RygelMediaObjects* (*get_children_finish) (RygelMediaContainer* self, GAsyncResult* _res_, GError** error);
 
426
        void (*find_object) (RygelMediaContainer* self, const gchar* id, GCancellable* cancellable, GAsyncReadyCallback _callback_, gpointer _user_data_);
 
427
        RygelMediaObject* (*find_object_finish) (RygelMediaContainer* self, GAsyncResult* _res_, GError** error);
 
428
};
 
429
</pre>
 
430
<p>
 
431
The class structure for <a class="link" href="RygelMediaContainer.html#RYGEL-TYPE-MEDIA-CONTAINER:CAPS" title="RYGEL_TYPE_MEDIA_CONTAINER"><code class="literal">RYGEL_TYPE_MEDIA_CONTAINER</code></a>. All the fields in this structure are private and should never be accessed directly.
 
432
</p>
 
433
<div class="variablelist"><table border="0">
 
434
<col align="left" valign="top">
 
435
<tbody>
 
436
<tr>
 
437
<td><p><span class="term"><a class="link" href="RygelMediaObject.html#RygelMediaObjectClass" title="struct RygelMediaObjectClass"><span class="type">RygelMediaObjectClass</span></a> <em class="structfield"><code><a name="RygelMediaContainerClass.parent-class"></a>parent_class</code></em>;</span></p></td>
 
438
<td>the parent class structure</td>
 
439
</tr>
 
440
<tr>
 
441
<td><p><span class="term"><em class="structfield"><code><a name="RygelMediaContainerClass.get-children"></a>get_children</code></em> ()</span></p></td>
 
442
<td>virtual method called by <a class="link" href="RygelMediaContainer.html#rygel-media-container-get-children" title="rygel_media_container_get_children ()"><code class="function"><a class="link" href="RygelMediaContainer.html#rygel-media-container-get-children" title="rygel_media_container_get_children ()"><code class="function">rygel_media_container_get_children()</code></a></code></a>
 
443
</td>
 
444
</tr>
 
445
<tr>
 
446
<td><p><span class="term"><em class="structfield"><code><a name="RygelMediaContainerClass.get-children-finish"></a>get_children_finish</code></em> ()</span></p></td>
 
447
<td>asynchronous finish function for <em class="structfield"><code>get_children</code></em>, called by <a class="link" href="RygelMediaContainer.html#rygel-media-container-get-children" title="rygel_media_container_get_children ()"><code class="function"><a class="link" href="RygelMediaContainer.html#rygel-media-container-get-children" title="rygel_media_container_get_children ()"><code class="function">rygel_media_container_get_children()</code></a></code></a>
 
448
</td>
 
449
</tr>
 
450
<tr>
 
451
<td><p><span class="term"><em class="structfield"><code><a name="RygelMediaContainerClass.find-object"></a>find_object</code></em> ()</span></p></td>
 
452
<td>virtual method called by <a class="link" href="RygelMediaContainer.html#rygel-media-container-find-object" title="rygel_media_container_find_object ()"><code class="function"><a class="link" href="RygelMediaContainer.html#rygel-media-container-find-object" title="rygel_media_container_find_object ()"><code class="function">rygel_media_container_find_object()</code></a></code></a>
 
453
</td>
 
454
</tr>
 
455
<tr>
 
456
<td><p><span class="term"><em class="structfield"><code><a name="RygelMediaContainerClass.find-object-finish"></a>find_object_finish</code></em> ()</span></p></td>
 
457
<td>asynchronous finish function for <em class="structfield"><code>find_object</code></em>, called by <a class="link" href="RygelMediaContainer.html#rygel-media-container-find-object" title="rygel_media_container_find_object ()"><code class="function"><a class="link" href="RygelMediaContainer.html#rygel-media-container-find-object" title="rygel_media_container_find_object ()"><code class="function">rygel_media_container_find_object()</code></a></code></a>
 
458
</td>
 
459
</tr>
 
460
</tbody>
 
461
</table></div>
 
462
</div>
 
463
</div>
 
464
<div class="refsect1">
 
465
<a name="RygelMediaContainer.property-details"></a><h2>Property Details</h2>
 
466
<div class="refsect2">
 
467
<a name="RygelMediaContainer--ocm-flags"></a><h3>The <code class="literal">"ocm-flags"</code> property</h3>
 
468
<pre class="programlisting">  "ocm-flags"                <a href="../gupnp-av/GUPnPDIDLLiteObject.html#GUPnPOCMFlags"><span class="type">GUPnPOCMFlags</span></a>         : Read</pre>
 
469
<p>ocm-flags.</p>
 
470
</div>
 
471
<hr>
 
472
<div class="refsect2">
 
473
<a name="RygelMediaContainer--sort-criteria"></a><h3>The <code class="literal">"sort-criteria"</code> property</h3>
 
474
<pre class="programlisting">  "sort-criteria"            <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
475
<p>sort-criteria.</p>
 
476
<p>Default value: NULL</p>
 
477
</div>
 
478
</div>
 
479
<div class="refsect1">
 
480
<a name="RygelMediaContainer.signal-details"></a><h2>Signal Details</h2>
 
481
<div class="refsect2">
 
482
<a name="RygelMediaContainer-container-updated"></a><h3>The <code class="literal">"container-updated"</code> signal</h3>
 
483
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *media_container,
 
484
                                                        <a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> *container,
 
485
                                                        <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>             user_data)            : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
486
<p>
 
487
The container_updated signal is emitted if a child container under the tree of this container has been updated.
 
488
</p>
 
489
<div class="variablelist"><table border="0">
 
490
<col align="left" valign="top">
 
491
<tbody>
 
492
<tr>
 
493
<td><p><span class="term"><em class="parameter"><code>media_container</code></em> :</span></p></td>
 
494
<td>the <a class="link" href="RygelMediaContainer.html" title="RygelMediaContainer"><span class="type">RygelMediaContainer</span></a> instance that received the signal</td>
 
495
</tr>
 
496
<tr>
 
497
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
 
498
<td>The child container that has been updated. <p></p>
 
499
</td>
 
500
</tr>
 
501
<tr>
 
502
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
503
<td>user data set when the signal handler was connected.</td>
 
504
</tr>
 
505
</tbody>
 
506
</table></div>
 
507
</div>
 
508
</div>
 
509
</div>
 
510
<div class="footer">
 
511
<hr>
 
512
          Generated by GTK-Doc V1.18</div>
 
513
</body>
 
514
</html>
 
 
b'\\ No newline at end of file'