SecondaryBuffer.SecondaryBuffer Constructor

Language:

Initializes a new instance of the SecondaryBuffer class.

Definition

Visual Basic Public Sub New( _
    ByVal source As Stream, _
    ByVal length As Integer, _
    ByVal desc As BufferDescription, _
    ByVal parent As Device _
)

C# public SecondaryBuffer(
    Stream source,
    int length,
    BufferDescription desc,
    Device parent
);

C++ public:
SecondaryBuffer(
    Stream^ source,
    int length,
    BufferDescription^ desc,
    Device^ parent
);

JScript public function SecondaryBuffer(
    source : Stream,
    length : int,
    desc : BufferDescription,
    parent : Device
);

Visual Basic	Public Sub New( _ ByVal source As Stream, _ ByVal length As Integer, _ ByVal desc As BufferDescription, _ ByVal parent As Device _ )
C#	public SecondaryBuffer( Stream source, int length, BufferDescription desc, Device parent );
C++	public: SecondaryBuffer( Stream^ source, int length, BufferDescription^ desc, Device^ parent );
JScript	public function SecondaryBuffer( source : Stream, length : int, desc : BufferDescription, parent : Device );

Parameters

source System.IO.Stream
A Stream object that contains the source data for the buffer.

length System.Int32
An integer that represents the size of the buffer to create.

desc Microsoft.DirectX.DirectSound.BufferDescription
A BufferDescription object that describes the buffer to create.

parent Microsoft.DirectX.DirectSound.Device
A Device object that represents the parent device to use with the buffer.

Remarks

Note: If the method succeeds, to determine whether a requested 3-D algorithm was available or not, and stereo panning was substituted, check the Buffer.NotVirtualized property.

Microsoft DirectSound does not initialize the contents of the buffer, and the application cannot assume that it contains silence.

If an attempt is made to create a buffer with LocateInHardware set to true in the BufferDescription on a system where hardware acceleration is not available, the method fails throwing either ControlUnavailableException or InvalidCallException, depending on the operating system.

If an attempt is made to create a buffer with Control3D set to true in the BufferDescription and you attempt to load the buffer with a stero sound, the method fails throwing a ArgumentException .

Exceptions

AllocatedException The request failed because resources, such as a priority level, were already in use by another caller.

ArgumentException An invalid parameter was passed to the called method.

ArgumentNullException One or more of the parameters is null.

BadFormatException The specified wave format is not supported.

BufferTooSmallException The buffer size is not large enough to enable effects processing.

ControlUnavailableException The buffer control (volume, pan, and so on) requested by the caller is not available. Controls must be specified when the buffer is created.

InvalidCallException The method call is invalid for the current state of this object.

NoAggregationException The object does not support aggregation.

OutOfMemoryException DirectSound could not allocate sufficient memory to complete the call.

UnsupportedException The function called is not supported at this time.

Feedback? Please provide us with your comments on this topic.

source	System.IO.Stream A Stream object that contains the source data for the buffer.
length	System.Int32 An integer that represents the size of the buffer to create.
desc	Microsoft.DirectX.DirectSound.BufferDescription A BufferDescription object that describes the buffer to create.
parent	Microsoft.DirectX.DirectSound.Device A Device object that represents the parent device to use with the buffer.

AllocatedException	The request failed because resources, such as a priority level, were already in use by another caller.
ArgumentException	An invalid parameter was passed to the called method.
ArgumentNullException	One or more of the parameters is null.
BadFormatException	The specified wave format is not supported.
BufferTooSmallException	The buffer size is not large enough to enable effects processing.
ControlUnavailableException	The buffer control (volume, pan, and so on) requested by the caller is not available. Controls must be specified when the buffer is created.
InvalidCallException	The method call is invalid for the current state of this object.
NoAggregationException	The object does not support aggregation.
OutOfMemoryException	DirectSound could not allocate sufficient memory to complete the call.
UnsupportedException	The function called is not supported at this time.