PageRenderTime 123ms CodeModel.GetById 80ms app.highlight 4ms RepoModel.GetById 36ms app.codeStats 1ms

/Dlls/Delta.Multimedia.BaseOpenAL.xml

#
XML | 237 lines | 236 code | 1 blank | 0 comment | 0 complexity | 47515253cf795deea9571a9d0d0355ba MD5 | raw file
  1<?xml version="1.0" encoding="utf-8"?>
  2<doc>
  3  <assembly>
  4    <name>Delta.Multimedia.BaseOpenAL</name>
  5  </assembly>
  6  <members>
  7    <member name="T:Delta.Multimedia.BaseOpenAL.OpenALSoundData">
  8      <summary>
  9            SoundData holds all data and information required by OpenAL to handle
 10            playback of sound (wave).
 11            
 12            NOTE: Don't use InvalidDataException because it's not supported in
 13            MonoTouch. So we use NotSupportedException.
 14            </summary>
 15    </member>
 16    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALSoundData.#ctor(Delta.Multimedia.Sound,System.String)">
 17      <summary>
 18            Create sound data
 19            </summary>
 20      <param name="sound">Parent sound.</param>
 21      <param name="relativeFilepath">The relative filepath to the content
 22            sound file.</param>
 23    </member>
 24    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALSoundData.Dispose">
 25      <summary>
 26            Dispose the sound data.
 27            </summary>
 28    </member>
 29    <member name="P:Delta.Multimedia.BaseOpenAL.OpenALSoundData.Channels">
 30      <summary>
 31            The number of sound channels.
 32            </summary>
 33    </member>
 34    <member name="P:Delta.Multimedia.BaseOpenAL.OpenALSoundData.SampleRate">
 35      <summary>
 36            The sample rate of the sound.
 37            </summary>
 38    </member>
 39    <member name="P:Delta.Multimedia.BaseOpenAL.OpenALSoundData.BitsPerSample">
 40      <summary>
 41            The bits per sample of the sound.
 42            </summary>
 43    </member>
 44    <member name="P:Delta.Multimedia.BaseOpenAL.OpenALSoundData.Format">
 45      <summary>
 46            The format of the sound (Mono, Stereo) (8Bit, 16Bit)
 47            </summary>
 48    </member>
 49    <member name="P:Delta.Multimedia.BaseOpenAL.OpenALSoundData.BufferHandle">
 50      <summary>
 51            The pointer to the OpenAL sound buffer.
 52            </summary>
 53    </member>
 54    <member name="T:Delta.Multimedia.BaseOpenAL.WaveFormat">
 55      <summary>
 56            The possible wave file formats. More information can be found at:
 57            http://www.piclist.com/techref/io/serial/midi/wave.html
 58            http://de.wikipedia.org/wiki/RIFF_WAVE
 59            http://msdn.microsoft.com/en-us/library/ms713231
 60            </summary>
 61    </member>
 62    <member name="T:Delta.Multimedia.BaseOpenAL.OpenALBinding">
 63      <summary>
 64            OpenAL Binding class which handles all the native calls.
 65            Because all the calls are the same over all platforms we try now to
 66            use this single class instead of many which duplicated all the code.
 67            The OpenTK reference should be translated by the Build System
 68            automatically!
 69            </summary>
 70    </member>
 71    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.SetVolume(System.Int32,System.Single)">
 72      <summary>
 73            Set the volume of the specified audio source to the volume.
 74            </summary>
 75      <param name="sourceId">The audio source which the volume will be
 76            applied to.</param>
 77      <param name="volume">New Volume value for the audio source.</param>
 78    </member>
 79    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.GenBuffer">
 80      <summary>
 81            Generate a new buffer for audio data.
 82            </summary>
 83      <returns>The unique buffer id stored as an integer.</returns>
 84    </member>
 85    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.GenBuffers(System.Int32)">
 86      <summary>
 87            Generate new buffers for audio data.
 88            </summary>
 89      <param name="bufferCount">The number of buffers to generate.</param>
 90      <returns>The unique buffer ids stored as an integer array.</returns>
 91    </member>
 92    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.GenSource">
 93      <summary>
 94            Generate a new audio source.
 95            </summary>
 96      <returns>
 97            The unique source id stored as an integer.
 98            </returns>
 99    </member>
100    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.BufferData(System.Int32,OpenTK.Audio.OpenAL.ALFormat,System.Byte[],System.Int32)">
101      <summary>
102            Buffer the specified bufferData to the buffer with the bufferId,
103            respecting the format and sampleRate.
104            </summary>
105      <param name="bufferId">The id of the buffer to store the data to.
106            </param>
107      <param name="format">The format of the sound buffer data.</param>
108      <param name="bufferData">The actual buffer data as bytes.</param>
109      <param name="sampleRate">The sample rate of the data.</param>
110    </member>
111    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.SetBuffer(System.Int32,System.Int32)">
112      <summary>
113            Link the buffer to the source, so when playing the source it knows
114            which data to play.
115            </summary>
116      <param name="sourceId">The id of the source to bind the buffer to.
117            </param>
118      <param name="bufferId">The id of the buffer to assign.</param>
119    </member>
120    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.SetPitch(System.Int32,System.Single)">
121      <summary>
122            Set the pitch (speed) of the source to the new value.
123            </summary>
124      <param name="sourceId">Id of the source to apply the new pitch to.</param>
125      <param name="pitch">New pitch value for the source.</param>
126    </member>
127    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.SetPan(System.Int32,System.Single)">
128      <summary>
129            Set the pan of the source to the new value.
130            </summary>
131      <param name="sourceId">Id of the source to apply the new pan to.
132            </param>
133      <param name="pan">Panning, ranging from -1.0f (full left)
134            to 1.0f (full right). 0.0f is centered.</param>
135    </member>
136    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.PlaySource(System.Int32)">
137      <summary>
138            Play the source with the specified id.
139            </summary>
140      <param name="sourceId">Id of the source to play.</param>
141    </member>
142    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.PauseSource(System.Int32)">
143      <summary>
144            Pause the source with the specified id.
145            </summary>
146      <param name="sourceId">Id of the source to pause.</param>
147    </member>
148    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.StopSource(System.Int32)">
149      <summary>
150            Stop playing the source with the specified id.
151            </summary>
152      <param name="sourceId">Id of the source to stop.</param>
153    </member>
154    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.SetLooping(System.Int32,System.Boolean)">
155      <summary>
156            Set the flag if the source should loop or not.
157            </summary>
158      <param name="sourceId">Id of the source.</param>
159      <param name="loop">Flag if source should loop or not.</param>
160    </member>
161    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.GetSourceState(System.Int32)">
162      <summary>
163            Get the current state of the source.
164            </summary>
165      <param name="sourceId">The id of the source.</param>
166      <returns>
167            Returns the state of the source: playing, paused or stopped.
168            </returns>
169    </member>
170    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.GetBuffersQueued(System.Int32)">
171      <summary>
172            Get the number of queued buffers for the source.
173            </summary>
174      <param name="sourceId">Source id.</param>
175      <returns>Number of queued buffers.</returns>
176    </member>
177    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.GetBuffersProcessed(System.Int32)">
178      <summary>
179            Get the number of processed buffers for the source.
180            </summary>
181      <param name="sourceId">Source id.</param>
182      <returns>Number of processed buffers.</returns>
183    </member>
184    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.SourceQueueBuffers(System.Int32,System.Int32[])">
185      <summary>
186            Queue the buffers for the specific source.
187            </summary>
188      <param name="sourceId">Id of the source.</param>
189      <param name="buffers">Buffers to queue.</param>
190    </member>
191    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.SourceUnqueueBuffers(System.Int32,System.Int32)">
192      <summary>
193            Unqueue the buffers of the specific source.
194            </summary>
195      <param name="sourceId">Id of the source.</param>
196      <param name="bufferCount">Number of buffers to unqueue.</param>
197      <returns>Returns the OpenAL pointers to the unqueued buffers.</returns>
198    </member>
199    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.DeleteSource(System.Int32)">
200      <summary>
201            Delete and free the native source data.
202            </summary>
203      <param name="sourceId">The id of the source to free.</param>
204    </member>
205    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.DeleteBuffer(System.Int32)">
206      <summary>
207            Delete and free the native buffer data.
208            </summary>
209      <param name="bufferId">The id of the buffer to free.</param>
210    </member>
211    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.DeleteBuffers(System.Int32[])">
212      <summary>
213            Delete and free the native buffer data.
214            </summary>
215      <param name="buffers">The ids of the buffers to free.</param>
216    </member>
217    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.GetErrorString">
218      <summary>
219            Returns the error message if any occurred, otherwise it returns "".
220            </summary>
221      <returns>
222            Returns the error string if any occurred, otherwise "".
223            </returns>
224    </member>
225    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.CheckError">
226      <summary>
227            Check error.
228            </summary>
229    </member>
230    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.MakeAudioContextCurrent">
231      <summary>
232            Make the current or a new audio context current which also checks
233            if we have proper sound card drivers or a sound card at all.
234            </summary>
235    </member>
236  </members>
237</doc>