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 <title>Stop</title> 8 </head> 9 <body> 10 <h1>nw::snd::SequenceSoundHandle::Stop Member Function</h1> 11 <h2>Syntax</h2> 12 <div class="section"> 13 <pre class="definition">#include <nw/snd/snd_SequenceSoundHandle.h> 14 15void Stop( 16 int fadeFrames 17); 18</pre> 19 </div> 20 <h2>Arguments</h2> 21 <div class="section"> 22 <table class="arguments"> 23 <thead> 24 <tr> 25 <td width="15" /> 26 <th>Name</th> 27 <td>Description</td> 28 </tr> 29 </thead> 30 <tr> 31 <td>in</td> 32 <th>fadeFrames</th> 33 <td>Number of elapsed frames during a fade-out.</td> 34 </tr> </table> 35 </div> 36 <h2>Return Values</h2> 37 <div class="section"> 38 None. 39 </div> 40 <h2>Description</h2> 41 <div class="section"> 42 <p>Stops the sound.</p><p>Stops the sound associated with the handle. If the handle is invalid, the function does nothing.</p><p>You can fade out over the number of frames specified by <span>fadeFrames</span>. If 0 has been specified, fade-out is not performed and sound stops after the sound for the release of the envelope is generated and all attenuation has been completed.</p><p>The volume control for fade-out is also used for fade-in. The number of fade-out frames correlates to the speed of change from maximum volume to silence. If a fade-out is specified during a fade-in, or in other similar situations, it may complete sooner than the specified frame count.</p></div> 43 <h2>Revision History</h2> 44 <div class="section"> 45 <dl class="history"> 46 <dt>2010/01/22</dt> 47 <dd>Initial version.<br /> 48 </dd> 49 </dl> 50 </div> 51 <hr><p>CONFIDENTIAL</p></body> 52</html>