/usr/share/gtk-doc/html/buzztard-cmd/BtCmdApplication.html is in libbuzztard-dev 0.6.0-1.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 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BtCmdApplication</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Buzztard Bt-Cmd Reference Manual">
<link rel="up" href="uibtcmd.html" title="User Application API Reference">
<link rel="prev" href="buzztard-cmd-btcmd.html" title="btcmd">
<link rel="next" href="uibtcmdopts.html" title="User Application Command Line Reference">
<meta name="generator" content="GTK-Doc V1.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="buzztard-cmd-btcmd.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="uibtcmd.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Buzztard Bt-Cmd Reference Manual</th>
<td><a accesskey="n" href="uibtcmdopts.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#BtCmdApplication.synopsis" class="shortcut">Top</a>
|
<a href="#BtCmdApplication.description" class="shortcut">Description</a>
|
<a href="#BtCmdApplication.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#BtCmdApplication.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="BtCmdApplication"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="BtCmdApplication.top_of_page"></a>BtCmdApplication</span></h2>
<p>BtCmdApplication — class for a commandline based buzztard tool application</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="BtCmdApplication.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include "bt-cmd.h"
struct <a class="link" href="BtCmdApplication.html#BtCmdApplication-struct" title="struct BtCmdApplication">BtCmdApplication</a>;
<a class="link" href="BtCmdApplication.html" title="BtCmdApplication"><span class="returnvalue">BtCmdApplication</span></a> * <a class="link" href="BtCmdApplication.html#bt-cmd-application-new" title="bt_cmd_application_new ()">bt_cmd_application_new</a> (<em class="parameter"><code><span class="type">gboolean</span> quiet</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="BtCmdApplication.html#bt-cmd-application-play" title="bt_cmd_application_play ()">bt_cmd_application_play</a> (<em class="parameter"><code>const <a class="link" href="BtCmdApplication.html" title="BtCmdApplication"><span class="type">BtCmdApplication</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *input_file_name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="BtCmdApplication.html#bt-cmd-application-info" title="bt_cmd_application_info ()">bt_cmd_application_info</a> (<em class="parameter"><code>const <a class="link" href="BtCmdApplication.html" title="BtCmdApplication"><span class="type">BtCmdApplication</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *input_file_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *output_file_name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="BtCmdApplication.html#bt-cmd-application-convert" title="bt_cmd_application_convert ()">bt_cmd_application_convert</a> (<em class="parameter"><code>const <a class="link" href="BtCmdApplication.html" title="BtCmdApplication"><span class="type">BtCmdApplication</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *input_file_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *output_file_name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="BtCmdApplication.html#bt-cmd-application-encode" title="bt_cmd_application_encode ()">bt_cmd_application_encode</a> (<em class="parameter"><code>const <a class="link" href="BtCmdApplication.html" title="BtCmdApplication"><span class="type">BtCmdApplication</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *input_file_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *output_file_name</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="BtCmdApplication.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a href="../buzztard-core/BtApplication.html">BtApplication</a>
+----BtCmdApplication
</pre>
</div>
<div class="refsect1">
<a name="BtCmdApplication.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="BtCmdApplication.html#BtCmdApplication--quiet" title='The "quiet" property'>quiet</a>" <span class="type">gboolean</span> : Write
</pre>
</div>
<div class="refsect1">
<a name="BtCmdApplication.description"></a><h2>Description</h2>
<p>
This class implements the body of the buzztard commandline tool.
It provides application level function like play, convert and encode songs.
</p>
</div>
<div class="refsect1">
<a name="BtCmdApplication.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BtCmdApplication-struct"></a><h3>struct BtCmdApplication</h3>
<pre class="programlisting">struct BtCmdApplication;</pre>
<p>
<a href="../buzztard-core/BtApplication.html"><span class="type">BtApplication</span></a> subclass for the commandline application
</p>
</div>
<hr>
<div class="refsect2">
<a name="bt-cmd-application-new"></a><h3>bt_cmd_application_new ()</h3>
<pre class="programlisting"><a class="link" href="BtCmdApplication.html" title="BtCmdApplication"><span class="returnvalue">BtCmdApplication</span></a> * bt_cmd_application_new (<em class="parameter"><code><span class="type">gboolean</span> quiet</code></em>);</pre>
<p>
Create a new instance
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>quiet</code></em> :</span></p></td>
<td>do not output on stdout</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new instance or <code class="literal">NULL</code> in case of an error</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-cmd-application-play"></a><h3>bt_cmd_application_play ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> bt_cmd_application_play (<em class="parameter"><code>const <a class="link" href="BtCmdApplication.html" title="BtCmdApplication"><span class="type">BtCmdApplication</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *input_file_name</code></em>);</pre>
<p>
load and play the file of the supplied name
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the application instance to run</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>input_file_name</code></em> :</span></p></td>
<td>the file to play</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> for success</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-cmd-application-info"></a><h3>bt_cmd_application_info ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> bt_cmd_application_info (<em class="parameter"><code>const <a class="link" href="BtCmdApplication.html" title="BtCmdApplication"><span class="type">BtCmdApplication</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *input_file_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *output_file_name</code></em>);</pre>
<p>
load the file of the supplied name and print information about it to stdout.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the application instance to run</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>input_file_name</code></em> :</span></p></td>
<td>the file to print information about</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>output_file_name</code></em> :</span></p></td>
<td>the file to put informations from the input_file_name.
If the given file_name is NULL, stdout is used to print the informations.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> for success</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-cmd-application-convert"></a><h3>bt_cmd_application_convert ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> bt_cmd_application_convert (<em class="parameter"><code>const <a class="link" href="BtCmdApplication.html" title="BtCmdApplication"><span class="type">BtCmdApplication</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *input_file_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *output_file_name</code></em>);</pre>
<p>
Load the file of the supplied name and convert it into a buzztard song file.
The type of the input file is automatically determined.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the application instance to run</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>input_file_name</code></em> :</span></p></td>
<td>the file to read in</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>output_file_name</code></em> :</span></p></td>
<td>the file to generate</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> for success</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-cmd-application-encode"></a><h3>bt_cmd_application_encode ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> bt_cmd_application_encode (<em class="parameter"><code>const <a class="link" href="BtCmdApplication.html" title="BtCmdApplication"><span class="type">BtCmdApplication</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *input_file_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *output_file_name</code></em>);</pre>
<p>
Load the file of the supplied name and encode it as an audio file.
The type of the output file is automatically determined from the filename
extension.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the application instance to run</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>input_file_name</code></em> :</span></p></td>
<td>the file to read in</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>output_file_name</code></em> :</span></p></td>
<td>the file to generate</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> for success</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="BtCmdApplication.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="BtCmdApplication--quiet"></a><h3>The <code class="literal">"quiet"</code> property</h3>
<pre class="programlisting"> "quiet" <span class="type">gboolean</span> : Write</pre>
<p>tell wheter the app should do output or not.</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|