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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RygelUpdatableObject: 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="RygelTrackableItem.html" title="RygelTrackableItem">
<link rel="next" href="RygelVideoItem.html" title="RygelVideoItem">
<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="#RygelUpdatableObject.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#RygelUpdatableObject.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
<a href="#RygelUpdatableObject.prerequisites" class="shortcut">Prerequisites</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="RygelTrackableItem.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="RygelVideoItem.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="RygelUpdatableObject"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RygelUpdatableObject.top_of_page"></a>RygelUpdatableObject</span></h2>
<p>RygelUpdatableObject — This interface should be implemented by 'updatable' objects - ones that allow modifying their own metadata in some persistent storage.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="RygelUpdatableObject.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">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RygelUpdatableObject.html#rygel-updatable-object-commit" title="rygel_updatable_object_commit ()">rygel_updatable_object_commit</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="RygelUpdatableObject.html#rygel-updatable-object-commit-finish" title="rygel_updatable_object_commit_finish ()">rygel_updatable_object_commit_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RygelUpdatableObject.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="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="RygelUpdatableObject.html#RygelUpdatableObject-struct" title="RygelUpdatableObject">RygelUpdatableObject</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="RygelUpdatableObject.html#RygelUpdatableObjectIface" title="struct RygelUpdatableObjectIface">RygelUpdatableObjectIface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RygelUpdatableObject.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> RygelUpdatableObject
</pre>
</div>
<div class="refsect1">
<a name="RygelUpdatableObject.prerequisites"></a><h2>Prerequisites</h2>
<p>
RygelUpdatableObject requires
<a class="link" href="RygelMediaObject.html" title="RygelMediaObject">RygelMediaObject</a>.</p>
</div>
<div class="refsect1">
<a name="RygelUpdatableObject.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="RygelUpdatableObject.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="rygel-updatable-object-commit"></a><h3>rygel_updatable_object_commit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rygel_updatable_object_commit (<em class="parameter"><code><a class="link" href="RygelUpdatableObject.html" title="RygelUpdatableObject"><span class="type">RygelUpdatableObject</span></a> *self</code></em>,
<em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> _callback_</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> _user_data_</code></em>);</pre>
<p>Commit changes in MediaObject to persistent storage.</p>
<p>This is called after properties are changed. This happens when e.g. UpdateObject was called on this object.</p>
<p><span class="emphasis"><em>See also</em></span>: <a class="link" href="RygelUpdatableObject.html#rygel-updatable-object-commit-finish" title="rygel_updatable_object_commit_finish ()"><code class="function">rygel_updatable_object_commit_finish()</code></a></p>
<div class="refsect3">
<a name="rygel-updatable-object-commit.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="RygelUpdatableObject.html" title="RygelUpdatableObject"><span class="type">RygelUpdatableObject</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>_callback_</p></td>
<td class="parameter_description"><p>callback to call when the request is satisfied. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>_user_data_</p></td>
<td class="parameter_description"><p>the data to pass to <em class="parameter"><code>_callback_</code></em>
function. </p></td>
<td class="parameter_annotations"><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></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rygel-updatable-object-commit-finish"></a><h3>rygel_updatable_object_commit_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rygel_updatable_object_commit_finish (<em class="parameter"><code><a class="link" href="RygelUpdatableObject.html" title="RygelUpdatableObject"><span class="type">RygelUpdatableObject</span></a> *self</code></em>,
<em class="parameter"><code><a href="../gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a> *_res_</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Commit changes in MediaObject to persistent storage.</p>
<p>This is called after properties are changed. This happens when e.g. UpdateObject was called on this object.</p>
<p><span class="emphasis"><em>See also</em></span>: <a class="link" href="RygelUpdatableObject.html#rygel-updatable-object-commit" title="rygel_updatable_object_commit ()"><code class="function">rygel_updatable_object_commit()</code></a></p>
<div class="refsect3">
<a name="rygel-updatable-object-commit-finish.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="RygelUpdatableObject.html" title="RygelUpdatableObject"><span class="type">RygelUpdatableObject</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>_res_</p></td>
<td class="parameter_description"><p>a <a href="../gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location to store the error occuring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="RygelUpdatableObject.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="RygelUpdatableObject-struct"></a><h3>RygelUpdatableObject</h3>
<pre class="programlisting">typedef struct _RygelUpdatableObject RygelUpdatableObject;</pre>
<p>This interface should be implemented by 'updatable' objects - ones that allow modifying their own metadata in some persistent storage.</p>
</div>
<hr>
<div class="refsect2">
<a name="RygelUpdatableObjectIface"></a><h3>struct RygelUpdatableObjectIface</h3>
<pre class="programlisting">struct RygelUpdatableObjectIface {
GTypeInterface parent_iface;
void (*commit) (RygelUpdatableObject* self, GAsyncReadyCallback _callback_, gpointer _user_data_);
void (*commit_finish) (RygelUpdatableObject* self, GAsyncResult* _res_, GError** error);
};
</pre>
<p>Interface for creating <a class="link" href="RygelUpdatableObject.html" title="RygelUpdatableObject"><span class="type">RygelUpdatableObject</span></a> implementations.</p>
<div class="refsect3">
<a name="RygelUpdatableObjectIface.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>
<tr>
<td class="struct_member_name"><p><a href="../gobject/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="RygelUpdatableObjectIface.parent-iface"></a>parent_iface</code></em>;</p></td>
<td class="struct_member_description"><p>the parent interface structure</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="RygelUpdatableObjectIface.commit"></a>commit</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual method called by <a class="link" href="RygelUpdatableObject.html#rygel-updatable-object-commit" title="rygel_updatable_object_commit ()"><code class="function">rygel_updatable_object_commit()</code></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="RygelUpdatableObjectIface.commit-finish"></a>commit_finish</code></em> ()</p></td>
<td class="struct_member_description"><p>asynchronous finish function for <em class="structfield"><code>commit</code></em>, called by <a class="link" href="RygelUpdatableObject.html#rygel-updatable-object-commit" title="rygel_updatable_object_commit ()"><code class="function">rygel_updatable_object_commit()</code></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|