diff options
Diffstat (limited to 'doc/html/SoundStream_8hpp-source.htm')
| -rwxr-xr-x | doc/html/SoundStream_8hpp-source.htm | 114 |
1 files changed, 59 insertions, 55 deletions
diff --git a/doc/html/SoundStream_8hpp-source.htm b/doc/html/SoundStream_8hpp-source.htm index 6279c18..389dee2 100755 --- a/doc/html/SoundStream_8hpp-source.htm +++ b/doc/html/SoundStream_8hpp-source.htm @@ -22,7 +22,7 @@ <h1>SoundStream.hpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <a name="l00002"></a>00002 <span class="comment">//</span> <a name="l00003"></a>00003 <span class="comment">// SFML - Simple and Fast Multimedia Library</span> -<a name="l00004"></a>00004 <span class="comment">// Copyright (C) 2007 Laurent Gomila (laurent.gom@gmail.com)</span> +<a name="l00004"></a>00004 <span class="comment">// Copyright (C) 2007-2008 Laurent Gomila (laurent.gom@gmail.com)</span> <a name="l00005"></a>00005 <span class="comment">//</span> <a name="l00006"></a>00006 <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span> <a name="l00007"></a>00007 <span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span> @@ -64,62 +64,66 @@ <a name="l00052"></a>00052 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#6a712910ac1340f32e3ec3a04295ebd3" title="Pause the sound.">Sound::Pause</a>; <a name="l00053"></a>00053 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#f93301feb88770789ba7cd993c9dd3a0" title="Set the sound pitch.">Sound::SetPitch</a>; <a name="l00054"></a>00054 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#1536095045923a2332dd9eed6bf8e96a" title="Set the sound volume.">Sound::SetVolume</a>; -<a name="l00055"></a>00055 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#b445e8738218525d8dd067628bc70c78" title="Set the sound position.">Sound::SetPosition</a>; -<a name="l00056"></a>00056 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#b591af704d910f620343685ce3916c80" title="Get the pitch.">Sound::GetPitch</a>; -<a name="l00057"></a>00057 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#6990c8406bdb13d82d13d662a1b7423e" title="Get the volume.">Sound::GetVolume</a>; -<a name="l00058"></a>00058 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#82a9a8a5c4fbd9aac1fb42f7910f7f6a" title="Get the sound position.">Sound::GetPosition</a>; -<a name="l00059"></a>00059 -<a name="l00063"></a><a class="code" href="structsf_1_1SoundStream_1_1Chunk.htm">00063</a> <span class="keyword">struct </span><a class="code" href="structsf_1_1SoundStream_1_1Chunk.htm" title="Structure defining a chunk of audio data to stream.">Chunk</a> -<a name="l00064"></a>00064 { -<a name="l00065"></a><a class="code" href="structsf_1_1SoundStream_1_1Chunk.htm#c7a44423bcd7cf2c451f3bd1e00b6a9f">00065</a> <span class="keyword">const</span> Int16* Samples; -<a name="l00066"></a><a class="code" href="structsf_1_1SoundStream_1_1Chunk.htm#a5eb3db49e38752d27f7d7246907c5af">00066</a> std::size_t NbSamples; -<a name="l00067"></a>00067 }; -<a name="l00068"></a>00068 -<a name="l00073"></a>00073 <span class="keyword">virtual</span> ~SoundStream(); -<a name="l00074"></a>00074 -<a name="l00079"></a>00079 <span class="keywordtype">void</span> Play(); -<a name="l00080"></a>00080 -<a name="l00085"></a>00085 <span class="keywordtype">void</span> Stop(); -<a name="l00086"></a>00086 -<a name="l00093"></a>00093 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetChannelsCount() <span class="keyword">const</span>; -<a name="l00094"></a>00094 -<a name="l00101"></a>00101 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetSampleRate() <span class="keyword">const</span>; -<a name="l00102"></a>00102 -<a name="l00109"></a>00109 <a class="code" href="classsf_1_1Sound.htm#28ad2186cde78fed2c79c867b9622195" title="Enumeration of the sound states.">Status</a> GetStatus() <span class="keyword">const</span>; -<a name="l00110"></a>00110 -<a name="l00111"></a>00111 <span class="keyword">protected</span> : -<a name="l00112"></a>00112 -<a name="l00117"></a>00117 SoundStream(); -<a name="l00118"></a>00118 -<a name="l00126"></a>00126 <span class="keywordtype">void</span> Initialize(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ChannelsCount, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> SampleRate); -<a name="l00127"></a>00127 -<a name="l00128"></a>00128 <span class="keyword">private</span> : -<a name="l00129"></a>00129 -<a name="l00134"></a>00134 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Run(); -<a name="l00135"></a>00135 -<a name="l00142"></a>00142 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> OnStart(); -<a name="l00143"></a>00143 -<a name="l00152"></a>00152 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> OnGetData(<a class="code" href="structsf_1_1SoundStream_1_1Chunk.htm" title="Structure defining a chunk of audio data to stream.">Chunk</a>& Data) = 0; -<a name="l00153"></a>00153 -<a name="l00158"></a>00158 <span class="keywordtype">void</span> CleanUp(); -<a name="l00159"></a>00159 -<a name="l00160"></a>00160 <span class="keyword">enum</span> {BuffersCount = 2}; -<a name="l00161"></a>00161 -<a name="l00163"></a>00163 <span class="comment">// Member data</span> -<a name="l00165"></a>00165 <span class="comment"></span> <span class="keywordtype">bool</span> myIsStreaming; -<a name="l00166"></a>00166 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> myBuffers[BuffersCount]; -<a name="l00167"></a>00167 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> myChannelsCount; -<a name="l00168"></a>00168 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> mySampleRate; -<a name="l00169"></a>00169 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> myFormat; -<a name="l00170"></a>00170 }; -<a name="l00171"></a>00171 -<a name="l00172"></a>00172 } <span class="comment">// namespace sf</span> -<a name="l00173"></a>00173 -<a name="l00174"></a>00174 -<a name="l00175"></a>00175 <span class="preprocessor">#endif // SFML_SOUNDSTREAM_HPP</span> +<a name="l00055"></a>00055 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#b445e8738218525d8dd067628bc70c78" title="Set the sound position (take 3 values).">Sound::SetPosition</a>; +<a name="l00056"></a>00056 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#0a545d8dca68d85a03390f6da7c446a9" title="Set the minimum distance - closer than this distance, the listener will hear the...">Sound::SetMinDistance</a>; +<a name="l00057"></a>00057 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#c3743f1fb53bf9818fbab6e9220bd7b9" title="Set the attenuation factor - the higher the attenuation, the more the sound will...">Sound::SetAttenuation</a>; +<a name="l00058"></a>00058 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#b591af704d910f620343685ce3916c80" title="Get the pitch.">Sound::GetPitch</a>; +<a name="l00059"></a>00059 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#6990c8406bdb13d82d13d662a1b7423e" title="Get the volume.">Sound::GetVolume</a>; +<a name="l00060"></a>00060 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#9462818ee2ff3318648c416dd6430823" title="Get the sound position.">Sound::GetPosition</a>; +<a name="l00061"></a>00061 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#e4c1cc0b8ff482bf1b834ac4b7b1afd7" title="Get the minimum distance.">Sound::GetMinDistance</a>; +<a name="l00062"></a>00062 <span class="keyword">using</span> <a class="code" href="classsf_1_1Sound.htm#7162ae32e4d530a4c5f93a1297c91440" title="Get the attenuation factor.">Sound::GetAttenuation</a>; +<a name="l00063"></a>00063 +<a name="l00067"></a><a class="code" href="structsf_1_1SoundStream_1_1Chunk.htm">00067</a> <span class="keyword">struct </span><a class="code" href="structsf_1_1SoundStream_1_1Chunk.htm" title="Structure defining a chunk of audio data to stream.">Chunk</a> +<a name="l00068"></a>00068 { +<a name="l00069"></a><a class="code" href="structsf_1_1SoundStream_1_1Chunk.htm#c7a44423bcd7cf2c451f3bd1e00b6a9f">00069</a> <span class="keyword">const</span> Int16* Samples; +<a name="l00070"></a><a class="code" href="structsf_1_1SoundStream_1_1Chunk.htm#a5eb3db49e38752d27f7d7246907c5af">00070</a> std::size_t NbSamples; +<a name="l00071"></a>00071 }; +<a name="l00072"></a>00072 +<a name="l00077"></a>00077 <span class="keyword">virtual</span> ~SoundStream(); +<a name="l00078"></a>00078 +<a name="l00083"></a>00083 <span class="keywordtype">void</span> Play(); +<a name="l00084"></a>00084 +<a name="l00089"></a>00089 <span class="keywordtype">void</span> Stop(); +<a name="l00090"></a>00090 +<a name="l00097"></a>00097 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetChannelsCount() <span class="keyword">const</span>; +<a name="l00098"></a>00098 +<a name="l00105"></a>00105 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetSampleRate() <span class="keyword">const</span>; +<a name="l00106"></a>00106 +<a name="l00113"></a>00113 <a class="code" href="classsf_1_1Sound.htm#28ad2186cde78fed2c79c867b9622195" title="Enumeration of the sound states.">Status</a> GetStatus() <span class="keyword">const</span>; +<a name="l00114"></a>00114 +<a name="l00115"></a>00115 <span class="keyword">protected</span> : +<a name="l00116"></a>00116 +<a name="l00121"></a>00121 SoundStream(); +<a name="l00122"></a>00122 +<a name="l00130"></a>00130 <span class="keywordtype">void</span> Initialize(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ChannelsCount, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> SampleRate); +<a name="l00131"></a>00131 +<a name="l00132"></a>00132 <span class="keyword">private</span> : +<a name="l00133"></a>00133 +<a name="l00138"></a>00138 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Run(); +<a name="l00139"></a>00139 +<a name="l00146"></a>00146 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> OnStart(); +<a name="l00147"></a>00147 +<a name="l00156"></a>00156 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> OnGetData(<a class="code" href="structsf_1_1SoundStream_1_1Chunk.htm" title="Structure defining a chunk of audio data to stream.">Chunk</a>& Data) = 0; +<a name="l00157"></a>00157 +<a name="l00162"></a>00162 <span class="keywordtype">void</span> CleanUp(); +<a name="l00163"></a>00163 +<a name="l00164"></a>00164 <span class="keyword">enum</span> {BuffersCount = 3}; +<a name="l00165"></a>00165 +<a name="l00167"></a>00167 <span class="comment">// Member data</span> +<a name="l00169"></a>00169 <span class="comment"></span> <span class="keywordtype">bool</span> myIsStreaming; +<a name="l00170"></a>00170 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> myBuffers[BuffersCount]; +<a name="l00171"></a>00171 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> myChannelsCount; +<a name="l00172"></a>00172 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> mySampleRate; +<a name="l00173"></a>00173 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> myFormat; +<a name="l00174"></a>00174 }; +<a name="l00175"></a>00175 +<a name="l00176"></a>00176 } <span class="comment">// namespace sf</span> +<a name="l00177"></a>00177 +<a name="l00178"></a>00178 +<a name="l00179"></a>00179 <span class="preprocessor">#endif // SFML_SOUNDSTREAM_HPP</span> </pre></div> <p id="footer"> - :: Copyright © 2007 Laurent Gomila, all rights reserved :: + :: Copyright © 2007-2008 Laurent Gomila, all rights reserved :: Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> :: </p> |