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>RygelMediaItem</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="librygel-server-RygelPhotoItem.html" title="RygelPhotoItem">
10
<link rel="next" href="librygel-server-RygelMediaContainer.html" title="RygelMediaContainer">
11
<meta name="generator" content="GTK-Doc V1.18.1 (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="librygel-server-RygelPhotoItem.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-RygelMediaContainer.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="#librygel-server-RygelMediaItem.synopsis" class="shortcut">Top</a>
26
<a href="#librygel-server-RygelMediaItem.description" class="shortcut">Description</a>
29
<div class="refentry">
30
<a name="librygel-server-RygelMediaItem"></a><div class="titlepage"></div>
31
<div class="refnamediv"><table width="100%"><tr>
33
<h2><span class="refentrytitle"><a name="librygel-server-RygelMediaItem.top_of_page"></a>RygelMediaItem</span></h2>
34
<p>RygelMediaItem — Represents a media (Music, Video and Image) item.</p>
36
<td valign="top" align="right"></td>
38
<div class="refsynopsisdiv">
39
<a name="librygel-server-RygelMediaItem.synopsis"></a><h2>Synopsis</h2>
40
<pre class="synopsis">#define <a class="link" href="librygel-server-RygelMediaItem.html#RYGEL-TYPE-MEDIA-ITEM:CAPS" title="RYGEL_TYPE_MEDIA_ITEM">RYGEL_TYPE_MEDIA_ITEM</a>
41
<a href="../gstreamer-0.10/GstElement.html"><span class="returnvalue">GstElement</span></a> * <a class="link" href="librygel-server-RygelMediaItem.html#rygel-media-item-create-stream-source" title="rygel_media_item_create_stream_source ()">rygel_media_item_create_stream_source</a>
42
(<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
43
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *host_ip</code></em>);
44
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="librygel-server-RygelMediaItem.html#rygel-media-item-is-live-stream" title="rygel_media_item_is_live_stream ()">rygel_media_item_is_live_stream</a> (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>);
45
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="librygel-server-RygelMediaItem.html#rygel-media-item-streamable" title="rygel_media_item_streamable ()">rygel_media_item_streamable</a> (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>);
46
<span class="returnvalue">void</span> <a class="link" href="librygel-server-RygelMediaItem.html#rygel-media-item-add-uri" title="rygel_media_item_add_uri ()">rygel_media_item_add_uri</a> (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
47
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>);
48
<a href="../gupnp-av/GUPnPProtocolInfo.html"><span class="returnvalue">GUPnPProtocolInfo</span></a> * <a class="link" href="librygel-server-RygelMediaItem.html#rygel-media-item-get-protocol-info" title="rygel_media_item_get_protocol_info ()">rygel_media_item_get_protocol_info</a> (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
49
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
50
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>);
51
<span class="returnvalue">void</span> <a class="link" href="librygel-server-RygelMediaItem.html#rygel-media-item-add-resources" title="rygel_media_item_add_resources ()">rygel_media_item_add_resources</a> (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
52
<em class="parameter"><code><a href="../gupnp-av/GUPnPDIDLLiteItem.html"><span class="type">GUPnPDIDLLiteItem</span></a> *didl_item</code></em>,
53
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> allow_internal</code></em>,
54
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
55
<a href="../glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a> <a class="link" href="librygel-server-RygelMediaItem.html#rygel-media-item-get-size" title="rygel_media_item_get_size ()">rygel_media_item_get_size</a> (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>);
56
<span class="returnvalue">void</span> <a class="link" href="librygel-server-RygelMediaItem.html#rygel-media-item-set-size" title="rygel_media_item_set_size ()">rygel_media_item_set_size</a> (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
57
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> value</code></em>);
58
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="librygel-server-RygelMediaItem.html#rygel-media-item-get-place-holder" title="rygel_media_item_get_place_holder ()">rygel_media_item_get_place_holder</a> (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>);
59
<span class="returnvalue">void</span> <a class="link" href="librygel-server-RygelMediaItem.html#rygel-media-item-set-place-holder" title="rygel_media_item_set_place_holder ()">rygel_media_item_set_place_holder</a> (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
60
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);
61
const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="librygel-server-RygelMediaItem.html#rygel-media-item-get-description" title="rygel_media_item_get_description ()">rygel_media_item_get_description</a> (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>);
62
<span class="returnvalue">void</span> <a class="link" href="librygel-server-RygelMediaItem.html#rygel-media-item-set-description" title="rygel_media_item_set_description ()">rygel_media_item_set_description</a> (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
63
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);
64
struct <a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem">RygelMediaItem</a>;
67
<div class="refsect1">
68
<a name="librygel-server-RygelMediaItem.description"></a><h2>Description</h2>
70
<div class="refsect1">
71
<a name="librygel-server-RygelMediaItem.details"></a><h2>Details</h2>
72
<div class="refsect2">
73
<a name="RYGEL-TYPE-MEDIA-ITEM:CAPS"></a><h3>RYGEL_TYPE_MEDIA_ITEM</h3>
74
<pre class="programlisting">#define RYGEL_TYPE_MEDIA_ITEM (rygel_media_item_get_type ())
77
The type for <a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a>.
81
<div class="refsect2">
82
<a name="rygel-media-item-create-stream-source"></a><h3>rygel_media_item_create_stream_source ()</h3>
83
<pre class="programlisting"><a href="../gstreamer-0.10/GstElement.html"><span class="returnvalue">GstElement</span></a> * rygel_media_item_create_stream_source
84
(<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
85
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *host_ip</code></em>);</pre>
86
<div class="variablelist"><table border="0">
87
<col align="left" valign="top">
89
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
90
<td>the <a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> instance</td>
95
<div class="refsect2">
96
<a name="rygel-media-item-is-live-stream"></a><h3>rygel_media_item_is_live_stream ()</h3>
97
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rygel_media_item_is_live_stream (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>);</pre>
98
<div class="variablelist"><table border="0">
99
<col align="left" valign="top">
101
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
102
<td>the <a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> instance</td>
107
<div class="refsect2">
108
<a name="rygel-media-item-streamable"></a><h3>rygel_media_item_streamable ()</h3>
109
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rygel_media_item_streamable (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>);</pre>
110
<div class="variablelist"><table border="0">
111
<col align="left" valign="top">
113
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
114
<td>the <a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> instance</td>
119
<div class="refsect2">
120
<a name="rygel-media-item-add-uri"></a><h3>rygel_media_item_add_uri ()</h3>
121
<pre class="programlisting"><span class="returnvalue">void</span> rygel_media_item_add_uri (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
122
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>);</pre>
123
<div class="variablelist"><table border="0">
124
<col align="left" valign="top">
126
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
127
<td>the <a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> instance</td>
132
<div class="refsect2">
133
<a name="rygel-media-item-get-protocol-info"></a><h3>rygel_media_item_get_protocol_info ()</h3>
134
<pre class="programlisting"><a href="../gupnp-av/GUPnPProtocolInfo.html"><span class="returnvalue">GUPnPProtocolInfo</span></a> * rygel_media_item_get_protocol_info (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
135
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
136
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>);</pre>
137
<div class="variablelist"><table border="0">
138
<col align="left" valign="top">
140
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
141
<td>the <a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> instance</td>
146
<div class="refsect2">
147
<a name="rygel-media-item-add-resources"></a><h3>rygel_media_item_add_resources ()</h3>
148
<pre class="programlisting"><span class="returnvalue">void</span> rygel_media_item_add_resources (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
149
<em class="parameter"><code><a href="../gupnp-av/GUPnPDIDLLiteItem.html"><span class="type">GUPnPDIDLLiteItem</span></a> *didl_item</code></em>,
150
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> allow_internal</code></em>,
151
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
152
<div class="variablelist"><table border="0">
153
<col align="left" valign="top">
156
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
157
<td>the <a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> instance</td>
160
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
161
<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>
167
<div class="refsect2">
168
<a name="rygel-media-item-get-size"></a><h3>rygel_media_item_get_size ()</h3>
169
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a> rygel_media_item_get_size (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>);</pre>
170
<div class="variablelist"><table border="0">
171
<col align="left" valign="top">
174
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
175
<td>the <a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> instance to query</td>
178
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
179
<td>the value of the <a href="../librygel-core/RygelMediaItem.html#RygelMediaItem--size"><span class="type">"size"</span></a> property</td>
185
<div class="refsect2">
186
<a name="rygel-media-item-set-size"></a><h3>rygel_media_item_set_size ()</h3>
187
<pre class="programlisting"><span class="returnvalue">void</span> rygel_media_item_set_size (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
188
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> value</code></em>);</pre>
189
<div class="variablelist"><table border="0">
190
<col align="left" valign="top">
193
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
194
<td>the <a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> instance to modify</td>
197
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
198
<td>the new value of the <a href="../librygel-core/RygelMediaItem.html#RygelMediaItem--size"><span class="type">"size"</span></a> property</td>
204
<div class="refsect2">
205
<a name="rygel-media-item-get-place-holder"></a><h3>rygel_media_item_get_place_holder ()</h3>
206
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> rygel_media_item_get_place_holder (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>);</pre>
207
<div class="variablelist"><table border="0">
208
<col align="left" valign="top">
211
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
212
<td>the <a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> instance to query</td>
215
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
216
<td>the value of the <a href="../librygel-core/RygelMediaItem.html#RygelMediaItem--place-holder"><span class="type">"place-holder"</span></a> property</td>
222
<div class="refsect2">
223
<a name="rygel-media-item-set-place-holder"></a><h3>rygel_media_item_set_place_holder ()</h3>
224
<pre class="programlisting"><span class="returnvalue">void</span> rygel_media_item_set_place_holder (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
225
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);</pre>
226
<div class="variablelist"><table border="0">
227
<col align="left" valign="top">
230
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
231
<td>the <a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> instance to modify</td>
234
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
235
<td>the new value of the <a href="../librygel-core/RygelMediaItem.html#RygelMediaItem--place-holder"><span class="type">"place-holder"</span></a> property</td>
241
<div class="refsect2">
242
<a name="rygel-media-item-get-description"></a><h3>rygel_media_item_get_description ()</h3>
243
<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="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>);</pre>
244
<div class="variablelist"><table border="0">
245
<col align="left" valign="top">
248
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
249
<td>the <a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> instance to query</td>
252
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
253
<td>the value of the <span class="type">"description"</span> property</td>
259
<div class="refsect2">
260
<a name="rygel-media-item-set-description"></a><h3>rygel_media_item_set_description ()</h3>
261
<pre class="programlisting"><span class="returnvalue">void</span> rygel_media_item_set_description (<em class="parameter"><code><a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> *self</code></em>,
262
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
263
<div class="variablelist"><table border="0">
264
<col align="left" valign="top">
267
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
268
<td>the <a class="link" href="librygel-server-RygelMediaItem.html#RygelMediaItem" title="struct RygelMediaItem"><span class="type">RygelMediaItem</span></a> instance to modify</td>
271
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
272
<td>the new value of the <span class="type">"description"</span> property</td>
278
<div class="refsect2">
279
<a name="RygelMediaItem"></a><h3>struct RygelMediaItem</h3>
280
<pre class="programlisting">struct RygelMediaItem {
281
RygelMediaObject parent_instance;
282
RygelMediaItemPrivate * priv;
286
GRegex* address_regex;
290
Represents a media (Music, Video and Image) item.
297
Generated by GTK-Doc V1.18.1</div>
b'\\ No newline at end of file'