1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RygelMediaItem: librygel-server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="librygel-server Reference Manual">
<link rel="up" href="api-main-list.html" title="librygel-server API Reference">
<link rel="prev" href="RygelMediaFileItem.html" title="RygelMediaFileItem">
<link rel="next" href="RygelMediaObjects.html" title="RygelMediaObjects">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#RygelMediaItem.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#RygelMediaItem.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_derived_interfaces"> <span class="dim">|</span>
<a href="#RygelMediaItem.derived-interfaces" class="shortcut">Known Derived Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#RygelMediaItem.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="api-main-list.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="RygelMediaFileItem.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="RygelMediaObjects.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="RygelMediaItem"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RygelMediaItem.top_of_page"></a>RygelMediaItem</span></h2>
<p>RygelMediaItem — Abstract class representing a MediaItem</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="RygelMediaItem.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="RygelMediaItem.html#rygel-media-item-get-description" title="rygel_media_item_get_description ()">rygel_media_item_get_description</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RygelMediaItem.html#rygel-media-item-set-description" title="rygel_media_item_set_description ()">rygel_media_item_set_description</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RygelMediaItem.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="RygelMediaItem.html#RygelMediaItem--description" title="The “description” property">description</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RygelMediaItem.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="RygelMediaItem.html#RYGEL-TYPE-MEDIA-ITEM:CAPS" title="RYGEL_TYPE_MEDIA_ITEM">RYGEL_TYPE_MEDIA_ITEM</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="RygelMediaItem.html#RYGEL-MEDIA-ITEM-UPNP-CLASS:CAPS" title="RYGEL_MEDIA_ITEM_UPNP_CLASS">RYGEL_MEDIA_ITEM_UPNP_CLASS</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="RygelMediaItem.html#RygelMediaItem-struct" title="struct RygelMediaItem">RygelMediaItem</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="RygelMediaItem.html#RygelMediaItemClass" title="struct RygelMediaItemClass">RygelMediaItemClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RygelMediaItem.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a class="link" href="RygelMediaObject.html" title="RygelMediaObject">RygelMediaObject</a>
<span class="lineart">╰──</span> RygelMediaItem
<span class="lineart">╰──</span> <a class="link" href="RygelMediaFileItem.html" title="RygelMediaFileItem">RygelMediaFileItem</a>
</pre>
</div>
<div class="refsect1">
<a name="RygelMediaItem.derived-interfaces"></a><h2>Known Derived Interfaces</h2>
<p>
RygelMediaItem is required by
<a class="link" href="RygelTrackableItem.html" title="RygelTrackableItem">RygelTrackableItem</a>.</p>
</div>
<div class="refsect1">
<a name="RygelMediaItem.description"></a><h2>Description</h2>
<p>MediaItems must live in a container and may not contain other MediaItems</p>
</div>
<div class="refsect1">
<a name="RygelMediaItem.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="rygel-media-item-get-description"></a><h3>rygel_media_item_get_description ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
rygel_media_item_get_description (<em class="parameter"><code><a class="link" href="RygelMediaItem.html" title="RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>);</pre>
<p>Get and return the current value of the <a class="link" href="RygelMediaItem.html#RygelMediaItem--description" title="The “description” property"><span class="type">"description"</span></a> property.</p>
<div class="refsect3">
<a name="rygel-media-item-get-description.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="RygelMediaItem.html" title="RygelMediaItem"><span class="type">RygelMediaItem</span></a> instance to query</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="rygel-media-item-get-description.returns"></a><h4>Returns</h4>
<p> the value of the <a class="link" href="RygelMediaItem.html#RygelMediaItem--description" title="The “description” property"><span class="type">"description"</span></a> property</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rygel-media-item-set-description"></a><h3>rygel_media_item_set_description ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rygel_media_item_set_description (<em class="parameter"><code><a class="link" href="RygelMediaItem.html" title="RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
<p>Set the value of the <a class="link" href="RygelMediaItem.html#RygelMediaItem--description" title="The “description” property"><span class="type">"description"</span></a> property to <em class="parameter"><code>value</code></em>
.</p>
<div class="refsect3">
<a name="rygel-media-item-set-description.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="RygelMediaItem.html" title="RygelMediaItem"><span class="type">RygelMediaItem</span></a> instance to modify</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the new value of the <a class="link" href="RygelMediaItem.html#RygelMediaItem--description" title="The “description” property"><span class="type">"description"</span></a> property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="RygelMediaItem.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="RYGEL-TYPE-MEDIA-ITEM:CAPS"></a><h3>RYGEL_TYPE_MEDIA_ITEM</h3>
<pre class="programlisting">#define RYGEL_TYPE_MEDIA_ITEM (rygel_media_item_get_type ())
</pre>
<p>The type for <a class="link" href="RygelMediaItem.html" title="RygelMediaItem"><span class="type">RygelMediaItem</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="RYGEL-MEDIA-ITEM-UPNP-CLASS:CAPS"></a><h3>RYGEL_MEDIA_ITEM_UPNP_CLASS</h3>
<pre class="programlisting">#define RYGEL_MEDIA_ITEM_UPNP_CLASS "objec.item"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="RygelMediaItem-struct"></a><h3>struct RygelMediaItem</h3>
<pre class="programlisting">struct RygelMediaItem;</pre>
<p>Abstract class representing a MediaItem</p>
<p>MediaItems must live in a container and may not contain other MediaItems</p>
</div>
<hr>
<div class="refsect2">
<a name="RygelMediaItemClass"></a><h3>struct RygelMediaItemClass</h3>
<pre class="programlisting">struct RygelMediaItemClass {
RygelMediaObjectClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="RygelMediaItem.html#RYGEL-TYPE-MEDIA-ITEM:CAPS" title="RYGEL_TYPE_MEDIA_ITEM"><code class="literal">RYGEL_TYPE_MEDIA_ITEM</code></a>. All the fields in this structure are private and should never be accessed directly.</p>
<div class="refsect3">
<a name="RygelMediaItemClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="RygelMediaItem.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="RygelMediaItem--description"></a><h3>The <code class="literal">“description”</code> property</h3>
<pre class="programlisting"> “description” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>description.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|
