NewGamePhysics.Utilities.SampleBuffer Class Reference

Object which represents a data buffer of audio samples. More...

List of all members.

Public Member Functions
	SampleBuffer (IntPtr waveOutHandle, int bufferSize)
	Represents a sample buffer which can be played via the native interface.
void	Dispose ()
	Dispose of sample buffer.
bool	Play ()
	Start playing the sample buffer.
void	WaitForBuffer ()
	Waits for event indicating that a buffer has completed playing.
void	OnCompleted ()
	Set event that buffer has completed playing.
Properties
int	Size [get]
	Gets the size of the sample buffer.
IntPtr	Data [get]
	Gets a pointer to the sample buffer.

---

Detailed Description

Object which represents a data buffer of audio samples.

Definition at line 267 of file NativeAudio.cs.

---

Constructor & Destructor Documentation

NewGamePhysics.Utilities.SampleBuffer.SampleBuffer	(	IntPtr	waveOutHandle,
		int	bufferSize
	)

Represents a sample buffer which can be played via the native interface.

Parameters:

	waveOutHandle	Pointer to sample buffer.
	bufferSize	Size of sample buffer.

Definition at line 343 of file NativeAudio.cs.

                {
            // Sample buffer
            waveData = waveOutHandle;

            // Create header
            headerHandle = GCHandle.Alloc(header, GCHandleType.Pinned);
            header.dwUser = (IntPtr)GCHandle.Alloc(this);

            // Create sample buffer
            headerData = new byte[bufferSize];
            headerDataHandle = GCHandle.Alloc(headerData, GCHandleType.Pinned);
            header.lpData = headerDataHandle.AddrOfPinnedObject();
            header.dwBufferLength = bufferSize;

            // Prepare sample buffer
            int error = NativeAudioInterface.waveOutPrepareHeader(
                waveData, 
                ref header, 
                Marshal.SizeOf(header));
            if (error != NativeAudioInterface.MMSYSERR_NOERROR)
            {
                throw new ApplicationException("Could not prepare sample buffer.");
            }
                }

---

Member Function Documentation

void NewGamePhysics.Utilities.SampleBuffer.Dispose

(

)

Dispose of sample buffer.

Definition at line 380 of file NativeAudio.cs.

        {
            // Clean header
            if (header.lpData != IntPtr.Zero)
            {
                NativeAudioInterface.waveOutUnprepareHeader(waveData, ref header, Marshal.SizeOf(header));
                headerHandle.Free();
                header.lpData = IntPtr.Zero;
            }
            
            // Clean sample buffer
            if (headerDataHandle.IsAllocated)
            {
                headerDataHandle.Free();
            }

            // Clean event
            bufferCompleted.Close();

            GC.SuppressFinalize(this);
        }

void NewGamePhysics.Utilities.SampleBuffer.OnCompleted

(

)

Set event that buffer has completed playing.

Definition at line 451 of file NativeAudio.cs.

        {
            lock (this)
            {
                this.bufferCompleted.Set();
                this.isPlaying = false;
            }
        }

bool NewGamePhysics.Utilities.SampleBuffer.Play

(

)

Start playing the sample buffer.

Returns:

True if playback was be started.

Definition at line 422 of file NativeAudio.cs.

        {
            lock(this)
            {
                this.bufferCompleted.Reset();
                int result = NativeAudioInterface.waveOutWrite(
                    waveData, 
                    ref header, 
                    Marshal.SizeOf(header));
                this.isPlaying = (result == NativeAudioInterface.MMSYSERR_NOERROR);                
            }

            return this.isPlaying;
        }

void NewGamePhysics.Utilities.SampleBuffer.WaitForBuffer

(

)

Waits for event indicating that a buffer has completed playing.

Definition at line 440 of file NativeAudio.cs.

        {
            if (this.isPlaying)
            {
                this.bufferCompleted.WaitOne(new TimeSpan(0, 0, BufferWaitTimeoutSeconds));
            }
        }

---

Property Documentation

IntPtr NewGamePhysics.Utilities.SampleBuffer.Data [get]

Gets a pointer to the sample buffer.

Definition at line 414 of file NativeAudio.cs.

int NewGamePhysics.Utilities.SampleBuffer.Size [get]

Gets the size of the sample buffer.

Definition at line 406 of file NativeAudio.cs.

---

The documentation for this class was generated from the following file:

• C:/Users/Andreas Schiffler/Desktop/SVN/NewGamePhysics/NewGamePhysics/Utilities/NativeAudio.cs