Buffer Class (Microsoft.DirectX.DirectSound)

Article
11/06/2009

Contains methods and properties used to manage sound buffers.

Definition

Visual Basic Public Class Buffer
Inherits MarshalByRefObject
Implements IDisposable

C# public class Buffer : MarshalByRefObject, IDisposable

C++ public ref class Buffer : MarshalByRefObject, IDisposable

JScript public class Buffer extends MarshalByRefObject implements IDisposable

Members Table

The following table lists the members exposed by the object.

Events

Event Description

Disposing Occurs when the Dispose method is called or when the Buffer object is finalized and collected by the garbage collector of the Microsoft .NET common language runtime.

Methods

Method Description

Buffer Initializes a new instance of the Buffer class.

Clone Duplicates the buffer object.

Dispose Immediately releases the unmanaged resources used by the Buffer object.

Equals Returns a value that indicates whether the current instance is equal to a specified object.

Finalize Allows the Buffer object to free resources before it is destroyed by the garbage collector.

GetCurrentPosition Retrieves the position of the play and write cursors in the sound buffer.

GetHashCode Returns the hash code for the current instance.

GetObjectByValue This member supports the infrastructure for Microsoft DirectX 9.0 for Managed Code and is not intended to be used directly from your code.

op_Equality Compares the current instance of a class to another instance to determine whether they are the same.

op_Inequality Compares the current instance of a class to another instance to determine whether they are different.

Play Begin playing the sound buffer, starting at the play cursor.

raise_Disposing Raises the Buffer.Disposing event when called from within a derived class.

Read Reads the current data in the buffer.

Restore Restores the memory allocation for a lost sound buffer.

SetCurrentPosition Sets the position of the play cursor, which is the point at which the next byte of data is read from the buffer.

Stop Causes the sound buffer to stop playing.

Write Writes data to the buffer.

Properties

Property Description

Caps Retrieves the capabilities of the buffer object.

Disposed Gets a value that indicates whether the object is disposed.

Format Retrieves or sets a description of the sound data format in the buffer.

Frequency Retrieves or sets the frequency, in samples per second, at which the buffer is playing.

NotVirtualized Retrieves a value that indicates whether the buffer is virtualized.

Pan Retrieves or sets the relative volume of the left and right audio channels.

PlayPosition Retrieves the position of the play cursor in the sound buffer.

Status Retrieves the status of the sound buffer.

Volume Retrieves or sets the attenuation of the sound.

WritePosition Retrieves the position of the write cursor in the sound buffer.

Event	Description
Disposing	Occurs when the Dispose method is called or when the Buffer object is finalized and collected by the garbage collector of the Microsoft .NET common language runtime.

Method	Description
Buffer	Initializes a new instance of the Buffer class.
Clone	Duplicates the buffer object.
Dispose	Immediately releases the unmanaged resources used by the Buffer object.
Equals	Returns a value that indicates whether the current instance is equal to a specified object.
Finalize	Allows the Buffer object to free resources before it is destroyed by the garbage collector.
GetCurrentPosition	Retrieves the position of the play and write cursors in the sound buffer.
GetHashCode	Returns the hash code for the current instance.
GetObjectByValue	This member supports the infrastructure for Microsoft DirectX 9.0 for Managed Code and is not intended to be used directly from your code.
op_Equality	Compares the current instance of a class to another instance to determine whether they are the same.
op_Inequality	Compares the current instance of a class to another instance to determine whether they are different.
Play	Begin playing the sound buffer, starting at the play cursor.
raise_Disposing	Raises the Buffer.Disposing event when called from within a derived class.
Read	Reads the current data in the buffer.
Restore	Restores the memory allocation for a lost sound buffer.
SetCurrentPosition	Sets the position of the play cursor, which is the point at which the next byte of data is read from the buffer.
Stop	Causes the sound buffer to stop playing.
Write	Writes data to the buffer.

Property	Description
Caps	Retrieves the capabilities of the buffer object.
Disposed	Gets a value that indicates whether the object is disposed.
Format	Retrieves or sets a description of the sound data format in the buffer.
Frequency	Retrieves or sets the frequency, in samples per second, at which the buffer is playing.
NotVirtualized	Retrieves a value that indicates whether the buffer is virtualized.
Pan	Retrieves or sets the relative volume of the left and right audio channels.
PlayPosition	Retrieves the position of the play cursor in the sound buffer.
Status	Retrieves the status of the sound buffer.
Volume	Retrieves or sets the attenuation of the sound.
WritePosition	Retrieves the position of the write cursor in the sound buffer.

Inheritance Hierarchy

Object

MarshalByRefObject

Buffer

SecondaryBuffer

Class Information

Namespace Microsoft.DirectX.DirectSound

Assembly Microsoft.DirectX.DirectSound (microsoft.directx.directsound.dll)

Strong Name Microsoft.DirectX.DirectSound, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

Visual Basic	Public Class Buffer Inherits MarshalByRefObject Implements IDisposable
C#	public class Buffer : MarshalByRefObject, IDisposable
C++	public ref class Buffer : MarshalByRefObject, IDisposable
JScript	public class Buffer extends MarshalByRefObject implements IDisposable

Namespace	Microsoft.DirectX.DirectSound
Assembly	Microsoft.DirectX.DirectSound (microsoft.directx.directsound.dll)
Strong Name	Microsoft.DirectX.DirectSound, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

Buffer Class (Microsoft.DirectX.DirectSound)

Additional resources