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>MixAudioConfigParams</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-MixAudioConfigParamsWMA.html" title="MixAudioConfigParamsWMA"> 10 <link rel="next" href="MixAudio-MixAudioInitParams.html" title="MixAudioInitParams"> 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-MixAudioConfigParamsWMA.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-MixAudioInitParams.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-MixAudioConfigParams.synopsis" class="shortcut">Top</a> 28 | 29 <a href="#MixAudio-MixAudioConfigParams.description" class="shortcut">Description</a> 30 </td></tr> 31 </table> 32 <div class="refentry" lang="en"> 33 <a name="MixAudio-MixAudioConfigParams"></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-MixAudioConfigParams.top_of_page"></a>MixAudioConfigParams</span></h2> 37 <p>MixAudioConfigParams MixAudio configuration parameters object.</p> 38 </td> 39 <td valign="top" align="right"></td> 40 </tr></table></div> 41 <div class="refsynopsisdiv"> 42 <a name="MixAudio-MixAudioConfigParams.synopsis"></a><h2>Synopsis</h2> 43 <pre class="synopsis"> 44 45 #include <mixacp.h> 46 47 enum <a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPOpAlign" title="enum MixACPOpAlign">MixACPOpAlign</a>; 48 enum <a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPBPSType" title="enum MixACPBPSType">MixACPBPSType</a>; 49 enum <a class="link" href="MixAudio-MixAudioConfigParams.html#MixDecodeMode" title="enum MixDecodeMode">MixDecodeMode</a>; 50 <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a>; 51 <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> * <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-new" title="mix_acp_new ()">mix_acp_new</a> (void); 52 <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> * <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-ref" title="mix_acp_ref ()">mix_acp_ref</a> (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *mix); 53 #define <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-unref" title="mix_acp_unref()">mix_acp_unref</a> (obj) 54 #define <a class="link" href="MixAudio-MixAudioConfigParams.html#MIX-ACP-DECODEMODE--CAPS" title="MIX_ACP_DECODEMODE()">MIX_ACP_DECODEMODE</a> (obj) 55 #define <a class="link" href="MixAudio-MixAudioConfigParams.html#MIX-ACP-NUM-CHANNELS--CAPS" title="MIX_ACP_NUM_CHANNELS()">MIX_ACP_NUM_CHANNELS</a> (obj) 56 #define <a class="link" href="MixAudio-MixAudioConfigParams.html#MIX-ACP-BITRATE--CAPS" title="MIX_ACP_BITRATE()">MIX_ACP_BITRATE</a> (obj) 57 #define <a class="link" href="MixAudio-MixAudioConfigParams.html#MIX-ACP-SAMPLE-FREQ--CAPS" title="MIX_ACP_SAMPLE_FREQ()">MIX_ACP_SAMPLE_FREQ</a> (obj) 58 <a class="link" href="MixAudio-MixAudioConfigParams.html#MixDecodeMode" title="enum MixDecodeMode">MixDecodeMode</a> <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-get-decodemode" title="mix_acp_get_decodemode ()">mix_acp_get_decodemode</a> (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj); 59 MIX_RESULT <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-set-decodemode" title="mix_acp_set_decodemode ()">mix_acp_set_decodemode</a> (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj, 60 <a class="link" href="MixAudio-MixAudioConfigParams.html#MixDecodeMode" title="enum MixDecodeMode">MixDecodeMode</a> mode); 61 gchar * <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-get-streamname" title="mix_acp_get_streamname ()">mix_acp_get_streamname</a> (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj); 62 MIX_RESULT <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-set-streamname" title="mix_acp_set_streamname ()">mix_acp_set_streamname</a> (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj, 63 const gchar *streamname); 64 MIX_RESULT <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-set-audio-manager" title="mix_acp_set_audio_manager ()">mix_acp_set_audio_manager</a> (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj, 65 <a class="link" href="MixAudio-mixaudiotypes.html#MixAudioManager" title="enum MixAudioManager">MixAudioManager</a> am); 66 <a class="link" href="MixAudio-mixaudiotypes.html#MixAudioManager" title="enum MixAudioManager">MixAudioManager</a> <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-get-audio-manager" title="mix_acp_get_audio_manager ()">mix_acp_get_audio_manager</a> (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj); 67 gboolean <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-is-streamname-valid" title="mix_acp_is_streamname_valid ()">mix_acp_is_streamname_valid</a> (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj); 68 <a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPBPSType" title="enum MixACPBPSType">MixACPBPSType</a> <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-get-bps" title="mix_acp_get_bps ()">mix_acp_get_bps</a> (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj); 69 MIX_RESULT <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-set-bps" title="mix_acp_set_bps ()">mix_acp_set_bps</a> (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj, 70 <a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPBPSType" title="enum MixACPBPSType">MixACPBPSType</a> type); 71 <a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPOpAlign" title="enum MixACPOpAlign">MixACPOpAlign</a> <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-get-op-align" title="mix_acp_get_op_align ()">mix_acp_get_op_align</a> (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj); 72 MIX_RESULT <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-set-op-align" title="mix_acp_set_op_align ()">mix_acp_set_op_align</a> (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj, 73 <a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPOpAlign" title="enum MixACPOpAlign">MixACPOpAlign</a> op_align); 74 </pre> 75 </div> 76 <div class="refsect1" lang="en"> 77 <a name="MixAudio-MixAudioConfigParams.description"></a><h2>Description</h2> 78 <p> 79 <a class="link" href="MixAudio.html" title="MixAudio"><span class="type">MixAudio</span></a> configuration parameters object which is used to communicate audio specific parameters. 80 </p> 81 <p> 82 This object is should not be instantiated as codec specific parameters are definied in individual derive classes.</p> 83 </div> 84 <div class="refsect1" lang="en"> 85 <a name="MixAudio-MixAudioConfigParams.details"></a><h2>Details</h2> 86 <div class="refsect2" lang="en"> 87 <a name="MixACPOpAlign"></a><h3>enum MixACPOpAlign</h3> 88 <pre class="programlisting">typedef enum { 89 MIX_ACP_OUTPUT_ALIGN_UNKNOWN=-1, 90 MIX_ACP_OUTPUT_ALIGN_16=0, 91 MIX_ACP_OUTPUT_ALIGN_MSB, 92 MIX_ACP_OUTPUT_ALIGN_LSB, 93 MIX_ACP_OUTPUT_ALIGN_LAST 94 } MixACPOpAlign; 95 </pre> 96 <p> 97 Audio Output alignment.</p> 98 <div class="variablelist"><table border="0"> 99 <col align="left" valign="top"> 100 <tbody> 101 <tr> 102 <td><p><a name="MIX-ACP-OUTPUT-ALIGN-UNKNOWN--CAPS"></a><span class="term"><code class="literal">MIX_ACP_OUTPUT_ALIGN_UNKNOWN</code></span></p></td> 103 <td> Output alignment undefined. 104 </td> 105 </tr> 106 <tr> 107 <td><p><a name="MIX-ACP-OUTPUT-ALIGN-16--CAPS"></a><span class="term"><code class="literal">MIX_ACP_OUTPUT_ALIGN_16</code></span></p></td> 108 <td></td> 109 </tr> 110 <tr> 111 <td><p><a name="MIX-ACP-OUTPUT-ALIGN-MSB--CAPS"></a><span class="term"><code class="literal">MIX_ACP_OUTPUT_ALIGN_MSB</code></span></p></td> 112 <td> Output word is MSB aligned 113 </td> 114 </tr> 115 <tr> 116 <td><p><a name="MIX-ACP-OUTPUT-ALIGN-LSB--CAPS"></a><span class="term"><code class="literal">MIX_ACP_OUTPUT_ALIGN_LSB</code></span></p></td> 117 <td> Output word is LSB aligned 118 </td> 119 </tr> 120 <tr> 121 <td><p><a name="MIX-ACP-OUTPUT-ALIGN-LAST--CAPS"></a><span class="term"><code class="literal">MIX_ACP_OUTPUT_ALIGN_LAST</code></span></p></td> 122 <td> Last entry in list. 123 </td> 124 </tr> 125 </tbody> 126 </table></div> 127 </div> 128 <hr> 129 <div class="refsect2" lang="en"> 130 <a name="MixACPBPSType"></a><h3>enum MixACPBPSType</h3> 131 <pre class="programlisting">typedef enum { 132 MIX_ACP_BPS_UNKNOWN=0, 133 MIX_ACP_BPS_16=16, 134 MIX_ACP_BPS_24=24, 135 } MixACPBPSType; 136 </pre> 137 <p> 138 Audio Output Size in bits per sample.</p> 139 <div class="variablelist"><table border="0"> 140 <col align="left" valign="top"> 141 <tbody> 142 <tr> 143 <td><p><a name="MIX-ACP-BPS-UNKNOWN--CAPS"></a><span class="term"><code class="literal">MIX_ACP_BPS_UNKNOWN</code></span></p></td> 144 <td> Bit Per Sample undefined. 145 </td> 146 </tr> 147 <tr> 148 <td><p><a name="MIX-ACP-BPS-16--CAPS"></a><span class="term"><code class="literal">MIX_ACP_BPS_16</code></span></p></td> 149 <td> Output bits per sample is 16 bits 150 </td> 151 </tr> 152 <tr> 153 <td><p><a name="MIX-ACP-BPS-24--CAPS"></a><span class="term"><code class="literal">MIX_ACP_BPS_24</code></span></p></td> 154 <td> Output bits per sample is 24 bits 155 </td> 156 </tr> 157 </tbody> 158 </table></div> 159 </div> 160 <hr> 161 <div class="refsect2" lang="en"> 162 <a name="MixDecodeMode"></a><h3>enum MixDecodeMode</h3> 163 <pre class="programlisting">typedef enum { 164 MIX_DECODE_NULL=0, 165 MIX_DECODE_DIRECTRENDER, 166 MIX_DECODE_DECODERETURN, 167 MIX_DECODE_LAST 168 } MixDecodeMode; 169 </pre> 170 <p> 171 Operation Mode for a MI-X session. See <a class="link" href="MixAudio.html#mix-audio-configure" title="mix_audio_configure ()"><code class="function">mix_audio_configure()</code></a>.</p> 172 <div class="variablelist"><table border="0"> 173 <col align="left" valign="top"> 174 <tbody> 175 <tr> 176 <td><p><a name="MIX-DECODE-NULL--CAPS"></a><span class="term"><code class="literal">MIX_DECODE_NULL</code></span></p></td> 177 <td> Undefined decode mode. 178 </td> 179 </tr> 180 <tr> 181 <td><p><a name="MIX-DECODE-DIRECTRENDER--CAPS"></a><span class="term"><code class="literal">MIX_DECODE_DIRECTRENDER</code></span></p></td> 182 <td> Stream is configured in Direct Render mode 183 </td> 184 </tr> 185 <tr> 186 <td><p><a name="MIX-DECODE-DECODERETURN--CAPS"></a><span class="term"><code class="literal">MIX_DECODE_DECODERETURN</code></span></p></td> 187 <td> Stream is configured in Decode Return mode 188 </td> 189 </tr> 190 <tr> 191 <td><p><a name="MIX-DECODE-LAST--CAPS"></a><span class="term"><code class="literal">MIX_DECODE_LAST</code></span></p></td> 192 <td> Last index in the enumeration. 193 </td> 194 </tr> 195 </tbody> 196 </table></div> 197 </div> 198 <hr> 199 <div class="refsect2" lang="en"> 200 <a name="MixAudioConfigParams"></a><h3>MixAudioConfigParams</h3> 201 <pre class="programlisting">typedef struct { 202 MixParams parent; 203 204 /* Audio Session Parameters */ 205 MixDecodeMode decode_mode; 206 gchar *stream_name; 207 MixAudioManager audio_manager; 208 209 /* Audio Format Parameters */ 210 gint num_channels; 211 gint bit_rate; 212 gint sample_freq; 213 MixACPBPSType bits_per_sample; 214 MixACPOpAlign op_align; 215 } MixAudioConfigParams; 216 </pre> 217 <p> 218 <em class="parameter"><code>MixAudio</code></em> configuration parameters object.</p> 219 <div class="variablelist"><table border="0"> 220 <col align="left" valign="top"> 221 <tbody> 222 <tr> 223 <td><p><span class="term">MixParams<em class="structfield"><code>parent</code></em>;</span></p></td> 224 <td> parent. 225 </td> 226 </tr> 227 <tr> 228 <td><p><span class="term"><a class="link" href="MixAudio-MixAudioConfigParams.html#MixDecodeMode" title="enum MixDecodeMode">MixDecodeMode</a><em class="structfield"><code>decode_mode</code></em>;</span></p></td> 229 <td> Decode Mode to use for current session. See <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-set-decodemode" title="mix_acp_set_decodemode ()"><span class="type">mix_acp_set_decodemode</span></a> 230 </td> 231 </tr> 232 <tr> 233 <td><p><span class="term">gchar*<em class="structfield"><code>stream_name</code></em>;</span></p></td> 234 <td> Stream name. See <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-set-streamname" title="mix_acp_set_streamname ()"><span class="type">mix_acp_set_streamname</span></a>. This object will release the string upon destruction. 235 </td> 236 </tr> 237 <tr> 238 <td><p><span class="term"><a class="link" href="MixAudio-mixaudiotypes.html#MixAudioManager" title="enum MixAudioManager">MixAudioManager</a><em class="structfield"><code>audio_manager</code></em>;</span></p></td> 239 <td> Type of Audio Manager. See <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-set-audio-manager" title="mix_acp_set_audio_manager ()"><span class="type">mix_acp_set_audio_manager</span></a>. 240 </td> 241 </tr> 242 <tr> 243 <td><p><span class="term">gint<em class="structfield"><code>num_channels</code></em>;</span></p></td> 244 <td> Number of output channels. See <a class="link" href="MixAudio-MixAudioConfigParams.html#MIX-ACP-NUM-CHANNELS--CAPS" title="MIX_ACP_NUM_CHANNELS()"><span class="type">MIX_ACP_NUM_CHANNELS</span></a> 245 </td> 246 </tr> 247 <tr> 248 <td><p><span class="term">gint<em class="structfield"><code>bit_rate</code></em>;</span></p></td> 249 <td> <span class="emphasis"><em>Optional.</em></span> See <a class="link" href="MixAudio-MixAudioConfigParams.html#MIX-ACP-BITRATE--CAPS" title="MIX_ACP_BITRATE()"><span class="type">MIX_ACP_BITRATE</span></a> 250 </td> 251 </tr> 252 <tr> 253 <td><p><span class="term">gint<em class="structfield"><code>sample_freq</code></em>;</span></p></td> 254 <td> Output frequency. See <a class="link" href="MixAudio-MixAudioConfigParams.html#MIX-ACP-SAMPLE-FREQ--CAPS" title="MIX_ACP_SAMPLE_FREQ()"><span class="type">MIX_ACP_SAMPLE_FREQ</span></a> 255 </td> 256 </tr> 257 <tr> 258 <td><p><span class="term"><a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPBPSType" title="enum MixACPBPSType">MixACPBPSType</a><em class="structfield"><code>bits_per_sample</code></em>;</span></p></td> 259 <td> Number of output bit per sample. See <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-set-bps" title="mix_acp_set_bps ()"><span class="type">mix_acp_set_bps</span></a> 260 </td> 261 </tr> 262 <tr> 263 <td><p><span class="term"><a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPOpAlign" title="enum MixACPOpAlign">MixACPOpAlign</a><em class="structfield"><code>op_align</code></em>;</span></p></td> 264 <td> Output Byte Alignment. See <a class="link" href="MixAudio-MixAudioConfigParams.html#mix-acp-set-op-align" title="mix_acp_set_op_align ()"><span class="type">mix_acp_set_op_align</span></a> 265 </td> 266 </tr> 267 </tbody> 268 </table></div> 269 </div> 270 <hr> 271 <div class="refsect2" lang="en"> 272 <a name="mix-acp-new"></a><h3>mix_acp_new ()</h3> 273 <pre class="programlisting"><a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> * mix_acp_new (void);</pre> 274 <p> 275 Use this method to create new instance of <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a></p> 276 <div class="variablelist"><table border="0"> 277 <col align="left" valign="top"> 278 <tbody><tr> 279 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 280 <td> A newly allocated instance of <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> 281 </td> 282 </tr></tbody> 283 </table></div> 284 </div> 285 <hr> 286 <div class="refsect2" lang="en"> 287 <a name="mix-acp-ref"></a><h3>mix_acp_ref ()</h3> 288 <pre class="programlisting"><a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> * mix_acp_ref (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *mix);</pre> 289 <p> 290 Add reference count.</p> 291 <div class="variablelist"><table border="0"> 292 <col align="left" valign="top"> 293 <tbody> 294 <tr> 295 <td><p><span class="term"><em class="parameter"><code>mix</code></em>:</span></p></td> 296 <td> object to add reference 297 </td> 298 </tr> 299 <tr> 300 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 301 <td> the MixAudioConfigParams instance where reference count has been increased. 302 </td> 303 </tr> 304 </tbody> 305 </table></div> 306 </div> 307 <hr> 308 <div class="refsect2" lang="en"> 309 <a name="mix-acp-unref"></a><h3>mix_acp_unref()</h3> 310 <pre class="programlisting">#define mix_acp_unref(obj) mix_params_unref(MIX_PARAMS(obj)) 311 </pre> 312 <p> 313 Decrement reference count of the object.</p> 314 <div class="variablelist"><table border="0"> 315 <col align="left" valign="top"> 316 <tbody><tr> 317 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 318 <td> object to unref. 319 </td> 320 </tr></tbody> 321 </table></div> 322 </div> 323 <hr> 324 <div class="refsect2" lang="en"> 325 <a name="MIX-ACP-DECODEMODE--CAPS"></a><h3>MIX_ACP_DECODEMODE()</h3> 326 <pre class="programlisting">#define MIX_ACP_DECODEMODE(obj) (MIX_AUDIOCONFIGPARAMS(obj)->decode_mode) 327 </pre> 328 <p> 329 MixAudioConfigParam.decode_mode accessor. 330 </p> 331 <p> 332 Configure the decode mode to one of <a class="link" href="MixAudio-MixAudioConfigParams.html#MixDecodeMode" title="enum MixDecodeMode"><span class="type">MixDecodeMode</span></a> value.</p> 333 <div class="variablelist"><table border="0"> 334 <col align="left" valign="top"> 335 <tbody><tr> 336 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 337 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> object 338 </td> 339 </tr></tbody> 340 </table></div> 341 </div> 342 <hr> 343 <div class="refsect2" lang="en"> 344 <a name="MIX-ACP-NUM-CHANNELS--CAPS"></a><h3>MIX_ACP_NUM_CHANNELS()</h3> 345 <pre class="programlisting">#define MIX_ACP_NUM_CHANNELS(obj) (MIX_AUDIOCONFIGPARAMS(obj)->num_channels) 346 </pre> 347 <p> 348 MixAudioConfigParam.num_channels accessor. 349 </p> 350 <p> 351 Configure the number of output channels. This value need to be exact the same as the supported output channel in the audio since down-mixing is not supported. 352 </p> 353 <p> 354 This value can be used during <a class="link" href="MixAudio-MixAudioConfigParams.html#MIX-DECODE-DECODERETURN--CAPS"><span class="type">MIX_DECODE_DECODERETURN</span></a> mode for buffer size/duration calculation. 355 </p> 356 <p> 357 In Moorestown, number of channel must be 1 or 2.</p> 358 <div class="variablelist"><table border="0"> 359 <col align="left" valign="top"> 360 <tbody><tr> 361 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 362 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> object 363 </td> 364 </tr></tbody> 365 </table></div> 366 </div> 367 <hr> 368 <div class="refsect2" lang="en"> 369 <a name="MIX-ACP-BITRATE--CAPS"></a><h3>MIX_ACP_BITRATE()</h3> 370 <pre class="programlisting">#define MIX_ACP_BITRATE(obj) (MIX_AUDIOCONFIGPARAMS(obj)->bit_rate) 371 </pre> 372 <p> 373 MixAudioConfigParam.bit_rate accessor. 374 </p> 375 <p> 376 Bit rate of the current audio. 377 </p> 378 <p> 379 <em><span class="remark">Optional</span></em></p> 380 <div class="variablelist"><table border="0"> 381 <col align="left" valign="top"> 382 <tbody><tr> 383 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 384 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> object 385 </td> 386 </tr></tbody> 387 </table></div> 388 </div> 389 <hr> 390 <div class="refsect2" lang="en"> 391 <a name="MIX-ACP-SAMPLE-FREQ--CAPS"></a><h3>MIX_ACP_SAMPLE_FREQ()</h3> 392 <pre class="programlisting">#define MIX_ACP_SAMPLE_FREQ(obj) (MIX_AUDIOCONFIGPARAMS(obj)->sample_freq) 393 </pre> 394 <p> 395 MixAudioConfigParam.sample_freq accessor. 396 </p> 397 <p> 398 Output sampling frequency. 399 </p> 400 <p> 401 This value can be used during <a class="link" href="MixAudio-MixAudioConfigParams.html#MIX-DECODE-DECODERETURN--CAPS"><span class="type">MIX_DECODE_DECODERETURN</span></a> mode for buffer size/duration calculation.</p> 402 <div class="variablelist"><table border="0"> 403 <col align="left" valign="top"> 404 <tbody><tr> 405 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 406 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> object 407 </td> 408 </tr></tbody> 409 </table></div> 410 </div> 411 <hr> 412 <div class="refsect2" lang="en"> 413 <a name="mix-acp-get-decodemode"></a><h3>mix_acp_get_decodemode ()</h3> 414 <pre class="programlisting"><a class="link" href="MixAudio-MixAudioConfigParams.html#MixDecodeMode" title="enum MixDecodeMode">MixDecodeMode</a> mix_acp_get_decodemode (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj);</pre> 415 <p> 416 Retrieve currently configured <a class="link" href="MixAudio-MixAudioConfigParams.html#MixDecodeMode" title="enum MixDecodeMode"><span class="type">MixDecodeMode</span></a>.</p> 417 <div class="variablelist"><table border="0"> 418 <col align="left" valign="top"> 419 <tbody> 420 <tr> 421 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 422 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> 423 </td> 424 </tr> 425 <tr> 426 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 427 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixDecodeMode" title="enum MixDecodeMode"><span class="type">MixDecodeMode</span></a> 428 </td> 429 </tr> 430 </tbody> 431 </table></div> 432 </div> 433 <hr> 434 <div class="refsect2" lang="en"> 435 <a name="mix-acp-set-decodemode"></a><h3>mix_acp_set_decodemode ()</h3> 436 <pre class="programlisting">MIX_RESULT mix_acp_set_decodemode (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj, 437 <a class="link" href="MixAudio-MixAudioConfigParams.html#MixDecodeMode" title="enum MixDecodeMode">MixDecodeMode</a> mode);</pre> 438 <p> 439 Configure session for one of the <a class="link" href="MixAudio-MixAudioConfigParams.html#MixDecodeMode" title="enum MixDecodeMode"><span class="type">MixDecodeMode</span></a>.</p> 440 <div class="variablelist"><table border="0"> 441 <col align="left" valign="top"> 442 <tbody> 443 <tr> 444 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 445 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> 446 </td> 447 </tr> 448 <tr> 449 <td><p><span class="term"><em class="parameter"><code>mode</code></em>:</span></p></td> 450 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixDecodeMode" title="enum MixDecodeMode"><span class="type">MixDecodeMode</span></a> to set 451 </td> 452 </tr> 453 <tr> 454 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 455 <td> <span class="type">MIX_RESULT</span> 456 </td> 457 </tr> 458 </tbody> 459 </table></div> 460 </div> 461 <hr> 462 <div class="refsect2" lang="en"> 463 <a name="mix-acp-get-streamname"></a><h3>mix_acp_get_streamname ()</h3> 464 <pre class="programlisting">gchar * mix_acp_get_streamname (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj);</pre> 465 <p> 466 Return copy of streamname. caller must free with <code class="function">g_free()</code></p> 467 <div class="variablelist"><table border="0"> 468 <col align="left" valign="top"> 469 <tbody> 470 <tr> 471 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 472 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> 473 </td> 474 </tr> 475 <tr> 476 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 477 <td> pointer to a copy of the stream name. NULL if name is not available. 478 </td> 479 </tr> 480 </tbody> 481 </table></div> 482 </div> 483 <hr> 484 <div class="refsect2" lang="en"> 485 <a name="mix-acp-set-streamname"></a><h3>mix_acp_set_streamname ()</h3> 486 <pre class="programlisting">MIX_RESULT mix_acp_set_streamname (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj, 487 const gchar *streamname);</pre> 488 <p> 489 Set the stream name. The object will make a copy of the input stream name string.</p> 490 <div class="variablelist"><table border="0"> 491 <col align="left" valign="top"> 492 <tbody> 493 <tr> 494 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 495 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> 496 </td> 497 </tr> 498 <tr> 499 <td><p><span class="term"><em class="parameter"><code>streamname</code></em>:</span></p></td> 500 <td> Stream name to set 501 </td> 502 </tr> 503 <tr> 504 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 505 <td> <span class="type">MIX_RESULT</span> 506 </td> 507 </tr> 508 </tbody> 509 </table></div> 510 </div> 511 <hr> 512 <div class="refsect2" lang="en"> 513 <a name="mix-acp-set-audio-manager"></a><h3>mix_acp_set_audio_manager ()</h3> 514 <pre class="programlisting">MIX_RESULT mix_acp_set_audio_manager (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj, 515 <a class="link" href="MixAudio-mixaudiotypes.html#MixAudioManager" title="enum MixAudioManager">MixAudioManager</a> am);</pre> 516 <p> 517 Set the Audio Manager to one of the <a class="link" href="MixAudio-mixaudiotypes.html#MixAudioManager" title="enum MixAudioManager"><span class="type">MixAudioManager</span></a>.</p> 518 <div class="variablelist"><table border="0"> 519 <col align="left" valign="top"> 520 <tbody> 521 <tr> 522 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 523 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> 524 </td> 525 </tr> 526 <tr> 527 <td><p><span class="term"><em class="parameter"><code>am</code></em>:</span></p></td> 528 <td> <a class="link" href="MixAudio-mixaudiotypes.html#MixAudioManager" title="enum MixAudioManager"><span class="type">MixAudioManager</span></a> 529 </td> 530 </tr> 531 <tr> 532 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 533 <td> <span class="type">MIX_RESULT</span> 534 </td> 535 </tr> 536 </tbody> 537 </table></div> 538 </div> 539 <hr> 540 <div class="refsect2" lang="en"> 541 <a name="mix-acp-get-audio-manager"></a><h3>mix_acp_get_audio_manager ()</h3> 542 <pre class="programlisting"><a class="link" href="MixAudio-mixaudiotypes.html#MixAudioManager" title="enum MixAudioManager">MixAudioManager</a> mix_acp_get_audio_manager (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj);</pre> 543 <p> 544 Retrieve name of currently configured audio manager.</p> 545 <div class="variablelist"><table border="0"> 546 <col align="left" valign="top"> 547 <tbody> 548 <tr> 549 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 550 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> 551 </td> 552 </tr> 553 <tr> 554 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 555 <td> <a class="link" href="MixAudio-mixaudiotypes.html#MixAudioManager" title="enum MixAudioManager"><span class="type">MixAudioManager</span></a> 556 </td> 557 </tr> 558 </tbody> 559 </table></div> 560 </div> 561 <hr> 562 <div class="refsect2" lang="en"> 563 <a name="mix-acp-is-streamname-valid"></a><h3>mix_acp_is_streamname_valid ()</h3> 564 <pre class="programlisting">gboolean mix_acp_is_streamname_valid (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj);</pre> 565 <p> 566 Check if stream name is valid considering the current Decode Mode.</p> 567 <div class="variablelist"><table border="0"> 568 <col align="left" valign="top"> 569 <tbody> 570 <tr> 571 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 572 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> 573 </td> 574 </tr> 575 <tr> 576 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 577 <td> boolean indicates if stream name is valid. 578 </td> 579 </tr> 580 </tbody> 581 </table></div> 582 </div> 583 <hr> 584 <div class="refsect2" lang="en"> 585 <a name="mix-acp-get-bps"></a><h3>mix_acp_get_bps ()</h3> 586 <pre class="programlisting"><a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPBPSType" title="enum MixACPBPSType">MixACPBPSType</a> mix_acp_get_bps (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj);</pre> 587 <p> 588 Retrive currently configured bit-per-stream value.</p> 589 <div class="variablelist"><table border="0"> 590 <col align="left" valign="top"> 591 <tbody> 592 <tr> 593 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 594 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> 595 </td> 596 </tr> 597 <tr> 598 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 599 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPBPSType" title="enum MixACPBPSType"><span class="type">MixACPBPSType</span></a> 600 </td> 601 </tr> 602 </tbody> 603 </table></div> 604 </div> 605 <hr> 606 <div class="refsect2" lang="en"> 607 <a name="mix-acp-set-bps"></a><h3>mix_acp_set_bps ()</h3> 608 <pre class="programlisting">MIX_RESULT mix_acp_set_bps (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj, 609 <a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPBPSType" title="enum MixACPBPSType">MixACPBPSType</a> type);</pre> 610 <p> 611 Configure bit-per-stream of one of the supported <a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPBPSType" title="enum MixACPBPSType"><span class="type">MixACPBPSType</span></a>.</p> 612 <div class="variablelist"><table border="0"> 613 <col align="left" valign="top"> 614 <tbody> 615 <tr> 616 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 617 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> 618 </td> 619 </tr> 620 <tr> 621 <td><p><span class="term"><em class="parameter"><code>mode</code></em>:</span></p></td> 622 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPBPSType" title="enum MixACPBPSType"><span class="type">MixACPBPSType</span></a> to set 623 </td> 624 </tr> 625 <tr> 626 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 627 <td> <span class="type">MIX_RESULT</span> 628 </td> 629 </tr> 630 </tbody> 631 </table></div> 632 </div> 633 <hr> 634 <div class="refsect2" lang="en"> 635 <a name="mix-acp-get-op-align"></a><h3>mix_acp_get_op_align ()</h3> 636 <pre class="programlisting"><a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPOpAlign" title="enum MixACPOpAlign">MixACPOpAlign</a> mix_acp_get_op_align (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj);</pre> 637 <p> 638 Get Output Alignment.</p> 639 <div class="variablelist"><table border="0"> 640 <col align="left" valign="top"> 641 <tbody> 642 <tr> 643 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 644 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> object 645 </td> 646 </tr> 647 <tr> 648 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 649 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPOpAlign" title="enum MixACPOpAlign"><span class="type">MixACPOpAlign</span></a> 650 </td> 651 </tr> 652 </tbody> 653 </table></div> 654 </div> 655 <hr> 656 <div class="refsect2" lang="en"> 657 <a name="mix-acp-set-op-align"></a><h3>mix_acp_set_op_align ()</h3> 658 <pre class="programlisting">MIX_RESULT mix_acp_set_op_align (<a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams">MixAudioConfigParams</a> *obj, 659 <a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPOpAlign" title="enum MixACPOpAlign">MixACPOpAlign</a> op_align);</pre> 660 <p> 661 Set Output Alignment to one of the <a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPOpAlign" title="enum MixACPOpAlign"><span class="type">MixACPOpAlign</span></a> value.</p> 662 <div class="variablelist"><table border="0"> 663 <col align="left" valign="top"> 664 <tbody> 665 <tr> 666 <td><p><span class="term"><em class="parameter"><code>obj</code></em>:</span></p></td> 667 <td> <a class="link" href="MixAudio-MixAudioConfigParams.html#MixAudioConfigParams" title="MixAudioConfigParams"><span class="type">MixAudioConfigParams</span></a> object 668 </td> 669 </tr> 670 <tr> 671 <td><p><span class="term"><em class="parameter"><code>op_align</code></em>:</span></p></td> 672 <td> One of the supported <a class="link" href="MixAudio-MixAudioConfigParams.html#MixACPOpAlign" title="enum MixACPOpAlign"><span class="type">MixACPOpAlign</span></a> 673 </td> 674 </tr> 675 <tr> 676 <td><p><span class="term"><em class="parameter"><code>returns</code></em>:</span></p></td> 677 <td> MIX_RESULT 678 </td> 679 </tr> 680 </tbody> 681 </table></div> 682 </div> 683 </div> 684 </div> 685 <div class="footer"> 686 <hr> 687 Generated by GTK-Doc V1.11</div> 688 </body> 689 </html> 690
