/usr/share/gtk-doc/html/libmediaart/libmediaart-Plugins.html is in libmediaart-doc 1.9.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 240 241 242 243 244 245 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Plugins: libmediaart Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libmediaart Library Reference Manual">
<link rel="up" href="ch02.html" title="Reference">
<link rel="prev" href="libmediaart-Cache.html" title="Cache">
<link rel="next" href="annotation-glossary.html" title="Annotation Glossary">
<meta name="generator" content="GTK-Doc V1.25 (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="#libmediaart-Plugins.description" class="shortcut">Description</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libmediaart-Cache.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="annotation-glossary.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libmediaart-Plugins"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libmediaart-Plugins.top_of_page"></a>Plugins</span></h2>
<p>Plugins — Plugins for cache conversion.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libmediaart-Plugins.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="libmediaart-Plugins.html#media-art-plugin-init" title="media_art_plugin_init ()">media_art_plugin_init</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="libmediaart-Plugins.html#media-art-plugin-shutdown" title="media_art_plugin_shutdown ()">media_art_plugin_shutdown</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libmediaart-Plugins.html#media-art-file-to-jpeg" title="media_art_file_to_jpeg ()">media_art_file_to_jpeg</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libmediaart-Plugins.html#media-art-buffer-to-jpeg" title="media_art_buffer_to_jpeg ()">media_art_buffer_to_jpeg</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libmediaart-Plugins.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libmediaart/mediaart.h>
</pre>
</div>
<div class="refsect1">
<a name="libmediaart-Plugins.description"></a><h2>Description</h2>
<p>Plugins are provided to allow different systems to make use of
existing file format conversion APIs. By default, a GdkPixbuf and
Qt implementation are provided. This API allows new implementations
to be provided.</p>
</div>
<div class="refsect1">
<a name="libmediaart-Plugins.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="media-art-plugin-init"></a><h3>media_art_plugin_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
media_art_plugin_init (<em class="parameter"><code><span class="type">gint</span> max_width</code></em>);</pre>
<p>This function facilitates a plugin's need to create any
internal caches before anything else is done. This function must
exist in each plugin and is called immediately after the plugin is
loaded. Conversely, <a class="link" href="libmediaart-Plugins.html#media-art-plugin-shutdown" title="media_art_plugin_shutdown ()"><code class="function">media_art_plugin_shutdown()</code></a> is called before
tear down of the plugin system or plugin itself.</p>
<div class="refsect3">
<a name="media-art-plugin-init.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>max_width</p></td>
<td class="parameter_description"><p>The maximum width that an image is allowed to be</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="media-art-plugin-shutdown"></a><h3>media_art_plugin_shutdown ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
media_art_plugin_shutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>This function facilitates a plugin's need to clean up any
internal caches. This function must exist in each plugin and is
called immediately after the plugin is loaded. Conversely,
<a class="link" href="libmediaart-Plugins.html#media-art-plugin-init" title="media_art_plugin_init ()"><code class="function">media_art_plugin_init()</code></a> is called after the plugin is loaded.</p>
<p class="since">Since: 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="media-art-file-to-jpeg"></a><h3>media_art_file_to_jpeg ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
media_art_file_to_jpeg (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *target</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Save <em class="parameter"><code>filename</code></em>
to <em class="parameter"><code>target</code></em>
as JPEG format. The <em class="parameter"><code>filename</code></em>
may not be
a JPEG in the first place.</p>
<div class="refsect3">
<a name="media-art-file-to-jpeg.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>filename</p></td>
<td class="parameter_description"><p>Original file name (not URI) to convert</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>Output file name (not URI) to save converted content to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A <span class="type">GError</span> to use upon failure, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="media-art-file-to-jpeg.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if conversion was successful, otherwise <code class="literal">FALSE</code> is
returned if <em class="parameter"><code>error</code></em>
is set.</p>
</div>
<p class="since">Since: 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="media-art-buffer-to-jpeg"></a><h3>media_art_buffer_to_jpeg ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
media_art_buffer_to_jpeg (<em class="parameter"><code>const unsigned <span class="type">char</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *buffer_mime</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *target</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>This function performs the same operation as
<a class="link" href="libmediaart-Plugins.html#media-art-file-to-jpeg" title="media_art_file_to_jpeg ()"><code class="function">media_art_file_to_jpeg()</code></a> with the exception that a raw <em class="parameter"><code>buffer</code></em>
can
be used instead providing <em class="parameter"><code>len</code></em>
and the <em class="parameter"><code>buffer_mime</code></em>
too.</p>
<div class="refsect3">
<a name="media-art-buffer-to-jpeg.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>buffer</p></td>
<td class="parameter_description"><p> Raw buffer representing content to save. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=len]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>Length of <em class="parameter"><code>buffer</code></em>
to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer_mime</p></td>
<td class="parameter_description"><p>MIME type for <em class="parameter"><code>buffer</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>Output file name (not URI) to save converted content to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A <span class="type">GError</span> to use upon failure, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="media-art-buffer-to-jpeg.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if conversion was successful, otherwise <code class="literal">FALSE</code> is
returned if <em class="parameter"><code>error</code></em>
is set.</p>
</div>
<p class="since">Since: 0.1.0</p>
</div>
</div>
<div class="refsect1">
<a name="libmediaart-Plugins.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|