Caps Structure

Language:

Contains properties that describe the capabilities of a Microsoft DirectSound Device object.

Definition

Visual Basic Public Structure Caps

C# public struct Caps

C++ public value class Caps sealed

JScript In JScript, you can use structures, but you cannot define your own.

Visual Basic	Public Structure Caps
C#	public struct Caps
C++	public value class Caps sealed
JScript	In JScript, you can use structures, but you cannot define your own.

Members Table

The following table lists the members exposed by the object. Click a tab on the left to choose the type of member you want to view.

Methods

Method Description

Caps Initializes a new instance of the Caps structure.

ToString Obtains a string representation of the current instance.

Properties

Property Description

Certified Retrieves whether the driver is a certified Windows Driver Module (WDM) device driver.

ContinuousRate Retrieves whether the Device object supports all sample rates between the MinSecondarySampleRate and MaxSecondarySampleRate values.

EmulateDriver Retrieves whether the Device object does not have a DirectSound driver installed.

FreeHardware3DAllBuffers Retrieves the number of unallocated 3-D buffers.

FreeHardware3DStaticBuffers Retrieves the number of unallocated static 3-D buffers.

FreeHardware3DStreamingBuffers Retrieves the number of unallocated streaming 3-D buffers.

FreeHardwareMemoryBytes Retrieves the size, in bytes, of the free memory on the sound card.

FreeHardwareMixingAllBuffers Retrieves the number of unallocated buffers.

FreeHardwareMixingStaticBuffers Retrieves the number of unallocated static buffers.

FreeHardwareMixingStreamingBuffers Retrieves the number of unallocated streaming buffers.

MaxContigousFreeHardwareMemoryBytes Retrieves the size, in bytes, of the largest contiguous block of free memory on the sound card.

MaxHardware3DAllBuffers Retrieves the maximum number of 3-D buffers.

MaxHardware3DStaticBuffers Retrieves the maximum number of static 3-D buffers.

MaxHardware3DStreamingBuffers Retrieves the maximum number of streaming 3-D buffers.

MaxHardwareMixingAllBuffers Retrieves the number of buffers that can be mixed in hardware.

MaxHardwareMixingStaticBuffers Retrieves the maximum number of static buffers.

MaxHardwareMixingStreamingBuffers Retrieves the maximum number of streaming sound buffers.

MaxSecondarySampleRate Retrieves the maximum sample rate specifications that are supported by this Device object's hardware SecondaryBuffer objects.

MinSecondarySampleRate Retrieves the maximum sample rate specifications that are supported by this Device object's hardware SecondaryBuffer objects.

PlayCpuOverheadSoftwareBuffers Retrieves the processing overhead, as a percentage of main processor cycles, needed to mix software buffers.

Primary16Bit Retrieves whether the Device object supports a primary buffer with 16-bit samples.

Primary8Bit Retrieves whether the Device object supports primary buffers with 8-bit samples.

PrimaryBuffers Retrieves the number of primary buffers supported.

PrimaryMono Retrieves whether the Device object supports monophonic primary buffers.

PrimaryStereo Retrieves whether the Device object supports stereo primary buffers.

Secondary16Bit Retrieves whether the Device object supports hardware-mixed SecondaryBuffer objects with 16-bit samples.

Secondary8Bit Retrieves whether the Device object supports hardware-mixed SecondaryBuffer objects with 8-bit samples.

SecondaryMono Retrieves whether the Device object supports hardware-mixed monophonic SecondaryBuffer objects.

SecondaryStereo Retrieves whether the Device object supports hardware-mixed stereo SecondaryBuffer objects.

TotalHardwareMemoryBytes Retrieves the size, in bytes, of the amount of memory on the sound card that stores static sound buffers.

UnlockTransferRateHardwareBuffers Retrieves the rate, in kilobytes per second, at which data can be transferred to hardware static sound buffers.

Method	Description
Caps	Initializes a new instance of the Caps structure.
ToString	Obtains a string representation of the current instance.

Property	Description
Certified	Retrieves whether the driver is a certified Windows Driver Module (WDM) device driver.
ContinuousRate	Retrieves whether the Device object supports all sample rates between the MinSecondarySampleRate and MaxSecondarySampleRate values.
EmulateDriver	Retrieves whether the Device object does not have a DirectSound driver installed.
FreeHardware3DAllBuffers	Retrieves the number of unallocated 3-D buffers.
FreeHardware3DStaticBuffers	Retrieves the number of unallocated static 3-D buffers.
FreeHardware3DStreamingBuffers	Retrieves the number of unallocated streaming 3-D buffers.
FreeHardwareMemoryBytes	Retrieves the size, in bytes, of the free memory on the sound card.
FreeHardwareMixingAllBuffers	Retrieves the number of unallocated buffers.
FreeHardwareMixingStaticBuffers	Retrieves the number of unallocated static buffers.
FreeHardwareMixingStreamingBuffers	Retrieves the number of unallocated streaming buffers.
MaxContigousFreeHardwareMemoryBytes	Retrieves the size, in bytes, of the largest contiguous block of free memory on the sound card.
MaxHardware3DAllBuffers	Retrieves the maximum number of 3-D buffers.
MaxHardware3DStaticBuffers	Retrieves the maximum number of static 3-D buffers.
MaxHardware3DStreamingBuffers	Retrieves the maximum number of streaming 3-D buffers.
MaxHardwareMixingAllBuffers	Retrieves the number of buffers that can be mixed in hardware.
MaxHardwareMixingStaticBuffers	Retrieves the maximum number of static buffers.
MaxHardwareMixingStreamingBuffers	Retrieves the maximum number of streaming sound buffers.
MaxSecondarySampleRate	Retrieves the maximum sample rate specifications that are supported by this Device object's hardware SecondaryBuffer objects.
MinSecondarySampleRate	Retrieves the maximum sample rate specifications that are supported by this Device object's hardware SecondaryBuffer objects.
PlayCpuOverheadSoftwareBuffers	Retrieves the processing overhead, as a percentage of main processor cycles, needed to mix software buffers.
Primary16Bit	Retrieves whether the Device object supports a primary buffer with 16-bit samples.
Primary8Bit	Retrieves whether the Device object supports primary buffers with 8-bit samples.
PrimaryBuffers	Retrieves the number of primary buffers supported.
PrimaryMono	Retrieves whether the Device object supports monophonic primary buffers.
PrimaryStereo	Retrieves whether the Device object supports stereo primary buffers.
Secondary16Bit	Retrieves whether the Device object supports hardware-mixed SecondaryBuffer objects with 16-bit samples.
Secondary8Bit	Retrieves whether the Device object supports hardware-mixed SecondaryBuffer objects with 8-bit samples.
SecondaryMono	Retrieves whether the Device object supports hardware-mixed monophonic SecondaryBuffer objects.
SecondaryStereo	Retrieves whether the Device object supports hardware-mixed stereo SecondaryBuffer objects.
TotalHardwareMemoryBytes	Retrieves the size, in bytes, of the amount of memory on the sound card that stores static sound buffers.
UnlockTransferRateHardwareBuffers	Retrieves the rate, in kilobytes per second, at which data can be transferred to hardware static sound buffers.

Remarks

Some audio cards may be unable to report accurately the number of available or free hardware buffers. This can happen, for example, when the card can play more sounds at lower sampling rates than at higher rates. In general, a nonzero value in any of the members relating to number of free hardware buffers signifies that at least one hardware resource of the appropriate type is available.

The unlock transfer rate for software buffers is 0, because the data need not be transferred anywhere. Similarly, the play processing overhead for hardware buffers is 0 because the mixing is done by the sound device.

Structure 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

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