/usr/share/gtk-doc/html/libmatemixer/libmatemixer-MateMixer.html is in libmatemixer-doc 1.12.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MateMixer: libmatemixer Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libmatemixer Reference Manual">
<link rel="up" href="ch01.html" title="API Reference">
<link rel="prev" href="ch01.html" title="API Reference">
<link rel="next" href="MateMixerAppInfo.html" title="MateMixerAppInfo">
<meta name="generator" content="GTK-Doc V1.24 (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="#libmatemixer-MateMixer.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="MateMixerAppInfo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libmatemixer-MateMixer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libmatemixer-MateMixer.top_of_page"></a>MateMixer</span></h2>
<p>MateMixer — Library initialization and support functions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libmatemixer-MateMixer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table 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">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libmatemixer-MateMixer.html#mate-mixer-init" title="mate_mixer_init ()">mate_mixer_init</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="libmatemixer-MateMixer.html#mate-mixer-is-initialized" title="mate_mixer_is_initialized ()">mate_mixer_is_initialized</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libmatemixer-MateMixer.html#LIBMATEMIXER-CHECK-VERSION:CAPS" title="LIBMATEMIXER_CHECK_VERSION()">LIBMATEMIXER_CHECK_VERSION</a><span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libmatemixer-MateMixer.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libmatemixer/matemixer.h>
</pre>
</div>
<div class="refsect1">
<a name="libmatemixer-MateMixer.description"></a><h2>Description</h2>
<p>The libmatemixer library must be initialized before it is used by an
application. The initialization function loads dynamic modules which provide
access to sound systems (also called backends) and it only succeeds if there
is at least one usable module present on the target system.</p>
<p>To connect to a sound system and access the mixer functionality after the
library is initialized, create a <a class="link" href="MateMixerContext.html" title="MateMixerContext"><span class="type">MateMixerContext</span></a> using the
<a class="link" href="MateMixerContext.html#mate-mixer-context-new" title="mate_mixer_context_new ()"><code class="function">mate_mixer_context_new()</code></a> function.</p>
</div>
<div class="refsect1">
<a name="libmatemixer-MateMixer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="mate-mixer-init"></a><h3>mate_mixer_init ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
mate_mixer_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Initializes the library. You must call this function before using any other
function from the library.</p>
<div class="refsect3">
<a name="id-1.2.2.6.2.5"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> if the library installation does not
provide support for any sound system backends.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="mate-mixer-is-initialized"></a><h3>mate_mixer_is_initialized ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
mate_mixer_is_initialized (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns <code class="literal">TRUE</code> if the library has been initialized.</p>
<div class="refsect3">
<a name="id-1.2.2.6.3.5"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="LIBMATEMIXER-CHECK-VERSION:CAPS"></a><h3>LIBMATEMIXER_CHECK_VERSION()</h3>
<pre class="programlisting">#define LIBMATEMIXER_CHECK_VERSION(major, minor, micro)</pre>
<p>Compile-time version checking. Evaluates to <code class="literal">TRUE</code> if the version of the
library is greater than the required one.</p>
<div class="refsect3">
<a name="id-1.2.2.6.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>major</p></td>
<td class="parameter_description"><p>major version number</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>minor</p></td>
<td class="parameter_description"><p>minor version number</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>micro</p></td>
<td class="parameter_description"><p>micro version number</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libmatemixer-MateMixer.other_details"></a><h2>Types and Values</h2>
</div>
<div class="refsect1">
<a name="libmatemixer-MateMixer.see-also"></a><h2>See Also</h2>
<p><a class="link" href="MateMixerContext.html" title="MateMixerContext"><span class="type">MateMixerContext</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|