SecondaryBuffer Class (Microsoft.DirectX.DirectSound)

Contains methods and properties used to manage sound buffers that can support effects.

Definition

Visual Basic Public Class SecondaryBuffer
    Inherits Buffer
C# public class SecondaryBuffer : Buffer
C++ public ref class SecondaryBuffer : Buffer
JScript public class SecondaryBuffer extends Buffer

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 SecondaryBuffer object is finalized and collected by the garbage collector of the Microsoft .NET common language runtime.

Methods

Method Description
AcquireResources Allocates resources for a SecondaryBuffer object that was created with the DeferLocation flag set in the BufferDescription.
Clone Duplicates the SecondaryBuffer object.
Clone Duplicates the buffer object. Inherited from Buffer.
Dispose Immediately releases the unmanaged resources used by the SecondaryBuffer object.
Equals Returns a value that indicates whether the current instance is equal to a specified object.
Finalize Allows the SecondaryBuffer 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. Inherited from Buffer.
GetEffects Retrieves a Microsoft DirectSound effect object or objects from a SecondaryBuffer object.
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.
GetObjectInPath Retrieves a DirectSound effect object at a particular index from a SecondaryBuffer object.
static (Shared in Visual Basic) op_Equality Compares the current instance of a class to another instance to determine whether they are the same. Inherited from Buffer.
static (Shared in Visual Basic) op_Equality Compares the current instance of a class to another instance to determine whether they are the same.
static (Shared in Visual Basic) op_Inequality Compares the current instance of a class to another instance to determine whether they are different. Inherited from Buffer.
static (Shared in Visual Basic) 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. Inherited from Buffer.
raise_Disposing Raises the SecondaryBuffer.Disposing event when called from within a derived class.
Read Reads the current data in the buffer. Inherited from Buffer.
Restore Restores the memory allocation for a lost sound buffer. Inherited from Buffer.
SecondaryBuffer Initializes a new instance of the SecondaryBuffer class.
SetCurrentPosition Sets the position of the play cursor, which is the point at which the next byte of data is read from the buffer. Inherited from Buffer.
SetEffects Enables effects on a SecondaryBuffer object.
Stop Causes the sound buffer to stop playing. Inherited from Buffer.
Write Writes data to the buffer. Inherited from Buffer.

Properties

Property Description
Caps Retrieves the capabilities of the buffer object. Inherited from Buffer.
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. Inherited from Buffer.
Frequency Retrieves or sets the frequency, in samples per second, at which the buffer is playing. Inherited from Buffer.
NotVirtualized Retrieves a value that indicates whether the buffer is virtualized. Inherited from Buffer.
Pan Retrieves or sets the relative volume of the left and right audio channels. Inherited from Buffer.
PlayPosition Retrieves the position of the play cursor in the sound buffer. Inherited from Buffer.
Status Retrieves the status of the sound buffer. Inherited from Buffer.
Volume Retrieves or sets the attenuation of the sound. Inherited from Buffer.
WritePosition Retrieves the position of the write cursor in the sound buffer. Inherited from Buffer.

Inheritance Hierarchy

ObjectLeave Site
MarshalByRefObjectLeave Site
Buffer
SecondaryBuffer

Remarks

SecondaryBuffer objects are derived from the Buffer class and can support effects; Buffer objects do not support effects.

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
Show:
© 2014 Microsoft