PageRenderTime 275ms CodeModel.GetById 111ms app.highlight 6ms RepoModel.GetById 105ms app.codeStats 0ms

/Dlls/Delta.Multimedia.OpenTK.xml

#
XML | 348 lines | 348 code | 0 blank | 0 comment | 0 complexity | c47bfdaf65a37afa4d8fd888373a0163 MD5 | raw file
  1<?xml version="1.0"?>
  2<doc>
  3    <assembly>
  4        <name>Delta.Multimedia.OpenTK</name>
  5    </assembly>
  6    <members>
  7        <member name="T:Delta.Multimedia.OpenTK.OpenTKChannel">
  8            <summary>
  9            OpenTK sound class overriding BaseOpenALChannel because of the
 10            loading the sound modules via the namespace e.g.
 11            <AudioModule>OpenTK</AudioModule>, so it won't find the
 12            BaseOpenALSound. :/
 13            </summary>
 14        </member>
 15        <member name="M:Delta.Multimedia.OpenTK.OpenTKChannel.#ctor(Delta.Multimedia.NativeSound)">
 16            <summary>
 17            Create a new OpenTK sound channel instance.
 18            </summary>
 19            <param name="parentSound">Parent sound instance.</param>
 20        </member>
 21        <member name="T:Delta.Multimedia.OpenTK.OpenTKSound">
 22            <summary>
 23            OpenTK sound class overriding BaseOpenALSound because of the
 24            loading the sound modules via the namespace e.g.
 25            <AudioModule>OpenTK</AudioModule>, so it won't find the
 26            BaseOpenALSound. :/
 27            </summary>
 28        </member>
 29        <member name="M:Delta.Multimedia.OpenTK.OpenTKSound.#ctor(Delta.Multimedia.Sound)">
 30            <summary>
 31            Create a new OpenTK sound instance.
 32            </summary>
 33            <param name="parentSound">Parent sound instance.</param>
 34        </member>
 35        <member name="T:Delta.Multimedia.OpenTK.OpenTKMusic">
 36            <summary>
 37            OpenTK music
 38            Sample code for implementing
 39            -> http://www.opentk.com/node/1705
 40            </summary>
 41        </member>
 42        <member name="F:Delta.Multimedia.OpenTK.OpenTKMusic.nativeMusicData">
 43            <summary>
 44            Music handle
 45            </summary>
 46        </member>
 47        <member name="M:Delta.Multimedia.OpenTK.OpenTKMusic.#ctor(Delta.Multimedia.Music)">
 48            <summary>
 49            Create OpenTK music
 50            </summary>
 51            <param name="parentMusic">Parent music instance.</param>
 52        </member>
 53        <member name="M:Delta.Multimedia.OpenTK.OpenTKMusic.LoadNativeData(System.String)">
 54            <summary>
 55            Load content data
 56            </summary>
 57            <param name="filename">Filename</param>
 58            <returns>True if loading succeeded, otherwise False.</returns>
 59        </member>
 60        <member name="M:Delta.Multimedia.OpenTK.OpenTKMusic.Dispose">
 61            <summary>
 62            Dispose data
 63            </summary>
 64        </member>
 65        <member name="M:Delta.Multimedia.OpenTK.OpenTKMusic.SetVolume(System.Single)">
 66            <summary>
 67            Set the volume of the native OpenTK music.
 68            </summary>
 69            <param name="setVolume">Volume to set.</param>
 70        </member>
 71        <member name="M:Delta.Multimedia.OpenTK.OpenTKMusic.PlayNative">
 72            <summary>
 73            Play native
 74            </summary>
 75        </member>
 76        <member name="M:Delta.Multimedia.OpenTK.OpenTKMusic.UpdateNative">
 77            <summary>
 78            Updates the Music
 79            </summary>
 80        </member>
 81        <member name="M:Delta.Multimedia.OpenTK.OpenTKMusic.StopNative">
 82            <summary>
 83            Stop native
 84            </summary>
 85        </member>
 86        <member name="T:Delta.Multimedia.OpenTK.OggInputStream">
 87            <summary>
 88            Ogg input stream
 89            </summary>
 90        </member>
 91        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.convbuffer">
 92            <summary>
 93            Conversion buffer
 94            </summary>
 95        </member>
 96        <member name="F:Delta.Multimedia.OpenTK.OggInputStream._pcm">
 97            <summary>
 98            temp vars
 99            </summary>
100        </member>
101        <member name="F:Delta.Multimedia.OpenTK.OggInputStream._index">
102            <summary>
103            _index
104            </summary>
105        </member>
106        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.eos">
107            <summary>
108            end of stream
109            </summary>
110        </member>
111        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.syncState">
112            <summary>
113            sync and verify incoming physical bitstream
114            </summary>
115        </member>
116        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.streamState">
117            <summary>
118            take physical pages, weld into a logical stream of packets
119            </summary>
120        </member>
121        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.page">
122            <summary>
123            one Ogg bitstream page.  Vorbis packets are inside
124            </summary>
125        </member>
126        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.packet">
127            <summary>
128            one raw packet of data for decode
129            </summary>
130        </member>
131        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.info">
132            <summary>
133            struct that stores all the static vorbis bitstream settings
134            </summary>
135        </member>
136        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.comment">
137            <summary>
138            struct that stores all the bitstream user comments
139            </summary>
140        </member>
141        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.dspState">
142            <summary>
143            central working state for the packet->PCM decoder
144            </summary>
145        </member>
146        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.block">
147            <summary>
148            local working space for packet->PCM decode
149            </summary>
150        </member>
151        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.convsize">
152            Conversion buffer size
153        </member>
154        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.convbufferOff">
155            <summary>
156            where we are in the convbuffer
157            </summary>
158        </member>
159        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.convbufferSize">
160            <summary>
161            bytes ready in convbuffer.
162            </summary>
163        </member>
164        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.readDummy">
165            <summary>
166            a dummy used by read() to read 1 byte.
167            </summary>
168        </member>
169        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.input">
170            <summary>
171            Input
172            </summary>
173        </member>
174        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.#ctor(System.IO.Stream)">
175            <summary>
176            Creates an OggInputStream that decompressed the specified ogg file.
177            </summary>
178            <param name="input">Input file stream.</param>
179        </member>
180        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.Read">
181            <summary>
182            Reads the next byte of data from this input stream. The value byte is
183            returned as an int in the range 0 to 255. If no byte is available
184            because the end of the stream has been reached, the value -1 is
185            returned. This method blocks until input data is available, the end
186            of the stream is detected, or an exception is thrown.
187            </summary>
188            <returns>the next byte of data, or -1 if the end of the stream is
189            reached.</returns>
190        </member>
191        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.Read(System.Byte[],System.Int32,System.Int32)">
192            <summary>
193            Reads up to len bytes of data from the input stream into an
194            array of bytes.
195            </summary>
196            <param name="b">the buffer into which the data is read.</param>
197            <param name="off">the start offset of the data.</param>
198            <param name="len">the maximum number of bytes read.</param>
199            <returns>the total number of bytes read into the buffer, or -1 if
200            there is no more data because the end of the stream has been reached.
201            </returns>
202        </member>
203        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.Read(System.IO.MemoryStream,System.Int32,System.Int32)">
204            <summary>
205            Reads up to len bytes of data from the input stream into a ByteBuffer.
206            </summary>
207            <param name="stream"></param>
208            <param name="off">the start offset of the data.</param>
209            <param name="len">the maximum number of bytes read.</param>
210            <returns>the total number of bytes read into the buffer, or -1 if
211            there is no more data because the end of the stream has been reached.
212            </returns>
213        </member>
214        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.Skip(System.Int64)">
215            <summary>
216            Skips over and discards n bytes of data from the input stream.
217            The skip method may, for a variety of reasons, end up skipping over
218            some smaller number of bytes, possibly 0. The actual number of bytes
219            skipped is returned. 
220            </summary>
221            <param name="n">the number of bytes to be skipped.</param>
222            <returns>the actual number of bytes skipped.</returns>
223        </member>
224        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.ToString">
225            <summary>
226            Gets information on the ogg.
227            </summary>
228            <returns>Returns a string representing this ogg input stream.</returns>
229        </member>
230        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.FillConvbuffer">
231            <summary>
232            Helper function. Decodes a packet to the convbuffer if it is empty.
233            Updates convbufferSize, convbufferOff, and eos.
234            </summary>
235        </member>
236        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.InitVorbis">
237            <summary>
238            Initalizes the vorbis stream. Reads the stream until info
239            and comment are read.
240            </summary>
241        </member>
242        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.DecodePacket(csogg.Packet)">
243            <summary>
244            Decodes a packet.
245            TODO: Ugly code, refactor plz!
246            </summary>
247            <param name="packet">Packet to decode.</param>
248            <returns>Unknown</returns>
249        </member>
250        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.LazyDecodePacket">
251            <summary>
252            Decodes the next packet.
253            </summary>
254            <returns>bytes read into convbuffer of -1 if end of file</returns>
255        </member>
256        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.GetNextPacket(csogg.Packet)">
257            <summary>
258            Get the next packet in the music file.
259            </summary>
260            <param name="packet">Packet instance where to fill the data.</param>
261            <returns>Returns -1 if getting the next packet failed, otherwise 0.
262            </returns>
263        </member>
264        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.FetchData">
265            <summary>
266            Copies data from input stream to syncState.
267            </summary>
268        </member>
269        <member name="P:Delta.Multimedia.OpenTK.OggInputStream.Format">
270            <summary>
271            Gets the format of the ogg file. Is either MONO16 or STEREO16.
272            </summary>
273        </member>
274        <member name="T:Delta.Multimedia.OpenTK.OggMusicData">
275            <summary>
276            OGG music data
277            </summary>
278        </member>
279        <member name="F:Delta.Multimedia.OpenTK.OggMusicData.BufferSize">
280            <summary>
281            Size of a stream buffer in bytes.
282            </summary>
283        </member>
284        <member name="F:Delta.Multimedia.OpenTK.OggMusicData.oggFileStream">
285            <summary>
286            The direct stream to the OGG file that we store for later disposing.
287            </summary>
288        </member>
289        <member name="F:Delta.Multimedia.OpenTK.OggMusicData.oggStream">
290            <summary>
291            Decoding OGG input stream for loading the music data.
292            </summary>
293        </member>
294        <member name="F:Delta.Multimedia.OpenTK.OggMusicData.contentPath">
295            <summary>
296            The path to the music content file.
297            </summary>
298        </member>
299        <member name="M:Delta.Multimedia.OpenTK.OggMusicData.#ctor(System.String)">
300            <summary>
301            Create OGG music data
302            </summary>
303            <param name="relativeFilePath">
304            The path to the music content file.
305            </param>
306        </member>
307        <member name="M:Delta.Multimedia.OpenTK.OggMusicData.Rewind">
308            <summary>
309            Rewind the music stream to the start position, used for looping and
310            called when the music finished playing.
311            </summary>
312        </member>
313        <member name="M:Delta.Multimedia.OpenTK.OggMusicData.Stream(System.Int32)">
314            <summary>
315            Stream
316            </summary>
317            <param name="bufferHandle">The buffer handle.</param>
318            <returns>
319            amount of buffered bytes
320            </returns>
321        </member>
322        <member name="M:Delta.Multimedia.OpenTK.OggMusicData.Dispose">
323            <summary>
324            Dispose the source and all buffers of the ogg music.
325            </summary>
326        </member>
327        <member name="P:Delta.Multimedia.OpenTK.OggMusicData.Format">
328            <summary>
329            Format
330            </summary>
331        </member>
332        <member name="P:Delta.Multimedia.OpenTK.OggMusicData.SampleRate">
333            <summary>
334            Sample rate
335            </summary>
336        </member>
337        <member name="P:Delta.Multimedia.OpenTK.OggMusicData.BufferHandles">
338            <summary>
339            OpenAL buffers for music streaming.
340            </summary>
341        </member>
342        <member name="P:Delta.Multimedia.OpenTK.OggMusicData.Handle">
343            <summary>
344            OpenAL source handle.
345            </summary>
346        </member>
347    </members>
348</doc>