/Dlls/Delta.Multimedia.BaseOpenAL.xml

<?xml version="1.0" encoding="utf-8"?>

<doc>

  <assembly>

    <name>Delta.Multimedia.BaseOpenAL</name>

  </assembly>

  <members>

    <member name="T:Delta.Multimedia.BaseOpenAL.OpenALSoundData">

      <summary>

            SoundData holds all data and information required by OpenAL to handle

            playback of sound (wave).

            

            NOTE: Don't use InvalidDataException because it's not supported in

            MonoTouch. So we use NotSupportedException.

            </summary>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALSoundData.#ctor(Delta.Multimedia.Sound,System.String)">

      <summary>

            Create sound data

            </summary>

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

      <param name="relativeFilepath">The relative filepath to the content

            sound file.</param>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALSoundData.Dispose">

      <summary>

            Dispose the sound data.

            </summary>

    </member>

    <member name="P:Delta.Multimedia.BaseOpenAL.OpenALSoundData.Channels">

      <summary>

            The number of sound channels.

            </summary>

    </member>

    <member name="P:Delta.Multimedia.BaseOpenAL.OpenALSoundData.SampleRate">

      <summary>

            The sample rate of the sound.

            </summary>

    </member>

    <member name="P:Delta.Multimedia.BaseOpenAL.OpenALSoundData.BitsPerSample">

      <summary>

            The bits per sample of the sound.

            </summary>

    </member>

    <member name="P:Delta.Multimedia.BaseOpenAL.OpenALSoundData.Format">

      <summary>

            The format of the sound (Mono, Stereo) (8Bit, 16Bit)

            </summary>

    </member>

    <member name="P:Delta.Multimedia.BaseOpenAL.OpenALSoundData.BufferHandle">

      <summary>

            The pointer to the OpenAL sound buffer.

            </summary>

    </member>

    <member name="T:Delta.Multimedia.BaseOpenAL.WaveFormat">

      <summary>

            The possible wave file formats. More information can be found at:

            http://www.piclist.com/techref/io/serial/midi/wave.html

            http://de.wikipedia.org/wiki/RIFF_WAVE

            http://msdn.microsoft.com/en-us/library/ms713231

            </summary>

    </member>

    <member name="T:Delta.Multimedia.BaseOpenAL.OpenALBinding">

      <summary>

            OpenAL Binding class which handles all the native calls.

            Because all the calls are the same over all platforms we try now to

            use this single class instead of many which duplicated all the code.

            The OpenTK reference should be translated by the Build System

            automatically!

            </summary>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.SetVolume(System.Int32,System.Single)">

      <summary>

            Set the volume of the specified audio source to the volume.

            </summary>

      <param name="sourceId">The audio source which the volume will be

            applied to.</param>

      <param name="volume">New Volume value for the audio source.</param>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.GenBuffer">

      <summary>

            Generate a new buffer for audio data.

            </summary>

      <returns>The unique buffer id stored as an integer.</returns>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.GenBuffers(System.Int32)">

      <summary>

            Generate new buffers for audio data.

            </summary>

      <param name="bufferCount">The number of buffers to generate.</param>

      <returns>The unique buffer ids stored as an integer array.</returns>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.GenSource">

      <summary>

            Generate a new audio source.

            </summary>

      <returns>

            The unique source id stored as an integer.

            </returns>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.BufferData(System.Int32,OpenTK.Audio.OpenAL.ALFormat,System.Byte[],System.Int32)">

      <summary>

            Buffer the specified bufferData to the buffer with the bufferId,

            respecting the format and sampleRate.

            </summary>

      <param name="bufferId">The id of the buffer to store the data to.

            </param>

      <param name="format">The format of the sound buffer data.</param>

      <param name="bufferData">The actual buffer data as bytes.</param>

      <param name="sampleRate">The sample rate of the data.</param>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.SetBuffer(System.Int32,System.Int32)">

      <summary>

            Link the buffer to the source, so when playing the source it knows

            which data to play.

            </summary>

      <param name="sourceId">The id of the source to bind the buffer to.

            </param>

      <param name="bufferId">The id of the buffer to assign.</param>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.SetPitch(System.Int32,System.Single)">

      <summary>

            Set the pitch (speed) of the source to the new value.

            </summary>

      <param name="sourceId">Id of the source to apply the new pitch to.</param>

      <param name="pitch">New pitch value for the source.</param>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.SetPan(System.Int32,System.Single)">

      <summary>

            Set the pan of the source to the new value.

            </summary>

      <param name="sourceId">Id of the source to apply the new pan to.

            </param>

      <param name="pan">Panning, ranging from -1.0f (full left)

            to 1.0f (full right). 0.0f is centered.</param>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.PlaySource(System.Int32)">

      <summary>

            Play the source with the specified id.

            </summary>

      <param name="sourceId">Id of the source to play.</param>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.PauseSource(System.Int32)">

      <summary>

            Pause the source with the specified id.

            </summary>

      <param name="sourceId">Id of the source to pause.</param>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.StopSource(System.Int32)">

      <summary>

            Stop playing the source with the specified id.

            </summary>

      <param name="sourceId">Id of the source to stop.</param>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.SetLooping(System.Int32,System.Boolean)">

      <summary>

            Set the flag if the source should loop or not.

            </summary>

      <param name="sourceId">Id of the source.</param>

      <param name="loop">Flag if source should loop or not.</param>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.GetSourceState(System.Int32)">

      <summary>

            Get the current state of the source.

            </summary>

      <param name="sourceId">The id of the source.</param>

      <returns>

            Returns the state of the source: playing, paused or stopped.

            </returns>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.GetBuffersQueued(System.Int32)">

      <summary>

            Get the number of queued buffers for the source.

            </summary>

      <param name="sourceId">Source id.</param>

      <returns>Number of queued buffers.</returns>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.GetBuffersProcessed(System.Int32)">

      <summary>

            Get the number of processed buffers for the source.

            </summary>

      <param name="sourceId">Source id.</param>

      <returns>Number of processed buffers.</returns>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.SourceQueueBuffers(System.Int32,System.Int32[])">

      <summary>

            Queue the buffers for the specific source.

            </summary>

      <param name="sourceId">Id of the source.</param>

      <param name="buffers">Buffers to queue.</param>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.SourceUnqueueBuffers(System.Int32,System.Int32)">

      <summary>

            Unqueue the buffers of the specific source.

            </summary>

      <param name="sourceId">Id of the source.</param>

      <param name="bufferCount">Number of buffers to unqueue.</param>

      <returns>Returns the OpenAL pointers to the unqueued buffers.</returns>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.DeleteSource(System.Int32)">

      <summary>

            Delete and free the native source data.

            </summary>

      <param name="sourceId">The id of the source to free.</param>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.DeleteBuffer(System.Int32)">

      <summary>

            Delete and free the native buffer data.

            </summary>

      <param name="bufferId">The id of the buffer to free.</param>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.DeleteBuffers(System.Int32[])">

      <summary>

            Delete and free the native buffer data.

            </summary>

      <param name="buffers">The ids of the buffers to free.</param>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.GetErrorString">

      <summary>

            Returns the error message if any occurred, otherwise it returns "".

            </summary>

      <returns>

            Returns the error string if any occurred, otherwise "".

            </returns>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.CheckError">

      <summary>

            Check error.

            </summary>

    </member>

    <member name="M:Delta.Multimedia.BaseOpenAL.OpenALBinding.MakeAudioContextCurrent">

      <summary>

            Make the current or a new audio context current which also checks

            if we have proper sound card drivers or a sound card at all.

            </summary>

    </member>

  </members>

</doc>