/Dlls/Delta.Multimedia.OpenTK.xml

<?xml version="1.0"?>

<doc>

    <assembly>

        <name>Delta.Multimedia.OpenTK</name>

    </assembly>

    <members>

        <member name="T:Delta.Multimedia.OpenTK.OpenTKChannel">

            <summary>

            OpenTK sound class overriding BaseOpenALChannel because of the

            loading the sound modules via the namespace e.g.

            <AudioModule>OpenTK</AudioModule>, so it won't find the

            BaseOpenALSound. :/

            </summary>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OpenTKChannel.#ctor(Delta.Multimedia.NativeSound)">

            <summary>

            Create a new OpenTK sound channel instance.

            </summary>

            <param name="parentSound">Parent sound instance.</param>

        </member>

        <member name="T:Delta.Multimedia.OpenTK.OpenTKSound">

            <summary>

            OpenTK sound class overriding BaseOpenALSound because of the

            loading the sound modules via the namespace e.g.

            <AudioModule>OpenTK</AudioModule>, so it won't find the

            BaseOpenALSound. :/

            </summary>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OpenTKSound.#ctor(Delta.Multimedia.Sound)">

            <summary>

            Create a new OpenTK sound instance.

            </summary>

            <param name="parentSound">Parent sound instance.</param>

        </member>

        <member name="T:Delta.Multimedia.OpenTK.OpenTKMusic">

            <summary>

            OpenTK music

            Sample code for implementing

            -> http://www.opentk.com/node/1705

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OpenTKMusic.nativeMusicData">

            <summary>

            Music handle

            </summary>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OpenTKMusic.#ctor(Delta.Multimedia.Music)">

            <summary>

            Create OpenTK music

            </summary>

            <param name="parentMusic">Parent music instance.</param>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OpenTKMusic.LoadNativeData(System.String)">

            <summary>

            Load content data

            </summary>

            <param name="filename">Filename</param>

            <returns>True if loading succeeded, otherwise False.</returns>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OpenTKMusic.Dispose">

            <summary>

            Dispose data

            </summary>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OpenTKMusic.SetVolume(System.Single)">

            <summary>

            Set the volume of the native OpenTK music.

            </summary>

            <param name="setVolume">Volume to set.</param>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OpenTKMusic.PlayNative">

            <summary>

            Play native

            </summary>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OpenTKMusic.UpdateNative">

            <summary>

            Updates the Music

            </summary>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OpenTKMusic.StopNative">

            <summary>

            Stop native

            </summary>

        </member>

        <member name="T:Delta.Multimedia.OpenTK.OggInputStream">

            <summary>

            Ogg input stream

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.convbuffer">

            <summary>

            Conversion buffer

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream._pcm">

            <summary>

            temp vars

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream._index">

            <summary>

            _index

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.eos">

            <summary>

            end of stream

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.syncState">

            <summary>

            sync and verify incoming physical bitstream

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.streamState">

            <summary>

            take physical pages, weld into a logical stream of packets

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.page">

            <summary>

            one Ogg bitstream page.  Vorbis packets are inside

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.packet">

            <summary>

            one raw packet of data for decode

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.info">

            <summary>

            struct that stores all the static vorbis bitstream settings

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.comment">

            <summary>

            struct that stores all the bitstream user comments

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.dspState">

            <summary>

            central working state for the packet->PCM decoder

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.block">

            <summary>

            local working space for packet->PCM decode

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.convsize">

            Conversion buffer size

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.convbufferOff">

            <summary>

            where we are in the convbuffer

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.convbufferSize">

            <summary>

            bytes ready in convbuffer.

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.readDummy">

            <summary>

            a dummy used by read() to read 1 byte.

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggInputStream.input">

            <summary>

            Input

            </summary>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.#ctor(System.IO.Stream)">

            <summary>

            Creates an OggInputStream that decompressed the specified ogg file.

            </summary>

            <param name="input">Input file stream.</param>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.Read">

            <summary>

            Reads the next byte of data from this input stream. The value byte is

            returned as an int in the range 0 to 255. If no byte is available

            because the end of the stream has been reached, the value -1 is

            returned. This method blocks until input data is available, the end

            of the stream is detected, or an exception is thrown.

            </summary>

            <returns>the next byte of data, or -1 if the end of the stream is

            reached.</returns>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.Read(System.Byte[],System.Int32,System.Int32)">

            <summary>

            Reads up to len bytes of data from the input stream into an

            array of bytes.

            </summary>

            <param name="b">the buffer into which the data is read.</param>

            <param name="off">the start offset of the data.</param>

            <param name="len">the maximum number of bytes read.</param>

            <returns>the total number of bytes read into the buffer, or -1 if

            there is no more data because the end of the stream has been reached.

            </returns>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.Read(System.IO.MemoryStream,System.Int32,System.Int32)">

            <summary>

            Reads up to len bytes of data from the input stream into a ByteBuffer.

            </summary>

            <param name="stream"></param>

            <param name="off">the start offset of the data.</param>

            <param name="len">the maximum number of bytes read.</param>

            <returns>the total number of bytes read into the buffer, or -1 if

            there is no more data because the end of the stream has been reached.

            </returns>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.Skip(System.Int64)">

            <summary>

            Skips over and discards n bytes of data from the input stream.

            The skip method may, for a variety of reasons, end up skipping over

            some smaller number of bytes, possibly 0. The actual number of bytes

            skipped is returned. 

            </summary>

            <param name="n">the number of bytes to be skipped.</param>

            <returns>the actual number of bytes skipped.</returns>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.ToString">

            <summary>

            Gets information on the ogg.

            </summary>

            <returns>Returns a string representing this ogg input stream.</returns>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.FillConvbuffer">

            <summary>

            Helper function. Decodes a packet to the convbuffer if it is empty.

            Updates convbufferSize, convbufferOff, and eos.

            </summary>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.InitVorbis">

            <summary>

            Initalizes the vorbis stream. Reads the stream until info

            and comment are read.

            </summary>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.DecodePacket(csogg.Packet)">

            <summary>

            Decodes a packet.

            TODO: Ugly code, refactor plz!

            </summary>

            <param name="packet">Packet to decode.</param>

            <returns>Unknown</returns>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.LazyDecodePacket">

            <summary>

            Decodes the next packet.

            </summary>

            <returns>bytes read into convbuffer of -1 if end of file</returns>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.GetNextPacket(csogg.Packet)">

            <summary>

            Get the next packet in the music file.

            </summary>

            <param name="packet">Packet instance where to fill the data.</param>

            <returns>Returns -1 if getting the next packet failed, otherwise 0.

            </returns>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggInputStream.FetchData">

            <summary>

            Copies data from input stream to syncState.

            </summary>

        </member>

        <member name="P:Delta.Multimedia.OpenTK.OggInputStream.Format">

            <summary>

            Gets the format of the ogg file. Is either MONO16 or STEREO16.

            </summary>

        </member>

        <member name="T:Delta.Multimedia.OpenTK.OggMusicData">

            <summary>

            OGG music data

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggMusicData.BufferSize">

            <summary>

            Size of a stream buffer in bytes.

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggMusicData.oggFileStream">

            <summary>

            The direct stream to the OGG file that we store for later disposing.

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggMusicData.oggStream">

            <summary>

            Decoding OGG input stream for loading the music data.

            </summary>

        </member>

        <member name="F:Delta.Multimedia.OpenTK.OggMusicData.contentPath">

            <summary>

            The path to the music content file.

            </summary>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggMusicData.#ctor(System.String)">

            <summary>

            Create OGG music data

            </summary>

            <param name="relativeFilePath">

            The path to the music content file.

            </param>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggMusicData.Rewind">

            <summary>

            Rewind the music stream to the start position, used for looping and

            called when the music finished playing.

            </summary>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggMusicData.Stream(System.Int32)">

            <summary>

            Stream

            </summary>

            <param name="bufferHandle">The buffer handle.</param>

            <returns>

            amount of buffered bytes

            </returns>

        </member>

        <member name="M:Delta.Multimedia.OpenTK.OggMusicData.Dispose">

            <summary>

            Dispose the source and all buffers of the ogg music.

            </summary>

        </member>

        <member name="P:Delta.Multimedia.OpenTK.OggMusicData.Format">

            <summary>

            Format

            </summary>

        </member>

        <member name="P:Delta.Multimedia.OpenTK.OggMusicData.SampleRate">

            <summary>

            Sample rate

            </summary>

        </member>

        <member name="P:Delta.Multimedia.OpenTK.OggMusicData.BufferHandles">

            <summary>

            OpenAL buffers for music streaming.

            </summary>

        </member>

        <member name="P:Delta.Multimedia.OpenTK.OggMusicData.Handle">

            <summary>

            OpenAL source handle.

            </summary>

        </member>

    </members>

</doc>