1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2 <html> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5 <title>MixAudioConfigParamsMP3</title> 6 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2"> 7 <link rel="start" href="index.html" title="MixAudio Reference Manual"> 8 <link rel="up" href="ch01.html" title="Mix Audio API"> 9 <link rel="prev" href="MixAudio-MixAudioConfigParamsAAC.html" title="MixAudioConfigParamsAAC"> 10 <link rel="next" href="MixAudio-MixAudioConfigParamsWMA.html" title="MixAudioConfigParamsWMA"> 11 <meta name="generator" content="GTK-Doc V1.11 (XML mode)"> 12 <link rel="stylesheet" href="style.css" type="text/css"> 13 <link rel="chapter" href="ch01.html" title="Mix Audio API"> 14 <link rel="chapter" href="tree-hierarchy.html" title="Object Hierarchy"> 15 <link rel="index" href="api-index-full.html" title="API Index"> 16 </head> 17 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 18 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> 19 <tr valign="middle"> 20 <td><a accesskey="p" href="MixAudio-MixAudioConfigParamsAAC.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> 21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> 22 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> 23 <th width="100%" align="center">MixAudio Reference Manual</th> 24 <td><a accesskey="n" href="MixAudio-MixAudioConfigParamsWMA.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> 25 </tr> 26 <tr><td colspan="5" class="shortcuts"> 27 <a href="#MixAudio-MixAudioConfigParamsMP3.synopsis" class="shortcut">Top</a> 28 | 29 <a href="#MixAudio-MixAudioConfigParamsMP3.description" class="shortcut">Description</a> 30 </td></tr> 31 </table> 32 <div class="refentry" lang="en"> 33 <a name="MixAudio-MixAudioConfigParamsMP3"></a><div class="titlepage"></div> 34 <div class="refnamediv"><table width="100%"><tr> 35 <td valign="top"> 36 <h2><span class="refentrytitle"><a name="MixAudio-MixAudioConfigParamsMP3.top_of_page"></a>MixAudioConfigParamsMP3</span></h2> 37 <p>MixAudioConfigParamsMP3 Audio configuration parameters for MP3 audio.</p> 38 </td> 39 <td valign="top" align="right"></td> 40 </tr></table></div> 41 <div class="refsynopsisdiv"> 42 <a name="MixAudio-MixAudioConfigParamsMP3.synopsis"></a><h2>Synopsis</h2> 43 <pre class="synopsis"> 44 45 #include <mixacpmp3.h> 46 47 <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MixAudioConfigParamsMP3" title="MixAudioConfigParamsMP3">MixAudioConfigParamsMP3</a>; 48 <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MixAudioConfigParamsMP3" title="MixAudioConfigParamsMP3">MixAudioConfigParamsMP3</a> * <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#mix-acp-mp3-new" title="mix_acp_mp3_new ()">mix_acp_mp3_new</a> (void); 49 <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MixAudioConfigParamsMP3" title="MixAudioConfigParamsMP3">MixAudioConfigParamsMP3</a> * <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#mix-acp-mp3-ref" title="mix_acp_mp3_ref ()">mix_acp_mp3_ref</a> (<a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MixAudioConfigParamsMP3" title="MixAudioConfigParamsMP3">MixAudioConfigParamsMP3</a> *mix); 50 #define <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#mix-acp-mp3-unref" title="mix_acp_mp3_unref()">mix_acp_mp3_unref</a> (obj) 51 #define <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MIX-ACP-MP3-CRC--CAPS" title="MIX_ACP_MP3_CRC()">MIX_ACP_MP3_CRC</a> (obj) 52 #define <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MIX-ACP-MP3-MPEG-FORMAT--CAPS" title="MIX_ACP_MP3_MPEG_FORMAT()">MIX_ACP_MP3_MPEG_FORMAT</a> (obj) 53 #define <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MIX-ACP-MP3-MPEG-LAYER--CAPS" title="MIX_ACP_MP3_MPEG_LAYER()">MIX_ACP_MP3_MPEG_LAYER</a> (obj) 54 </pre> 55 </div> 56 <div class="refsect1" lang="en"> 57 <a name="MixAudio-MixAudioConfigParamsMP3.description"></a><h2>Description</h2> 58 <p> 59 A data object which stores audio specific parameters for MP3 audio. 60 </p> 61 <p> 62 Additional parameters must be set in the parent object <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a></p> 63 </div> 64 <div class="refsect1" lang="en"> 65 <a name="MixAudio-MixAudioConfigParamsMP3.details"></a><h2>Details</h2> 66 <div class="refsect2" lang="en"> 67 <a name="MixAudioConfigParamsMP3"></a><h3>MixAudioConfigParamsMP3</h3> 68 <pre class="programlisting">typedef struct { 69 MixAudioConfigParams parent; 70 71 /* Audio Format Parameters */ 72 gboolean CRC; 73 gint MPEG_format; 74 gint MPEG_layer; 75 } MixAudioConfigParamsMP3; 76 </pre> 77 <p> 78 MI-X Audio Parameter object for MP3 Audio.</p> 79 <div class="variablelist"><table border="0"> 80 <col align="left" valign="top"> 81 <tbody> 82 <tr> 83 <td><p><span class="term"><a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a><em class="structfield"><code>parent</code></em>;</span></p></td> 84 <td> parent. 85 </td> 86 </tr> 87 <tr> 88 <td><p><span class="term">gboolean<em class="structfield"><code>CRC</code></em>;</span></p></td> 89 <td> CRC. See <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MIX-ACP-MP3-CRC--CAPS" title="MIX_ACP_MP3_CRC()"><span class="type">MIX_ACP_MP3_CRC</span></a> 90 </td> 91 </tr> 92 <tr> 93 <td><p><span class="term">gint<em class="structfield"><code>MPEG_format</code></em>;</span></p></td> 94 <td> <span class="emphasis"><em>Optional</em></span>MPEG format of the mpeg audio. See <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MIX-ACP-MP3-MPEG-FORMAT--CAPS" title="MIX_ACP_MP3_MPEG_FORMAT()"><span class="type">MIX_ACP_MP3_MPEG_FORMAT</span></a> 95 </td> 96 </tr> 97 <tr> 98 <td><p><span class="term">gint<em class="structfield"><code>MPEG_layer</code></em>;</span></p></td> 99 <td> <span class="emphasis"><em>Optional</em></span>MPEG layer of the mpeg audio. See <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MIX-ACP-MP3-MPEG-LAYER--CAPS" title="MIX_ACP_MP3_MPEG_LAYER()"><span class="type">MIX_ACP_MP3_MPEG_LAYER</span></a> 100 </td> 101 </tr> 102 </tbody> 103 </table></div> 104 </div> 105 <hr> 106 <div class="refsect2" lang="en"> 107 <a name="mix-acp-mp3-new"></a><h3>mix_acp_mp3_new ()</h3> 108 <pre class="programlisting"><a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MixAudioConfigParamsMP3" title="MixAudioConfigParamsMP3">MixAudioConfigParamsMP3</a> * mix_acp_mp3_new (void);</pre> 109 <p> 110 Use this method to create new instance of <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MixAudioConfigParamsMP3" title="MixAudioConfigParamsMP3"><span class="type">MixAudioConfigParamsMP3</span></a></p> 111 <div class="variablelist"><table border="0"> 112 <col align="left" valign="top"> 113 <tbody><tr> 114 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 115 <td> A newly allocated instance of <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MixAudioConfigParamsMP3" title="MixAudioConfigParamsMP3"><span class="type">MixAudioConfigParamsMP3</span></a> 116 </td> 117 </tr></tbody> 118 </table></div> 119 </div> 120 <hr> 121 <div class="refsect2" lang="en"> 122 <a name="mix-acp-mp3-ref"></a><h3>mix_acp_mp3_ref ()</h3> 123 <pre class="programlisting"><a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MixAudioConfigParamsMP3" title="MixAudioConfigParamsMP3">MixAudioConfigParamsMP3</a> * mix_acp_mp3_ref (<a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MixAudioConfigParamsMP3" title="MixAudioConfigParamsMP3">MixAudioConfigParamsMP3</a> *mix);</pre> 124 <p> 125 Add reference count.</p> 126 <div class="variablelist"><table border="0"> 127 <col align="left" valign="top"> 128 <tbody> 129 <tr> 130 <td><p><span class="term"><em class="parameter"><code>mix</code></em>:</span></p></td> 131 <td> object to add reference 132 </td> 133 </tr> 134 <tr> 135 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 136 <td> the MixAudioConfigParamsMP3 instance where reference count has been increased. 137 </td> 138 </tr> 139 </tbody> 140 </table></div> 141 </div> 142 <hr> 143 <div class="refsect2" lang="en"> 144 <a name="mix-acp-mp3-unref"></a><h3>mix_acp_mp3_unref()</h3> 145 <pre class="programlisting">#define mix_acp_mp3_unref(obj) mix_params_unref(MIX_PARAMS(obj)) 146 </pre> 147 <p> 148 Decrement reference count of the object.</p> 149 <div class="variablelist"><table border="0"> 150 <col align="left" valign="top"> 151 <tbody><tr> 152 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 153 <td> object to unref. 154 </td> 155 </tr></tbody> 156 </table></div> 157 </div> 158 <hr> 159 <div class="refsect2" lang="en"> 160 <a name="MIX-ACP-MP3-CRC--CAPS"></a><h3>MIX_ACP_MP3_CRC()</h3> 161 <pre class="programlisting">#define MIX_ACP_MP3_CRC(obj) (MIX_AUDIOCONFIGPARAMSMP3(obj)->CRC) 162 </pre> 163 <p> 164 MixAudioConfigParamMP3.CRC accessor. 165 </p> 166 <p> 167 <em><span class="remark">Optional</span></em></p> 168 <div class="variablelist"><table border="0"> 169 <col align="left" valign="top"> 170 <tbody><tr> 171 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 172 <td> <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MixAudioConfigParamsMP3" title="MixAudioConfigParamsMP3"><span class="type">MixAudioConfigParamsMP3</span></a> object. 173 </td> 174 </tr></tbody> 175 </table></div> 176 </div> 177 <hr> 178 <div class="refsect2" lang="en"> 179 <a name="MIX-ACP-MP3-MPEG-FORMAT--CAPS"></a><h3>MIX_ACP_MP3_MPEG_FORMAT()</h3> 180 <pre class="programlisting">#define MIX_ACP_MP3_MPEG_FORMAT(obj) (MIX_AUDIOCONFIGPARAMSMP3(obj)->MPEG_format) 181 </pre> 182 <p> 183 MixAudioConfigParamMP3.MPEG_format accessor. 184 </p> 185 <p> 186 Supported MPEG format should be 1 or 2.</p> 187 <div class="variablelist"><table border="0"> 188 <col align="left" valign="top"> 189 <tbody><tr> 190 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 191 <td> <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MixAudioConfigParamsMP3" title="MixAudioConfigParamsMP3"><span class="type">MixAudioConfigParamsMP3</span></a> object. 192 </td> 193 </tr></tbody> 194 </table></div> 195 </div> 196 <hr> 197 <div class="refsect2" lang="en"> 198 <a name="MIX-ACP-MP3-MPEG-LAYER--CAPS"></a><h3>MIX_ACP_MP3_MPEG_LAYER()</h3> 199 <pre class="programlisting">#define MIX_ACP_MP3_MPEG_LAYER(obj) (MIX_AUDIOCONFIGPARAMSMP3(obj)->MPEG_layer) 200 </pre> 201 <p> 202 MixAudioConfigParamMP3.MPEG_layer accessor. 203 </p> 204 <p> 205 Supported layer should be 1, 2, or 3.</p> 206 <div class="variablelist"><table border="0"> 207 <col align="left" valign="top"> 208 <tbody><tr> 209 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 210 <td> <a class="link" href="MixAudio-MixAudioConfigParamsMP3.html#MixAudioConfigParamsMP3" title="MixAudioConfigParamsMP3"><span class="type">MixAudioConfigParamsMP3</span></a> object. 211 </td> 212 </tr></tbody> 213 </table></div> 214 </div> 215 </div> 216 </div> 217 <div class="footer"> 218 <hr> 219 Generated by GTK-Doc V1.11</div> 220 </body> 221 </html> 222