1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50 <title>nn::snd::CTR::Voice</title> 51 </head> 52 <body> 53 <h1><CODE>nn::snd::CTR::Voice</CODE> Class</h1> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class Voice</pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>A class used to control <a href="../../../../nn/snd/CTR/Voice/Overview.html"><CODE>Voice</CODE></a> objects.</p><p>Use this to control valid voice objects obtained with the <CODE>nn::snd::AllocVoice</CODE> function. Behavior is not guaranteed if you attempt to control any other voice object. 61 </p></div> 62 <a name="enum" id="enum"> 63 <h2>Enumerated Types</h2> 64 <div class="section"> 65 <table class="members"> 66 <tr> 67 <td width="100"> </td> 68 <th> 69 <a href="../../../../nn/snd/CTR/Voice/State.html"><CODE>State</CODE></a> 70 </th> 71 <td>Enumerated type that indicates the voice states.</td> 72 </tr> </table> 73 </div> 74 </a> <a name="function" id="function"> 75 <h2>Member Functions</h2> 76 <div class="section"> 77 <table class="members"> 78 <tr> 79 <td width="100"> </td> 80 <th> 81 <a href="../../../../nn/snd/CTR/Voice/Voice.html"><CODE>Voice</CODE></a> 82 </th> 83 <td>Constructor.</td> 84 </tr> 85 <tr> 86 <td width="100"> </td> 87 <th> 88 <a href="../../../../nn/snd/CTR/Voice/~Voice.html"><CODE>~Voice</CODE></a> 89 </th> 90 <td>Destructor.</td> 91 </tr> 92 <tr> 93 <td width="100"> </td> 94 <th> 95 <a href="../../../../nn/snd/CTR/Voice/SetChannelCount.html"><CODE>SetChannelCount</CODE></a> 96 </th> 97 <td>Sets the number of voice channels.</td> 98 </tr> 99 <tr> 100 <td width="100"> </td> 101 <th> 102 <a href="../../../../nn/snd/CTR/Voice/SetSampleFormat.html"><CODE>SetSampleFormat</CODE></a> 103 </th> 104 <td>Sets the format of the samples to link to a voice.</td> 105 </tr> 106 <tr> 107 <td width="100"> </td> 108 <th> 109 <a href="../../../../nn/snd/CTR/Voice/SetFrontBypassFlag.html"><CODE>SetFrontBypassFlag</CODE></a> 110 </th> 111 <td>Sets whether to bypass the front channels when 3D surround sound is enabled.</td> 112 </tr> 113 <tr> 114 <td width="100"> </td> 115 <th> 116 <a href="../../../../nn/snd/CTR/Voice/SetStartFrameFadeInFlag.html"><CODE>SetStartFrameFadeInFlag</CODE></a> 117 </th> 118 <td>Specifies whether to use a short fade-in starting at volume 0 when playback starts.</td> 119 </tr> 120 <tr> 121 <td width="100"> </td> 122 <th> 123 <a href="../../../../nn/snd/CTR/Voice/SetSampleRate.html"><CODE>SetSampleRate</CODE></a> 124 </th> 125 <td>Sets the sampling rate of a voice.</td> 126 </tr> 127 <tr> 128 <td width="100"> </td> 129 <th> 130 <a href="../../../../nn/snd/CTR/Voice/SetPitch.html"><CODE>SetPitch</CODE></a> 131 </th> 132 <td>Sets the pitch of a voice.</td> 133 </tr> 134 <tr> 135 <td width="100"> </td> 136 <th> 137 <a href="../../../../nn/snd/CTR/Voice/GetPitch.html"><CODE>GetPitch</CODE></a> 138 </th> 139 <td>Gets the pitch of a voice.</td> 140 </tr> 141 <tr> 142 <td width="100"> </td> 143 <th> 144 <a href="../../../../nn/snd/CTR/Voice/SetAdpcmParam.html"><CODE>SetAdpcmParam</CODE></a> 145 </th> 146 <td>Sets ADPCM coefficients.</td> 147 </tr> 148 <tr> 149 <td width="100"> </td> 150 <th> 151 <a href="../../../../nn/snd/CTR/Voice/SetPriority.html"><CODE>SetPriority</CODE></a> 152 </th> 153 <td>Sets the priority of a voice.</td> 154 </tr> 155 <tr> 156 <td width="100"> </td> 157 <th> 158 <a href="../../../../nn/snd/CTR/Voice/GetPriority.html"><CODE>GetPriority</CODE></a> 159 </th> 160 <td>Gets the priority of a voice.</td> 161 </tr> 162 <tr> 163 <td width="100"> </td> 164 <th> 165 <a href="../../../../nn/snd/CTR/Voice/AppendWaveBuffer.html"><CODE>AppendWaveBuffer</CODE></a> 166 </th> 167 <td>Appends sample data information corresponding to a voice.</td> 168 </tr> 169 <tr> 170 <td width="100"> </td> 171 <th> 172 <a href="../../../../nn/snd/CTR/Voice/SetState.html"><CODE>SetState</CODE></a> 173 </th> 174 <td>Sets the current state of a voice.</td> 175 </tr> 176 <tr> 177 <td width="100"> </td> 178 <th> 179 <a href="../../../../nn/snd/CTR/Voice/GetState.html"><CODE>GetState</CODE></a> 180 </th> 181 <td>Gets the state of a voice.</td> 182 </tr> 183 <tr> 184 <td width="100"> </td> 185 <th> 186 <a href="../../../../nn/snd/CTR/Voice/SetMixParam.html"><CODE>SetMixParam</CODE></a> 187 </th> 188 <td>Sets the gain for each voice channel.</td> 189 </tr> 190 <tr> 191 <td width="100"> </td> 192 <th> 193 <a href="../../../../nn/snd/CTR/Voice/GetMixParam.html"><CODE>GetMixParam</CODE></a> 194 </th> 195 <td>Gets the gain for each voice channel.</td> 196 </tr> 197 <tr> 198 <td width="100"> </td> 199 <th> 200 <a href="../../../../nn/snd/CTR/Voice/SetVolume.html"><CODE>SetVolume</CODE></a> 201 </th> 202 <td>Sets the volume of a voice.</td> 203 </tr> 204 <tr> 205 <td width="100"> </td> 206 <th> 207 <a href="../../../../nn/snd/CTR/Voice/GetVolume.html"><CODE>GetVolume</CODE></a> 208 </th> 209 <td>Gets the volume of a voice.</td> 210 </tr> 211 <tr> 212 <td width="100"> </td> 213 <th> 214 <a href="../../../../nn/snd/CTR/Voice/GetPlayPosition.html"><CODE>GetPlayPosition</CODE></a> 215 </th> 216 <td>Gets the playback position within the buffer that is currently in use.</td> 217 </tr> 218 <tr> 219 <td width="100"> </td> 220 <th> 221 <a href="../../../../nn/snd/CTR/Voice/IsPlaying.html"><CODE>IsPlaying</CODE></a> 222 </th> 223 <td>Gets the playback state of a voice.</td> 224 </tr> 225 <tr> 226 <td width="100"> </td> 227 <th> 228 <a href="../../../../nn/snd/CTR/Voice/SetInterpolationType.html"><CODE>SetInterpolationType</CODE></a> 229 </th> 230 <td>Sets the interpolation method of a voice.</td> 231 </tr> 232 <tr> 233 <td width="100"> </td> 234 <th> 235 <a href="../../../../nn/snd/CTR/Voice/GetInterpolationType.html"><CODE>GetInterpolationType</CODE></a> 236 </th> 237 <td>Gets the interpolation method of a voice.</td> 238 </tr> 239 <tr> 240 <td width="100"> </td> 241 <th> 242 <a href="../../../../nn/snd/CTR/Voice/SetFilterType.html"><CODE>SetFilterType</CODE></a> 243 </th> 244 <td>Sets the filter type.</td> 245 </tr> 246 <tr> 247 <td width="100"> </td> 248 <th> 249 <a href="../../../../nn/snd/CTR/Voice/GetFilterType.html"><CODE>GetFilterType</CODE></a> 250 </th> 251 <td>Gets the usage status of a filter.</td> 252 </tr> 253 <tr> 254 <td width="100"> </td> 255 <th> 256 <a href="../../../../nn/snd/CTR/Voice/SetMonoFilterCoefficients.html"><CODE>SetMonoFilterCoefficients</CODE></a> 257 </th> 258 <td>Sets the coefficients for a monopole filter.</td> 259 </tr> 260 <tr> 261 <td width="100"> </td> 262 <th> 263 <a href="../../../../nn/snd/CTR/Voice/GetMonoFilterCoefficients.html"><CODE>GetMonoFilterCoefficients</CODE></a> 264 </th> 265 <td>Gets the coefficients for a monopole filter.</td> 266 </tr> 267 <tr> 268 <td width="100"> </td> 269 <th> 270 <a href="../../../../nn/snd/CTR/Voice/SetBiquadFilterCoefficients.html"><CODE>SetBiquadFilterCoefficients</CODE></a> 271 </th> 272 <td>Sets the coefficients for a biquad filter.</td> 273 </tr> 274 <tr> 275 <td width="100"> </td> 276 <th> 277 <a href="../../../../nn/snd/CTR/Voice/GetBiquadFilterCoefficients.html"><CODE>GetBiquadFilterCoefficients</CODE></a> 278 </th> 279 <td>Gets the coefficients for a biquad filter.</td> 280 </tr> 281 <tr> 282 <td width="100"> </td> 283 <th> 284 <a href="../../../../nn/snd/CTR/Voice/SetupBcwav.html"><CODE>SetupBcwav</CODE></a> 285 </th> 286 <td>Parses a <a href="../../../../nn/snd/CTR/Bcwav/Overview.html">BCWAV</a> file and prepares for playback.</td> 287 </tr> </table> 288 </div> 289 </a> 290 <h2>Revision History</h2> 291 <div class="section"> 292 <dl class="history"> 293 <dt>2010/01/29</dt> 294 <dd>Initial version.<br /> 295 </dd> 296 </dl> 297 </div> 298 <hr><p>CONFIDENTIAL</p></body> 299</html>