Taiko_Stuff/OpenTaiko
1
0
Fork 0
mirror of synced 2024-12-22 20:36:03 +01:00
Code Releases Activity
92b8a9c87c
OpenTaiko/Test/dll/SharpDX.DirectSound.xml
0aubsq 1035db6506 First commit
2021-09-21 00:16:38 +02:00

6977 lines
580 KiB
XML
Raw Blame History

<?xml version="1.0"?>
<doc>
<assembly>
<name>SharpDX.DirectSound</name>
</assembly>
<members>
<member name="T:SharpDX.DirectSound.AssemblyDoc">
<summary>
The <see cref="A:SharpDX.DirectSound"/> assembly provides managed DirectSound API.
</summary>
<msdn-id>ee416960</msdn-id>
<unmanaged>DirectSound</unmanaged>
<unmanaged-short>DirectSound</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.Buffer3DSettings">
<summary>
The <see cref="T:SharpDX.DirectSound.Buffer3DSettings" /> structure contains all information necessary to uniquely describe the location, orientation, and motion of a 3D sound buffer. This structure is used with theIDirectSound3DBuffer8::GetAllParametersandIDirectSound3DBuffer8::SetAllParametersmethods.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DBUFFER']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dbuffer</msdn-id>
<unmanaged>DS3DBUFFER</unmanaged>
<unmanaged-short>DS3DBUFFER</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.Buffer3DSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.Buffer3DSettings"/> class.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Buffer3DSettings.Size">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DBUFFER::dwSize']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dbuffer</msdn-id>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Buffer3DSettings.Position">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DBUFFER::vPosition']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dbuffer</msdn-id>
<unmanaged>D3DVECTOR vPosition</unmanaged>
<unmanaged-short>D3DVECTOR vPosition</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Buffer3DSettings.Velocity">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DBUFFER::vVelocity']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dbuffer</msdn-id>
<unmanaged>D3DVECTOR vVelocity</unmanaged>
<unmanaged-short>D3DVECTOR vVelocity</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Buffer3DSettings.InsideConeAngle">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DBUFFER::dwInsideConeAngle']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dbuffer</msdn-id>
<unmanaged>unsigned int dwInsideConeAngle</unmanaged>
<unmanaged-short>unsigned int dwInsideConeAngle</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Buffer3DSettings.OutsideConeAngle">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DBUFFER::dwOutsideConeAngle']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dbuffer</msdn-id>
<unmanaged>unsigned int dwOutsideConeAngle</unmanaged>
<unmanaged-short>unsigned int dwOutsideConeAngle</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Buffer3DSettings.ConeOrientation">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DBUFFER::vConeOrientation']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dbuffer</msdn-id>
<unmanaged>D3DVECTOR vConeOrientation</unmanaged>
<unmanaged-short>D3DVECTOR vConeOrientation</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Buffer3DSettings.ConeOutsideVolume">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DBUFFER::lConeOutsideVolume']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dbuffer</msdn-id>
<unmanaged>int lConeOutsideVolume</unmanaged>
<unmanaged-short>int lConeOutsideVolume</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Buffer3DSettings.MinDistance">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DBUFFER::flMinDistance']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dbuffer</msdn-id>
<unmanaged>float flMinDistance</unmanaged>
<unmanaged-short>float flMinDistance</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Buffer3DSettings.MaxDistance">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DBUFFER::flMaxDistance']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dbuffer</msdn-id>
<unmanaged>float flMaxDistance</unmanaged>
<unmanaged-short>float flMaxDistance</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Buffer3DSettings.Mode">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DBUFFER::dwMode']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dbuffer</msdn-id>
<unmanaged>unsigned int dwMode</unmanaged>
<unmanaged-short>unsigned int dwMode</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.Capabilities">
<summary>
The <see cref="T:SharpDX.DirectSound.Capabilities" /> structure describes the capabilities of a device. It is used by theIDirectSound8::GetCapsmethod.
</summary>
<remarks>
<p>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.</p> <p>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.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>DSCAPS</unmanaged>
<unmanaged-short>DSCAPS</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.Capabilities.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.Capabilities"/> class.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.Size">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwSize']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.Flags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwFlags']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>DSCAPS_FLAGS dwFlags</unmanaged>
<unmanaged-short>DSCAPS_FLAGS dwFlags</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.MinSecondarySampleRate">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwMinSecondarySampleRate']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwMinSecondarySampleRate</unmanaged>
<unmanaged-short>unsigned int dwMinSecondarySampleRate</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.MaxSecondarySampleRate">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwMaxSecondarySampleRate']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwMaxSecondarySampleRate</unmanaged>
<unmanaged-short>unsigned int dwMaxSecondarySampleRate</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.PrimaryBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwPrimaryBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwPrimaryBuffers</unmanaged>
<unmanaged-short>unsigned int dwPrimaryBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.MaxHardwareMixingAllBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwMaxHwMixingAllBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwMaxHwMixingAllBuffers</unmanaged>
<unmanaged-short>unsigned int dwMaxHwMixingAllBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.MaxHardwareMixingStaticBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwMaxHwMixingStaticBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwMaxHwMixingStaticBuffers</unmanaged>
<unmanaged-short>unsigned int dwMaxHwMixingStaticBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.MaxHardwareMixingStreamingBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwMaxHwMixingStreamingBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwMaxHwMixingStreamingBuffers</unmanaged>
<unmanaged-short>unsigned int dwMaxHwMixingStreamingBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.FreeHardwareMixingAllBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwFreeHwMixingAllBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwFreeHwMixingAllBuffers</unmanaged>
<unmanaged-short>unsigned int dwFreeHwMixingAllBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.FreeHardwareMixingStaticBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwFreeHwMixingStaticBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwFreeHwMixingStaticBuffers</unmanaged>
<unmanaged-short>unsigned int dwFreeHwMixingStaticBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.FreeHardwareMixingStreamingBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwFreeHwMixingStreamingBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwFreeHwMixingStreamingBuffers</unmanaged>
<unmanaged-short>unsigned int dwFreeHwMixingStreamingBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.MaxHardware3DAllBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwMaxHw3DAllBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwMaxHw3DAllBuffers</unmanaged>
<unmanaged-short>unsigned int dwMaxHw3DAllBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.MaxHardware3DStaticBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwMaxHw3DStaticBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwMaxHw3DStaticBuffers</unmanaged>
<unmanaged-short>unsigned int dwMaxHw3DStaticBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.MaxHardware3DStreamingBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwMaxHw3DStreamingBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwMaxHw3DStreamingBuffers</unmanaged>
<unmanaged-short>unsigned int dwMaxHw3DStreamingBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.FreeHardware3DAllBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwFreeHw3DAllBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwFreeHw3DAllBuffers</unmanaged>
<unmanaged-short>unsigned int dwFreeHw3DAllBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.FreeHardware3DStaticBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwFreeHw3DStaticBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwFreeHw3DStaticBuffers</unmanaged>
<unmanaged-short>unsigned int dwFreeHw3DStaticBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.FreeHardware3DStreamingBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwFreeHw3DStreamingBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwFreeHw3DStreamingBuffers</unmanaged>
<unmanaged-short>unsigned int dwFreeHw3DStreamingBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.TotalHardwareMemBytes">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwTotalHwMemBytes']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwTotalHwMemBytes</unmanaged>
<unmanaged-short>unsigned int dwTotalHwMemBytes</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.FreeHardwareMemBytes">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwFreeHwMemBytes']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwFreeHwMemBytes</unmanaged>
<unmanaged-short>unsigned int dwFreeHwMemBytes</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.MaxContigFreeHardwareMemBytes">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwMaxContigFreeHwMemBytes']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwMaxContigFreeHwMemBytes</unmanaged>
<unmanaged-short>unsigned int dwMaxContigFreeHwMemBytes</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.UnlockTransferRateHardwareBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwUnlockTransferRateHwBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwUnlockTransferRateHwBuffers</unmanaged>
<unmanaged-short>unsigned int dwUnlockTransferRateHwBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.PlayCpuOverheadSwBuffers">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwPlayCpuOverheadSwBuffers']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwPlayCpuOverheadSwBuffers</unmanaged>
<unmanaged-short>unsigned int dwPlayCpuOverheadSwBuffers</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.Reserved1">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwReserved1']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwReserved1</unmanaged>
<unmanaged-short>unsigned int dwReserved1</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Capabilities.Reserved2">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS::dwReserved2']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>unsigned int dwReserved2</unmanaged>
<unmanaged-short>unsigned int dwReserved2</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.CaptureBuffer">
<summary>
<p>The <see cref="T:SharpDX.DirectSound.CaptureBuffer" /> interface is used to manipulate sound capture buffers.</p><p>To obtain the <see cref="T:SharpDX.DirectSound.CaptureBuffer" /> interface, call the IDirectSoundCapture8::CreateCaptureBuffer method to obtain <see cref="T:SharpDX.DirectSound.CaptureBufferBase" />, then pass IID_IDirectSoundCaptureBuffer8 to IDirectSoundCaptureBuffer::QueryInterface.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the <see cref="T:SharpDX.DirectSound.CaptureBuffer" /> interface exposes the following methods, arranged by category.</p>Capture Management<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundCaptureBuffer8::Lock </td><td>The Lock method locks a portion of the buffer. Locking the buffer returns references into the buffer, allowing the application to read or write audio data into memory.
</td></tr> <tr><td>IDirectSoundCaptureBuffer8::Start </td><td>The Start method begins capturing data into the buffer. If the buffer is already capturing, the method has no effect.
</td></tr> <tr><td>IDirectSoundCaptureBuffer8::Stop </td><td>The Stop method stops the buffer so that it is no longer capturing data. If the buffer is not capturing, the method has no effect.
</td></tr> <tr><td>IDirectSoundCaptureBuffer8::Unlock </td><td>The Unlock method unlocks the buffer.
</td></tr> </table>Effects<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td><see cref="M:SharpDX.DirectSound.CaptureBuffer.GetEffectStatus(System.Int32)" /> </td><td>The GetFXStatus method retrieves the status of capture effects.
</td></tr> <tr><td><see cref="M:SharpDX.DirectSound.CaptureBuffer.GetEffect(System.Guid,System.Int32,System.Guid,System.IntPtr@)" /> </td><td>The GetObjectInPath method retrieves an interface to an effect object associated with the buffer.
</td></tr> </table>Initialization<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundCaptureBuffer8::Initialize </td><td>The Initialize method initializes a capture buffer object. Because the IDirectSoundCapture8::CreateCaptureBufferIDirectSoundCapture8::CreateCaptureBuffer
</td></tr> </table>Information<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundCaptureBuffer8::GetCaps </td><td>The GetCaps method retrieves the capabilities of the buffer.
</td></tr> <tr><td>IDirectSoundCaptureBuffer8::GetCurrentPosition </td><td>Address of a variable that receives the offset from the start of the buffer, in bytes, of the capture cursor. The parameter can be <c>null</c> if this value is not wanted.
</td></tr> <tr><td>IDirectSoundCaptureBuffer8::GetFormat </td><td>The GetFormat method retrieves the waveform format of the capture buffer.
</td></tr> <tr><td>IDirectSoundCaptureBuffer8::GetStatus </td><td>The GetStatus method retrieves the status of the capture buffer.
</td></tr> </table><p>The LPDIRECTSOUNDCaptureBuffer8 type is defined as a reference to the <see cref="T:SharpDX.DirectSound.CaptureBuffer" /> interface:</p><pre> typedef struct <see cref="T:SharpDX.DirectSound.CaptureBuffer" /> *LPDIRECTSOUNDCaptureBuffer8;
</pre>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureBuffer8']/*" />
<msdn-id>ee418162</msdn-id>
<unmanaged>IDirectSoundCaptureBuffer8</unmanaged>
<unmanaged-short>IDirectSoundCaptureBuffer8</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.CaptureBuffer.#ctor(SharpDX.DirectSound.DirectSoundCapture,SharpDX.DirectSound.CaptureBufferDescription)">
<summary>
Creates a buffer for capturing waveform audio.
</summary>
<param name="capture">a reference to an instance of <see cref="T:SharpDX.DirectSound.DirectSoundCapture"/></param>
<param name="description">a <see cref="T:SharpDX.DirectSound.CaptureBufferDescription"/> structure containing values for the capture buffer being created. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IDirectSoundCapture::CreateCaptureBuffer([In] LPCDSCBUFFERDESC pcDSCBufferDesc,[Out] LPDIRECTSOUNDCAPTUREBUFFER* ppDSCBuffer,[None] IUnknown* pUnkOuter)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.CaptureBuffer.GetEffect``1(System.Int32)">
<summary>
Retrieves an interface to an effect object associated with the buffer.
</summary>
<param name="index">Index of the object within objects of that class in the path. See Remarks. </param>
<returns>an effect object associated with the buffer</returns>
<unmanaged>HRESULT IDirectSoundCaptureBuffer8::GetObjectInPath([In] GUID* rguidObject,[None] int dwIndex,[In] GUID* rguidInterface,[Out] void** ppObject)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.CaptureBuffer.GetEffectStatus(System.Int32)">
<summary>
Retrieves the status of capture effects.
</summary>
<param name="effectCount" />
<returns />
</member>
<member name="M:SharpDX.DirectSound.CaptureBuffer.SetNotificationPositions(SharpDX.DirectSound.NotificationPosition[])">
<summary>
Sets the notification positions.
</summary>
<param name="positions">The positions.</param>
<returns></returns>
</member>
<member name="M:SharpDX.DirectSound.CaptureBuffer.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.CaptureBuffer"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.CaptureBuffer.op_Explicit(System.IntPtr)~SharpDX.DirectSound.CaptureBuffer">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.CaptureBuffer"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="M:SharpDX.DirectSound.CaptureBuffer.GetEffect(System.Guid,System.Int32,System.Guid,System.IntPtr@)">
<summary>
The GetObjectInPath method retrieves an interface to an effect object associated with the buffer.
</summary>
<param name="rguidObject"><dd> Value of type REFGUID that specifies the unique class identifier of the object being searched for, such as <see cref="F:SharpDX.DirectSound.CaptureEffectGuid.AcousticEchoCancellationCaptureEffect" />. </dd></param>
<param name="index"><dd> Index of the object within objects of that class in the path. See Remarks. </dd></param>
<param name="rguidInterface"><dd> Unique identifier of the desired interface, such as IID_IDirectSoundCaptureFXAec8. </dd></param>
<param name="objectOut"><dd> Address of a variable that receives the desired interface reference. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_CONTROLUNAVAIL </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_OBJECTNOTFOUND </td></tr> </table></returns>
<remarks>
<p>The value in dwIndex is the index of the object within the array of effects in the <see cref="T:SharpDX.DirectSound.CaptureBufferDescription" /> structure passed to DirectSoundFullDuplexCreate8 or IDirectSoundCapture8::CreateCaptureBuffer.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureBuffer8::GetObjectInPath']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturebuffer8.idirectsoundcapturebuffer8.getobjectinpath</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureBuffer8::GetObjectInPath([In] const GUID&amp; rguidObject,[In] unsigned int dwIndex,[In] const GUID&amp; rguidInterface,[Out] void** ppObject)</unmanaged>
<unmanaged-short>IDirectSoundCaptureBuffer8::GetObjectInPath</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.CaptureBuffer.GetEffectStatus(System.Int32,SharpDX.DirectSound.CaptureEffectResult[])">
<summary>
The GetFXStatus method retrieves the status of capture effects.
</summary>
<param name="effectsCount"><dd> Number of elements in the pdwFXStatus array. </dd></param>
<param name="xStatusRef"><dd> Address of an array of DWORD variables that receive the status of each effect. This should contain the same number of elements as the array passed in the dwFXCount member of the <see cref="T:SharpDX.DirectSound.CaptureBufferDescription" /> structure passed to DirectSoundFullDuplexCreate8 or IDirectSoundCapture8::CreateCaptureBuffer. The possible values returned in the array are as follows:<table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DSCFXR_LOCHARDWARE</td><td>Effect is instantiated in hardware.</td></tr> <tr><td>DSCFXR_LOCSOFTWARE</td><td>Effect is instantiated in software.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureBuffer8::GetFXStatus']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturebuffer8.idirectsoundcapturebuffer8.getfxstatus</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureBuffer8::GetFXStatus([In] unsigned int dwEffectsCount,[Out, Buffer] DSCFX_ENUM* pdwFXStatus)</unmanaged>
<unmanaged-short>IDirectSoundCaptureBuffer8::GetFXStatus</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.CaptureBufferBase">
<summary>
<p>The <see cref="T:SharpDX.DirectSound.CaptureBuffer" /> interface is used to manipulate sound capture buffers.</p><p>To obtain the <see cref="T:SharpDX.DirectSound.CaptureBuffer" /> interface, call the IDirectSoundCapture8::CreateCaptureBuffer method to obtain <see cref="T:SharpDX.DirectSound.CaptureBufferBase" />, then pass IID_IDirectSoundCaptureBuffer8 to IDirectSoundCaptureBuffer::QueryInterface.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the <see cref="T:SharpDX.DirectSound.CaptureBuffer" /> interface exposes the following methods, arranged by category.</p>Capture Management<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundCaptureBuffer8::Lock </td><td>The Lock method locks a portion of the buffer. Locking the buffer returns references into the buffer, allowing the application to read or write audio data into memory.
</td></tr> <tr><td>IDirectSoundCaptureBuffer8::Start </td><td>The Start method begins capturing data into the buffer. If the buffer is already capturing, the method has no effect.
</td></tr> <tr><td>IDirectSoundCaptureBuffer8::Stop </td><td>The Stop method stops the buffer so that it is no longer capturing data. If the buffer is not capturing, the method has no effect.
</td></tr> <tr><td>IDirectSoundCaptureBuffer8::Unlock </td><td>The Unlock method unlocks the buffer.
</td></tr> </table>Effects<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td><see cref="M:SharpDX.DirectSound.CaptureBuffer.GetEffectStatus(System.Int32)" /> </td><td>The GetFXStatus method retrieves the status of capture effects.
</td></tr> <tr><td><see cref="M:SharpDX.DirectSound.CaptureBuffer.GetEffect(System.Guid,System.Int32,System.Guid,System.IntPtr@)" /> </td><td>The GetObjectInPath method retrieves an interface to an effect object associated with the buffer.
</td></tr> </table>Initialization<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundCaptureBuffer8::Initialize </td><td>The Initialize method initializes a capture buffer object. Because the IDirectSoundCapture8::CreateCaptureBufferIDirectSoundCapture8::CreateCaptureBuffer
</td></tr> </table>Information<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundCaptureBuffer8::GetCaps </td><td>The GetCaps method retrieves the capabilities of the buffer.
</td></tr> <tr><td>IDirectSoundCaptureBuffer8::GetCurrentPosition </td><td>Address of a variable that receives the offset from the start of the buffer, in bytes, of the capture cursor. The parameter can be <c>null</c> if this value is not wanted.
</td></tr> <tr><td>IDirectSoundCaptureBuffer8::GetFormat </td><td>The GetFormat method retrieves the waveform format of the capture buffer.
</td></tr> <tr><td>IDirectSoundCaptureBuffer8::GetStatus </td><td>The GetStatus method retrieves the status of the capture buffer.
</td></tr> </table><p>The LPDIRECTSOUNDCaptureBuffer8 type is defined as a reference to the <see cref="T:SharpDX.DirectSound.CaptureBuffer" /> interface:</p><pre> typedef struct <see cref="T:SharpDX.DirectSound.CaptureBuffer" /> *LPDIRECTSOUNDCaptureBuffer8;
</pre>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureBuffer']/*" />
<msdn-id>ee418162</msdn-id>
<unmanaged>IDirectSoundCaptureBuffer</unmanaged>
<unmanaged-short>IDirectSoundCaptureBuffer</unmanaged-short>
</member>
<member name="P:SharpDX.DirectSound.CaptureBufferBase.Capturing">
<summary>
True if the buffer is currently capturing.
</summary>
</member>
<member name="P:SharpDX.DirectSound.CaptureBufferBase.CurrentCapturePosition">
<summary>
The offset from the start of the buffer, in bytes, of the capture cursor.
</summary>
</member>
<member name="P:SharpDX.DirectSound.CaptureBufferBase.CurrentRealPosition">
<summary>
The offset from the start of the buffer, in bytes, of the read cursor.
</summary>
</member>
<member name="P:SharpDX.DirectSound.CaptureBufferBase.Looping">
<summary>
True if the capture buffer is looping.
</summary>
</member>
<member name="P:SharpDX.DirectSound.CaptureBufferBase.Format">
<summary>
Gets the waveform format of the capture buffer.
</summary>
<value>The format.</value>
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferBase.Lock(System.Int32,System.Int32,SharpDX.DirectSound.LockFlags,SharpDX.DataStream@)">
<summary>
The Lock method locks a portion of the buffer. Locking the buffer returns references into the buffer, allowing the application to read or write audio data into memory.
</summary>
<param name="offset">Offset, in bytes, from the start of the buffer to the point where the lock begins. </param>
<param name="sizeBytes">Size, in bytes, of the portion of the buffer to lock. Because the buffer is conceptually circular, this number can exceed the number of bytes between dwOffset and the end of the buffer. </param>
<param name="flags"> Flags modifying the lock event. The following flags are defined: ValueDescription DSBLOCK_FROMWRITECURSORStart the lock at the write cursor. The dwOffset parameter is ignored. DSBLOCK_ENTIREBUFFERLock the entire buffer. The dwBytes parameter is ignored. </param>
<param name="secondPart"> Address of a variable that receives a pointer to the second locked part of the capture buffer. If NULL is returned, the ppvAudioPtr1 parameter points to the entire locked portion of the capture buffer. </param>
<returns>Address of a variable that receives a pointer to the first locked part of the buffer.</returns>
<unmanaged>HRESULT IDirectSoundCaptureBuffer::Lock([None] int dwOffset,[None] int dwBytes,[Out] void** ppvAudioPtr1,[Out] int* pdwAudioBytes1,[Out] void** ppvAudioPtr2,[Out, Optional] int* pdwAudioBytes2,[None] int dwFlags)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferBase.Unlock(SharpDX.DataStream,SharpDX.DataStream)">
<summary>
The Unlock method releases a locked sound buffer.
</summary>
<param name="dataPart1"> Address of the value retrieved in the ppvAudioPtr1 parameter of the {{Lock}} method. </param>
<param name="dataPart2"> Address of the value retrieved in the ppvAudioPtr2 parameter of the IDirectSoundBuffer8::Lock method. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IDirectSoundBuffer::Unlock([In, Buffer] void* pvAudioPtr1,[None] int dwAudioBytes1,[In, Buffer, Optional] void* pvAudioPtr2,[None] int dwAudioBytes2)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferBase.Read``1(``0[],System.Int32,SharpDX.DirectSound.LockFlags)">
<summary>
Writes data to the buffer.
</summary>
<returns />
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferBase.Read``1(``0[],System.Int32,System.Int32,System.Int32,SharpDX.DirectSound.LockFlags)">
<summary>
Writes data to the buffer.
</summary>
<returns />
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferBase.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.CaptureBufferBase"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferBase.op_Explicit(System.IntPtr)~SharpDX.DirectSound.CaptureBufferBase">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.CaptureBufferBase"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.CaptureBufferBase.Capabilities">
<summary>
The GetCaps method retrieves the capabilities of the buffer.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureBuffer::GetCaps']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturebuffer8.idirectsoundcapturebuffer8.getcaps</msdn-id>
<unmanaged>GetCaps</unmanaged>
<unmanaged-short>GetCaps</unmanaged-short>
<unmanaged>HRESULT IDirectSoundCaptureBuffer::GetCaps([Out] DSCBCAPS* pDSCBCaps)</unmanaged>
</member>
<member name="P:SharpDX.DirectSound.CaptureBufferBase.CaptureStatus">
<summary>
The GetStatus method retrieves the status of the capture buffer.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureBuffer::GetStatus']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturebuffer8.idirectsoundcapturebuffer8.getstatus</msdn-id>
<unmanaged>GetStatus</unmanaged>
<unmanaged-short>GetStatus</unmanaged-short>
<unmanaged>HRESULT IDirectSoundCaptureBuffer::GetStatus([Out] DSCBSTATUS_FLAGS* pdwStatus)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferBase.GetCapabilities(SharpDX.DirectSound.CaptureBufferCapabilities@)">
<summary>
The GetCaps method retrieves the capabilities of the buffer.
</summary>
<param name="dSCBCapsRef"><dd> Pointer to a <see cref="T:SharpDX.DirectSound.CaptureBufferCapabilities" /> structure that receives information about the capture buffer. On input, the dwSize member must specify the size of the structure in bytes. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values: </p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_UNSUPPORTED </td></tr> <tr><td>DSERR_OUTOFMEMORY </td></tr> </table></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureBuffer::GetCaps']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturebuffer8.idirectsoundcapturebuffer8.getcaps</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureBuffer::GetCaps([Out] DSCBCAPS* pDSCBCaps)</unmanaged>
<unmanaged-short>IDirectSoundCaptureBuffer::GetCaps</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferBase.GetCurrentPosition(System.Int32@,System.Int32@)">
<summary>
The GetCurrentPosition method retrieves the positions of the capture and read cursors in the buffer.<p>The capture cursor is ahead of the read cursor. The data after the read position up to and including the capture position is not necessarily valid data.</p>
</summary>
<param name="apturePositionRef"><dd> Address of a variable that receives the offset from the start of the buffer, in bytes, of the capture cursor. The parameter can be <c>null</c> if this value is not wanted. </dd></param>
<param name="eadPositionRef"><dd> Address of a variable that receives the offset from the start of the buffer, in bytes, of the read cursor. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values: </p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_NODRIVER </td></tr> <tr><td>DSERR_OUTOFMEMORY </td></tr> </table></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureBuffer::GetCurrentPosition']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturebuffer8.idirectsoundcapturebuffer8.getcurrentposition</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureBuffer::GetCurrentPosition([Out, Optional] unsigned int* pdwCapturePosition,[Out, Optional] unsigned int* pdwReadPosition)</unmanaged>
<unmanaged-short>IDirectSoundCaptureBuffer::GetCurrentPosition</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferBase.GetFormat(System.IntPtr,System.Int32,System.Int32@)">
<summary>
The GetFormat method retrieves the waveform format of the capture buffer.
</summary>
<param name="wfxFormatRef"><dd> Address of a <see cref="T:SharpDX.Multimedia.WaveFormat" /> structure that receives a description of the sound data in the capture buffer. To retrieve the buffer size needed to contain the format description, specify <c>null</c>.; in this case, the DWORD pointed to by the pdwSizeWritten parameter receives the size of the structure needed to receive complete format information. </dd></param>
<param name="sizeAllocated"><dd> Size, in bytes, of the <see cref="T:SharpDX.Multimedia.WaveFormat" /> structure. DirectSoundCapture writes, at most, dwSizeAllocated bytes to the structure. </dd></param>
<param name="izeWrittenRef"><dd> Address of a variable that receives the number of bytes written to the <see cref="T:SharpDX.Multimedia.WaveFormat" /> structure; or, if pwfxFormat is <c>null</c>, the size of the <see cref="T:SharpDX.Multimedia.WaveFormat" /> structure that would be necessary to receive the information. This parameter can be <c>null</c> if the value is not wanted. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureBuffer::GetFormat']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturebuffer8.idirectsoundcapturebuffer8.getformat</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureBuffer::GetFormat([In] void* pwfxFormat,[In] unsigned int dwSizeAllocated,[Out, Optional] unsigned int* pdwSizeWritten)</unmanaged>
<unmanaged-short>IDirectSoundCaptureBuffer::GetFormat</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferBase.GetCaptureStatus(SharpDX.DirectSound.CaptureBufferStatusFlags@)">
<summary>
The GetStatus method retrieves the status of the capture buffer.
</summary>
<param name="tatusRef"><dd> Address of a variable that receives the status of the capture buffer. The status can be set to one or more of the following:<table> <tr><td>Value</td><td>Description</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureBufferStatusFlags.Capturing" /></td><td>The buffer is capturing audio data.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureBufferStatusFlags.Looping" /></td><td>The buffer is looping.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureBuffer::GetStatus']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturebuffer8.idirectsoundcapturebuffer8.getstatus</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureBuffer::GetStatus([Out] DSCBSTATUS_FLAGS* pdwStatus)</unmanaged>
<unmanaged-short>IDirectSoundCaptureBuffer::GetStatus</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferBase.Lock(System.Int32,System.Int32,System.IntPtr@,System.Int32@,System.IntPtr@,System.Int32@,System.Int32)">
<summary>
The Lock method locks a portion of the buffer. Locking the buffer returns references into the buffer, allowing the application to read or write audio data into memory.
</summary>
<param name="offset"><dd> Offset, in bytes, from the start of the buffer to the point where the lock begins. </dd></param>
<param name="bytes"><dd> Size, in bytes, of the portion of the buffer to lock. Because the buffer is conceptually circular, this number can exceed the number of bytes between dwOffset and the end of the buffer. </dd></param>
<param name="dioPtr1Out"><dd> Address of a variable that receives a reference to the first locked part of the buffer. </dd></param>
<param name="udioBytes1Ref"><dd> Address of a variable that receives the number of bytes in the block at ppvAudioPtr1. If this value is less than dwBytes, the lock has wrapped and ppvAudioPtr2 points to a second block of data at the beginning of the buffer. </dd></param>
<param name="dioPtr2Out"><dd> Address of a variable that receives a reference to the second locked part of the capture buffer. If <c>null</c> is returned, the ppvAudioPtr1 parameter points to the entire locked portion of the capture buffer. </dd></param>
<param name="udioBytes2Ref"><dd> Address of a variable that receives the number of bytes in the block at ppvAudioPtr2. If ppvAudioPtr2 is <c>null</c>, this value is zero. </dd></param>
<param name="flags"><dd> Flags modifying the lock event. This value can be zero or the following flag:<table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DSCBLOCK_ENTIREBUFFER</td><td>Ignore dwBytes and lock the entire capture buffer.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_INVALIDCALL </td></tr> </table></returns>
<remarks>
<p>This method accepts an offset and a byte count, and returns two read references and their associated sizes. If the locked portion does not extend to the end of the buffer and wrap to the beginning, the second reference, ppvAudioBytes2, receives <c>null</c>. If the lock does wrap, ppvAudioBytes2 points to the beginning of the buffer.</p> <p>If the application passes <c>null</c> for the ppvAudioPtr2 and pdwAudioBytes2 parameters, the lock extends no further than the end of the buffer and does not wrap.</p> <p>The application should read data from the references returned by this method and then immediately call Unlock. The sound buffer should not remain locked while it is running; if it does, the capture cursor will reach the locked bytes and audio problems may result.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureBuffer::Lock']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturebuffer8.idirectsoundcapturebuffer8.lock</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureBuffer::Lock([In] unsigned int dwOffset,[In] unsigned int dwBytes,[Out] void** ppvAudioPtr1,[Out] unsigned int* pdwAudioBytes1,[Out] void** ppvAudioPtr2,[Out, Optional] unsigned int* pdwAudioBytes2,[In] unsigned int dwFlags)</unmanaged>
<unmanaged-short>IDirectSoundCaptureBuffer::Lock</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferBase.Start(SharpDX.Mathematics.Interop.RawBool)">
<summary>
The Start method begins capturing data into the buffer. If the buffer is already capturing, the method has no effect.
</summary>
<param name="flags"><dd> Flags that specify the behavior of the buffer when capturing sound data. The following flag is defined: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DSCBSTART_LOOPING</td><td>After the end of the buffer is reached, capture restarts at the beginning and continues until explicitly stopped.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values: </p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_NODRIVER </td></tr> <tr><td>DSERR_OUTOFMEMORY </td></tr> </table></returns>
<remarks>
<p>If the buffer is already capturing, a call to this method using a different value in dwFlags might not change the value returned by GetStatus.</p> <p>If the application is multithreaded, the thread that starts the buffer must continue to exist as long as the buffer is capturing. Buffers created on WDM drivers stop capturing when the thread is terminated.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureBuffer::Start']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturebuffer8.idirectsoundcapturebuffer8.start</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureBuffer::Start([In] BOOL dwFlags)</unmanaged>
<unmanaged-short>IDirectSoundCaptureBuffer::Start</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferBase.Stop">
<summary>
The Stop method stops the buffer so that it is no longer capturing data. If the buffer is not capturing, the method has no effect.
</summary>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values: </p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureBuffer::Stop']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturebuffer8.idirectsoundcapturebuffer8.stop</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureBuffer::Stop()</unmanaged>
<unmanaged-short>IDirectSoundCaptureBuffer::Stop</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferBase.Unlock(System.IntPtr,System.Int32,System.IntPtr,System.Int32)">
<summary>
The Unlock method unlocks the buffer.
</summary>
<param name="vAudioPtr1Ref"><dd> Address of the value retrieved in the ppvAudioPtr1 parameter of the Lock method. </dd></param>
<param name="audioBytes1"><dd> Number of bytes read from the pvAudioPtr1 parameter. See Remarks. </dd></param>
<param name="vAudioPtr2Ref"><dd> Address of the value retrieved in the ppvAudioPtr2 parameter of the IDirectSoundCaptureBuffer8::Lock method. </dd></param>
<param name="audioBytes2"><dd> Number of bytes read from the pvAudioPtr2 parameter. See Remarks. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_INVALIDCALL </td></tr> </table></returns>
<remarks>
<p>An application must pass both references, pvAudioPtr1 and pvAudioPtr2, returned by the IDirectSoundCaptureBuffer8::Lock method to ensure the correct pairing of IDirectSoundCaptureBuffer8::Lock and IDirectSoundCaptureBuffer8::Unlock. The second reference is needed even if zero bytes were written to the second reference.</p> <p>The values in dwAudioBytes1 and dwAudioBytes2 must specify the number of bytes actually read from each part of the buffer, which might be less than the size of the lock. DirectSound uses these values to determine how much data to transfer from the device.</p> <p>Make sure that the capture buffer does not remain locked for long periods of time.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureBuffer::Unlock']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturebuffer8.idirectsoundcapturebuffer8.unlock</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureBuffer::Unlock([In, Buffer] void* pvAudioPtr1,[In] unsigned int dwAudioBytes1,[In, Buffer, Optional] void* pvAudioPtr2,[In] unsigned int dwAudioBytes2)</unmanaged>
<unmanaged-short>IDirectSoundCaptureBuffer::Unlock</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.CaptureBufferCapabilities">
<summary>
The <see cref="T:SharpDX.DirectSound.CaptureBufferCapabilities" /> structure describes the capabilities of a capture buffer. It is used by theIDirectSoundCaptureBuffer8::GetCapsmethod.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBCAPS']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscbcaps</msdn-id>
<unmanaged>DSCBCAPS</unmanaged>
<unmanaged-short>DSCBCAPS</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferCapabilities.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.CaptureBufferCapabilities"/> class.
</summary>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferCapabilities.Size">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBCAPS::dwSize']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscbcaps</msdn-id>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferCapabilities.Flags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBCAPS::dwFlags']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscbcaps</msdn-id>
<unmanaged>DSCBCAPS_FLAGS dwFlags</unmanaged>
<unmanaged-short>DSCBCAPS_FLAGS dwFlags</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferCapabilities.BufferBytes">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBCAPS::dwBufferBytes']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscbcaps</msdn-id>
<unmanaged>unsigned int dwBufferBytes</unmanaged>
<unmanaged-short>unsigned int dwBufferBytes</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferCapabilities.Reserved">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBCAPS::dwReserved']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscbcaps</msdn-id>
<unmanaged>unsigned int dwReserved</unmanaged>
<unmanaged-short>unsigned int dwReserved</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.CaptureBufferDescription">
<summary>
The <see cref="T:SharpDX.DirectSound.CaptureBufferDescription" /> structure describes a capture buffer. It is used by theIDirectSoundCapture8::CreateCaptureBuffermethod and by theDirectSoundFullDuplexCreate8function.<p>An earlier version of this structure, DSCBUFFERDESC1, is maintained in Dsound.h for compatibility with DirectX 7 and earlier.</p>
</summary>
<remarks>
<p>The <see cref="F:SharpDX.DirectSound.CaptureBufferCapabilitiesFlags.ControlEffects" /> flag is supported only on buffers created by an object of class CLSID_DirectSoundCapture8. If the IDirectSoundCapture8 interface was obtained from the DirectSoundCaptureCreate8 function, this flag is supported; if it was obtained from the earlier DirectSoundCaptureCreate function, it is not supported.</p> <p>Capture effects require Microsoft Windows XP.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBUFFERDESC']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscbufferdesc</msdn-id>
<unmanaged>DSCBUFFERDESC</unmanaged>
<unmanaged-short>DSCBUFFERDESC</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.CaptureBufferDescription.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.CaptureBufferDescription"/> class.
</summary>
</member>
<member name="P:SharpDX.DirectSound.CaptureBufferDescription.WaveMapped">
<summary>
Gets a value indicating whether [wave mapped].
</summary>
<value><c>true</c> if [wave mapped]; otherwise, <c>false</c>.</value>
</member>
<member name="P:SharpDX.DirectSound.CaptureBufferDescription.ControlEffects">
<summary>
Gets a value indicating whether [control effects].
</summary>
<value><c>true</c> if [control effects]; otherwise, <c>false</c>.</value>
</member>
<member name="P:SharpDX.DirectSound.CaptureBufferDescription.Format">
<summary>
Gets or sets the format.
</summary>
<value>The format.</value>
</member>
<member name="P:SharpDX.DirectSound.CaptureBufferDescription.EffectDescriptions">
<summary>
Describes effects supported by hardware for the buffer.
</summary>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferDescription.Size">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBUFFERDESC::dwSize']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscbufferdesc</msdn-id>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferDescription.Flags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBUFFERDESC::dwFlags']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscbufferdesc</msdn-id>
<unmanaged>DSCBCAPS_FLAGS dwFlags</unmanaged>
<unmanaged-short>DSCBCAPS_FLAGS dwFlags</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferDescription.BufferBytes">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBUFFERDESC::dwBufferBytes']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscbufferdesc</msdn-id>
<unmanaged>unsigned int dwBufferBytes</unmanaged>
<unmanaged-short>unsigned int dwBufferBytes</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferDescription.Reserved">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBUFFERDESC::dwReserved']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscbufferdesc</msdn-id>
<unmanaged>unsigned int dwReserved</unmanaged>
<unmanaged-short>unsigned int dwReserved</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferDescription.FormatPointer">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBUFFERDESC::lpwfxFormat']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscbufferdesc</msdn-id>
<unmanaged>WAVEFORMATEX* lpwfxFormat</unmanaged>
<unmanaged-short>WAVEFORMATEX lpwfxFormat</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferDescription.EffectCount">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBUFFERDESC::dwFXCount']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscbufferdesc</msdn-id>
<unmanaged>unsigned int dwFXCount</unmanaged>
<unmanaged-short>unsigned int dwFXCount</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferDescription.EffectDescriptionPointer">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBUFFERDESC::lpDSCFXDesc']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscbufferdesc</msdn-id>
<unmanaged>DSCEFFECTDESC* lpDSCFXDesc</unmanaged>
<unmanaged-short>DSCEFFECTDESC lpDSCFXDesc</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.CaptureCapabilities">
<summary>
The <see cref="T:SharpDX.DirectSound.CaptureCapabilities" /> structure describes the capabilities of the capture device. It is used by theIDirectSoundCapture8::GetCapsmethod.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCCAPS']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsccaps</msdn-id>
<unmanaged>DSCCAPS</unmanaged>
<unmanaged-short>DSCCAPS</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.CaptureCapabilities.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.CaptureCapabilities"/> class.
</summary>
</member>
<member name="F:SharpDX.DirectSound.CaptureCapabilities.Size">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCCAPS::dwSize']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsccaps</msdn-id>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureCapabilities.Flags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCCAPS::dwFlags']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsccaps</msdn-id>
<unmanaged>unsigned int dwFlags</unmanaged>
<unmanaged-short>unsigned int dwFlags</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureCapabilities.Formats">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCCAPS::dwFormats']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsccaps</msdn-id>
<unmanaged>unsigned int dwFormats</unmanaged>
<unmanaged-short>unsigned int dwFormats</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureCapabilities.Channels">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCCAPS::dwChannels']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsccaps</msdn-id>
<unmanaged>unsigned int dwChannels</unmanaged>
<unmanaged-short>unsigned int dwChannels</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.CaptureEffectDescription">
<summary>
The <see cref="T:SharpDX.DirectSound.CaptureEffectDescription" /> structure contains parameters for an effect associated with a capture buffer.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCEFFECTDESC']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsceffectdesc</msdn-id>
<unmanaged>DSCEFFECTDESC</unmanaged>
<unmanaged-short>DSCEFFECTDESC</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.CaptureEffectDescription.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.CaptureEffectDescription"/> class.
</summary>
</member>
<member name="F:SharpDX.DirectSound.CaptureEffectDescription.Size">
<summary>
<dd> Size of the structure, in bytes. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCEFFECTDESC::dwSize']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsceffectdesc</msdn-id>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureEffectDescription.Flags">
<summary>
<dd> Flags that specify desired parameters of the effect. When this structure is passed to DirectSoundFullDuplexCreate8, or IDirectSoundCapture8::CreateCaptureBuffer, this member must be one of the values shown in the following table.
<table> <tr><th>Value
</th><th>Description
</th></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureEffectResult.LocatedInHardware" />
</td><td>Effect specified by guidDSCFXInstance must be in hardware.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureEffectResult.LocatedInSoftware" />
</td><td>Effect specified by guidDSCFXInstance must be in software.
</td></tr> </table> <p>On return, this member can contain one of the values shown in the following table.</p> <table> <tr><th>Value
</th><th>Description
</th></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureEffectResult.LocatedInHardware" />
</td><td>Effect was created in hardware.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureEffectResult.LocatedInSoftware" />
</td><td>Effect was created in software.
</td></tr> </table> </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCEFFECTDESC::dwFlags']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsceffectdesc</msdn-id>
<unmanaged>DSCFX_ENUM dwFlags</unmanaged>
<unmanaged-short>DSCFX_ENUM dwFlags</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureEffectDescription.CaptureEffectClass">
<summary>
<dd> Value of type <see cref="T:System.Guid" /> that specifies the class identifier of the effect. The following standard identifiers are defined.
<table> <tr><th>Value
</th><th>Description
</th></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureEffectGuid.AcousticEchoCancellationCaptureEffect" />
</td><td>Acoustic echo cancellation.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureEffectGuid.NoiseSuppressionCaptureEffect" />
</td><td>Noise suppression.
</td></tr> </table> </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCEFFECTDESC::guidDSCFXClass']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsceffectdesc</msdn-id>
<unmanaged>GUID guidDSCFXClass</unmanaged>
<unmanaged-short>GUID guidDSCFXClass</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureEffectDescription.CaptureEffectInstance">
<summary>
<dd> Value of type <see cref="T:System.Guid" /> that specifies the unique identifier of the preferred effect. The following standard identifiers are defined.
<table> <tr><th>Value
</th><th>Description
</th></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureEffectGuid.MicrosoftAcousticEchoCancellationCaptureEffect" />
</td><td>Microsoft acoustic echo cancellation. Available in software only.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureEffectGuid.MicrosoftNoiseSuppressionCaptureEffect" />
</td><td>Microsoft noise suppression. Available in software only.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureEffectGuid.SystemAcousticEchoCancellationCaptureEffect" />
</td><td>System default acoustic echo cancellation.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureEffectGuid.SystemNoiseSuppressionCaptureEffect" />
</td><td>System default noise suppression.
</td></tr> </table> </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCEFFECTDESC::guidDSCFXInstance']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsceffectdesc</msdn-id>
<unmanaged>GUID guidDSCFXInstance</unmanaged>
<unmanaged-short>GUID guidDSCFXInstance</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureEffectDescription.Reserved1">
<summary>
<dd> Reserved. Must be zero. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCEFFECTDESC::dwReserved1']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsceffectdesc</msdn-id>
<unmanaged>unsigned int dwReserved1</unmanaged>
<unmanaged-short>unsigned int dwReserved1</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureEffectDescription.Reserved2">
<summary>
<dd> Reserved. Must be zero. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCEFFECTDESC::dwReserved2']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsceffectdesc</msdn-id>
<unmanaged>unsigned int dwReserved2</unmanaged>
<unmanaged-short>unsigned int dwReserved2</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.Chorus">
<summary>
<p>The IDirectSoundFXChorus8 interface is used to set and retrieve effect parameters on a buffer that supports chorus.</p><p>This interface is obtained by calling GetObjectInPath on the buffer that supports the effect.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSoundFXChorus8 interface exposes the following methods.</p>IDirectSoundFXChorus8 Members<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundFXChorus8::GetAllParameters </td><td>The GetAllParameters method retrieves the chorus parameters of a buffer.
</td></tr> <tr><td>IDirectSoundFXChorus8::SetAllParameters </td><td>The SetAllParameters method sets the chorus parameters of a buffer.
</td></tr> </table>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXChorus']/*" />
<msdn-id>ee418208</msdn-id>
<unmanaged>IDirectSoundFXChorus</unmanaged>
<unmanaged-short>IDirectSoundFXChorus</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Chorus.DelayDefault">
<summary>
Default number of milliseconds the input is delayed before it is played back. The default value is 50.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.DelayMax">
<summary>
Maximum number of milliseconds the input is delayed before it is played back.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.DelayMin">
<summary>
Minimum number of milliseconds the input is delayed before it is played back.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.DepthDefault">
<summary>
Default percentage by which the delay time is modulated by the low-frequency oscillator, in hundredths of a percentage point. The default value is 10.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.DepthMax">
<summary>
Maximum percentage by which the delay time is modulated by the low-frequency oscillator, in hundredths of a percentage point.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.DepthMin">
<summary>
Minimum percentage by which the delay time is modulated by the low-frequency oscillator, in hundredths of a percentage point.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.FeedbackDefault">
<summary>
Default percentage of output signal to feed back into the effect's input. The default value is 25.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.FeedbackMax">
<summary>
Maximum percentage of output signal to feed back into the effect's input.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.FeedbackMin">
<summary>
Minimum percentage of output signal to feed back into the effect's input.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.FrequencyDefault">
<summary>
Default frequency of the LFO. The default value is 1.1.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.FrequencyMax">
<summary>
Maximum frequency of the LFO.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.FrequencyMin">
<summary>
Minimum frequency of the LFO.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.Phase180">
<summary>
Positive 180 phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.Phase90">
<summary>
Positive 90 phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.PhaseDefault">
<summary>
Default phase differential between left and right LFOs. The default value is Phase90.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.PhaseMax">
<summary>
Maximum phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.PhaseMin">
<summary>
Minimum phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.PhaseNegative180">
<summary>
Negative 180 phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.PhaseNegative90">
<summary>
Negative 90 phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.PhaseZero">
<summary>
Zero phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.WaveformDefault">
<summary>
Default waveform shape of the LFO. By default, the waveform is a sine.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.WaveformSin">
<summary>
Sine waveform shape of the LFO.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.WaveformTriangle">
<summary>
Triangle waveform shape of the LFO.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.WetDryMixDefault">
<summary>
Default ratio of wet (processed) signal to dry (unprocessed) signal.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.WetDryMixMax">
<summary>
Maximum ratio of wet (processed) signal to dry (unprocessed) signal.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Chorus.WetDryMixMin">
<summary>
Minimum ratio of wet (processed) signal to dry (unprocessed) signal.
</summary>
</member>
<member name="M:SharpDX.DirectSound.Chorus.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.Chorus"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.Chorus.op_Explicit(System.IntPtr)~SharpDX.DirectSound.Chorus">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.Chorus"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.Chorus.AllParameters">
<summary>
The GetAllParameters method retrieves the chorus parameters of a buffer.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXChorus::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxchorus8.idirectsoundfxchorus8.getallparameters</msdn-id>
<unmanaged>GetAllParameters / SetAllParameters</unmanaged>
<unmanaged-short>GetAllParameters</unmanaged-short>
<unmanaged>HRESULT IDirectSoundFXChorus::GetAllParameters([Out] DSFXChorus* pDsFxChorus)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.Chorus.SetAllParameters(SharpDX.DirectSound.ChorusSettings@)">
<summary>
The SetAllParameters method sets the chorus parameters of a buffer.
</summary>
<param name="cDsFxChorusRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.ChorusSettings" /> structure that specifies the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXChorus::SetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxchorus8.idirectsoundfxchorus8.setallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXChorus::SetAllParameters([In] const DSFXChorus* pcDsFxChorus)</unmanaged>
<unmanaged-short>IDirectSoundFXChorus::SetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.Chorus.GetAllParameters(SharpDX.DirectSound.ChorusSettings@)">
<summary>
The GetAllParameters method retrieves the chorus parameters of a buffer.
</summary>
<param name="dsFxChorusRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.ChorusSettings" /> structure that receives the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXChorus::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxchorus8.idirectsoundfxchorus8.getallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXChorus::GetAllParameters([Out] DSFXChorus* pDsFxChorus)</unmanaged>
<unmanaged-short>IDirectSoundFXChorus::GetAllParameters</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.Compressor">
<summary>
<p>The IDirectSoundFXCompressor8 interface is used to set and retrieve effect parameters on a buffer that supports compression.</p><p>This interface is obtained by calling GetObjectInPath on the buffer that supports the effect.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSoundFXCompressor8 interface exposes the following methods.</p>IDirectSoundFXCompressor8 Members<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundFXCompressor8::GetAllParameters </td><td>The GetAllParameters method retrieves the compression parameters of a buffer.
</td></tr> <tr><td>IDirectSoundFXCompressor8::SetAllParameters </td><td>The SetAllParameters method sets the compression parameters of a buffer.
</td></tr> </table>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXCompressor']/*" />
<msdn-id>ee418215</msdn-id>
<unmanaged>IDirectSoundFXCompressor</unmanaged>
<unmanaged-short>IDirectSoundFXCompressor</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Compressor.AttackDefault">
<summary>
Default time before compression reaches its full value, in decibels (dB). The default value is 10 ms.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.AttackMax">
<summary>
Maximum time before compression reaches its full value, in decibels (dB).
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.AttackMin">
<summary>
Minimum time before compression reaches its full value, in decibels (dB).
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.GainDefault">
<summary>
Default output gain of signal after compression, in decibels (dB). The default value is 0 dB.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.GainMax">
<summary>
Maximum output gain of signal after compression, in decibels (dB).
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.GainMin">
<summary>
Minimum output gain of signal after compression, in decibels (dB).
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.PreDelayDefault">
<summary>
Default time after threshold is reached before attack phase is started, in milliseconds. The default value is 4 ms.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.PreDelayMax">
<summary>
Maximum time after threshold is reached before attack phase is started, in milliseconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.PreDelayMin">
<summary>
Minimum time after threshold is reached before attack phase is started, in milliseconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.RatioDefault">
<summary>
Default compression ratio. The default value is 3, which means 3:1 compression.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.RatioMax">
<summary>
Maximum compression ratio.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.RatioMin">
<summary>
Minimum compression ratio.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.ReleaseDefault">
<summary>
Default speed at which compression is stopped after input drops below Threshold, in milliseconds. The default value is 200 ms.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.ReleaseMax">
<summary>
Maximum speed at which compression is stopped after input drops below Threshold, in milliseconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.ReleaseMin">
<summary>
Minimum speed at which compression is stopped after input drops below Threshold, in milliseconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.ThresholdDefault">
<summary>
Default point at which compression begins, in decibels, in decibels (dB). The default value is -20 dB.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.ThresholdMax">
<summary>
Maximum point at which compression begins, in decibels, in decibels (dB).
</summary>
</member>
<member name="F:SharpDX.DirectSound.Compressor.ThresholdMin">
<summary>
Minimum point at which compression begins, in decibels, in decibels (dB).
</summary>
</member>
<member name="M:SharpDX.DirectSound.Compressor.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.Compressor"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.Compressor.op_Explicit(System.IntPtr)~SharpDX.DirectSound.Compressor">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.Compressor"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.Compressor.AllParameters">
<summary>
The GetAllParameters method retrieves the compression parameters of a buffer.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXCompressor::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxcompressor8.idirectsoundfxcompressor8.getallparameters</msdn-id>
<unmanaged>GetAllParameters / SetAllParameters</unmanaged>
<unmanaged-short>GetAllParameters</unmanaged-short>
<unmanaged>HRESULT IDirectSoundFXCompressor::GetAllParameters([Out] DSFXCompressor* pDsFxCompressor)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.Compressor.SetAllParameters(SharpDX.DirectSound.CompressorSettings@)">
<summary>
The SetAllParameters method sets the compression parameters of a buffer.
</summary>
<param name="cDsFxCompressorRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.CompressorSettings" /> structure that specifies the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXCompressor::SetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxcompressor8.idirectsoundfxcompressor8.setallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXCompressor::SetAllParameters([In] const DSFXCompressor* pcDsFxCompressor)</unmanaged>
<unmanaged-short>IDirectSoundFXCompressor::SetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.Compressor.GetAllParameters(SharpDX.DirectSound.CompressorSettings@)">
<summary>
The GetAllParameters method retrieves the compression parameters of a buffer.
</summary>
<param name="dsFxCompressorRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.CompressorSettings" /> structure that receives the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXCompressor::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxcompressor8.idirectsoundfxcompressor8.getallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXCompressor::GetAllParameters([Out] DSFXCompressor* pDsFxCompressor)</unmanaged>
<unmanaged-short>IDirectSoundFXCompressor::GetAllParameters</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.DeviceInformation">
<summary>
Contains information about a DirectSound device.
</summary>
</member>
<member name="M:SharpDX.DirectSound.DeviceInformation.#ctor(System.Guid,System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.DeviceInformation"/> class.
</summary>
<param name="driverGuid">The driver GUID.</param>
<param name="description">The description.</param>
<param name="moduleName">Name of the module.</param>
</member>
<member name="P:SharpDX.DirectSound.DeviceInformation.DriverGuid">
<summary>
Identifies the DirectSound driver being enumerated
</summary>
</member>
<member name="P:SharpDX.DirectSound.DeviceInformation.Description">
<summary>
String that provides a textual description of the DirectSound device.
</summary>
</member>
<member name="P:SharpDX.DirectSound.DeviceInformation.ModuleName">
<summary>
String that specifies the module name of the DirectSound driver corresponding to this device.
</summary>
</member>
<member name="T:SharpDX.DirectSound.DirectSound">
<summary>
<p>The <see cref="T:SharpDX.DirectSound.DirectSound" /> interface is used to create buffer objects, manage devices, and set up the environment. This interface supersedes <see cref="T:SharpDX.DirectSound.DirectSoundBase" /> and adds new methods.</p><p>Obtain this interface by using the DirectSoundCreate8 or DirectSoundFullDuplexCreate8 function, or by using CoCreateInstance or CoCreateInstanceEx to create an object of class CLSID_DirectSound8.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the <see cref="T:SharpDX.DirectSound.DirectSound" /> interface exposes the following methods.</p>IDirectSound8 Members<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSound8::Compact </td><td>The Compact method has no effect.
</td></tr> <tr><td>IDirectSound8::CreateSoundBuffer </td><td>The CreateSoundBuffer method creates a sound buffer object to manage audio samples.
</td></tr> <tr><td>IDirectSound8::DuplicateSoundBuffer </td><td>The DuplicateSoundBuffer method creates a new secondary buffer that shares the original buffer's memory.
</td></tr> <tr><td>IDirectSound8::GetCaps </td><td>The GetCaps method retrieves the capabilities of the hardware device that is represented by the device object.
</td></tr> <tr><td>IDirectSound8::GetSpeakerConfig </td><td>The GetSpeakerConfig method retrieves the speaker configuration.
</td></tr> <tr><td>IDirectSound8::Initialize </td><td>The Initialize method initializes a device object that was created by using the CoCreateInstance function.
</td></tr> <tr><td>IDirectSound8::SetCooperativeLevel </td><td>The SetCooperativeLevel method sets the cooperative level of the application for this sound device.
</td></tr> <tr><td>IDirectSound8::SetSpeakerConfig </td><td>The SetSpeakerConfig method specifies the speaker configuration of the device.
</td></tr> <tr><td><see cref="M:SharpDX.DirectSound.DirectSound.VerifyCertification(System.Int32@)" /> </td><td>The VerifyCertification method ascertains whether the device driver is certified for DirectX.
</td></tr> </table><p>The LPDIRECTSOUND8 type is defined as a reference to the <see cref="T:SharpDX.DirectSound.DirectSound" /> interface:</p><pre> typedef struct <see cref="T:SharpDX.DirectSound.DirectSound" /> *LPDIRECTSOUND8;
</pre>
</summary>
<remarks>
<p>Only objects of class CLSID_DirectSound8 support this interface. All device objects created by DirectSoundCreate8 and DirectSoundFullDuplexCreate8 fall into this category. Objects of class CLSID_DirectSound, which include all those created by using the earlier DirectSoundCreate function, support only the earlier <see cref="T:SharpDX.DirectSound.DirectSoundBase" /> interface.</p> <p>The behavior of CLSID_DirectSound8 objects is somewhat different from that of CLSID_DirectSound objects. These differences are found in the <see cref="T:SharpDX.DirectSound.DirectSoundBase" /> interface as well as the <see cref="T:SharpDX.DirectSound.DirectSound" /> interface. Specific differences in the behavior of the newer object include the following:</p> <ul> <li><p>In calls to <see cref="M:SharpDX.DirectSound.DirectSoundBase.CreateSoundBuffer(SharpDX.DirectSound.SoundBufferDescription,System.IntPtr@,SharpDX.ComObject)" /> and CreateSoundBuffer, <see cref="F:SharpDX.DirectSound.BufferFlags.Control3D" /> cannot be set on a buffer with a non-mono format, and <see cref="F:SharpDX.DirectSound.BufferFlags.Control3D" /> cannot be combined with <see cref="F:SharpDX.DirectSound.BufferFlags.ControlPan" />.</p></li> <li><p>New buffer creation flags are supported.</p></li> <li><p>Buffers are not filled with silence on creation.</p></li> <li><p>The <see cref="T:SharpDX.DirectSound.SoundBuffer" /> interface returned by CreateSoundBuffer can be queried for the <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> interface.</p></li> <li><p>WAV formats in the <see cref="T:SharpDX.DirectSound.SoundBufferDescription" /> structure that have the <see cref="F:SharpDX.Multimedia.WaveFormatEncoding.Extensible" /> format tag are checked more strictly for validity.</p></li> </ul>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound8']/*" />
<msdn-id>ee418035</msdn-id>
<unmanaged>IDirectSound8</unmanaged>
<unmanaged-short>IDirectSound8</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DirectSound.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.DirectSound"/> class.
</summary>
</member>
<member name="M:SharpDX.DirectSound.DirectSound.#ctor(System.Guid)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.DirectSound"/> class.
</summary>
<param name="driverGuid">The driver GUID.</param>
</member>
<member name="P:SharpDX.DirectSound.DirectSound.IsCertified">
<summary>
Verifies the certification.
</summary>
<returns>Return true if the driver is certified</returns>
</member>
<member name="M:SharpDX.DirectSound.DirectSound.GetSpeakerConfiguration(SharpDX.DirectSound.SpeakerConfiguration@,SharpDX.DirectSound.SpeakerGeometry@)">
<summary>
Retrieves the speaker configuration of the device.
</summary>
<param name="speakerSet" />
<param name="geometry" />
</member>
<member name="M:SharpDX.DirectSound.DirectSound.SetSpeakerConfiguration(SharpDX.DirectSound.SpeakerConfiguration,SharpDX.DirectSound.SpeakerGeometry)">
<summary>
Sets the speaker configuration of the device.
</summary>
<param name="speakerSet" />
<param name="geometry" />
</member>
<member name="M:SharpDX.DirectSound.DirectSound.GetDevices">
<summary>
Enumerates the DirectSound devices installed in the system.
</summary>
<returns>A collection of the devices found.</returns>
</member>
<member name="M:SharpDX.DirectSound.DirectSound.DuplicateSoundBuffer(SharpDX.DirectSound.SoundBuffer)">
<summary>
Duplicates the sound buffer.
</summary>
<param name="sourceBuffer">The source buffer.</param>
<returns>A duplicate of this soundBuffer.</returns>
<unmanaged>HRESULT IDirectSound::DuplicateSoundBuffer([In] IDirectSoundBuffer* pDSBufferOriginal,[Out] void** ppDSBufferDuplicate)</unmanaged>
<unmanaged-short>IDirectSound::DuplicateSoundBuffer</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DirectSound.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.DirectSound"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.DirectSound.op_Explicit(System.IntPtr)~SharpDX.DirectSound.DirectSound">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.DirectSound"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="M:SharpDX.DirectSound.DirectSound.VerifyCertification(System.Int32@)">
<summary>
The VerifyCertification method ascertains whether the device driver is certified for DirectX.
</summary>
<param name="ertifiedRef"><dd> Address of a DWORD variable that receives one of the values shown in the following table.<table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS_CERTIFIED</td><td>Driver is certified for DirectSound.</td></tr> <tr><td>DS_UNCERTIFIED</td><td>Driver is not certified for DirectSound.</td></tr> </table> </dd></param>
<returns><p>If the function succeeds, the return value is DS_OK.</p> <p>If the function fails, the return value may be one of the error values shown in the following table.</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_UNSUPPORTED </td></tr> </table></returns>
<remarks>
<p>This method may attempt to retrieve certification information from the Internet.</p> <p>On emulated devices, the method returns DSERR_UNSUPPORTED. Emulated devices are identified by the <see cref="F:SharpDX.DirectSound.CapabilitiesFlags.EmulatedDriver" /> flag in the dwFlags member of <see cref="T:SharpDX.DirectSound.Capabilities" />.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound8::VerifyCertification']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound8.idirectsound8.verifycertification</msdn-id>
<unmanaged>HRESULT IDirectSound8::VerifyCertification([Out] unsigned int* pdwCertified)</unmanaged>
<unmanaged-short>IDirectSound8::VerifyCertification</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.DirectSoundCapture">
<summary>
<p>The IDirectSoundCapture8 interface is used to create sound capture buffers.</p><p>The interface is obtained by using the DirectSoundCaptureCreate8 or DirectSoundFullDuplexCreate8 functions, or by using CoCreateInstance or CoCreateInstanceEx to create an object of class CLSID_DirectSoundCapture8.</p><p>IDirectSoundCapture8 is a define for <see cref="T:SharpDX.DirectSound.DirectSoundCapture" />. The two interface names are interchangeable. However, objects supporting this interface can have different functionality, depending on their class. For more information, see DirectSoundCaptureCreate8 and IDirectSoundCapture8::CreateCaptureBuffer.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSoundCapture8 interface exposes the following methods.</p>IDirectSoundCapture8 Members<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundCapture8::CreateCaptureBuffer </td><td>The CreateCaptureBuffer method creates a buffer for capturing waveform audio.
</td></tr> <tr><td>IDirectSoundCapture8::GetCaps </td><td>The GetCaps method retrieves the capabilities of the capture device.
</td></tr> <tr><td>IDirectSoundCapture8::Initialize </td><td>The Initialize method initializes a capture device object created by using CoCreateInstance. Calling this method is not required when the DirectSoundCaptureCreate8 or DirectSoundFullDuplexCreate8 function is used to create the object.
</td></tr> </table><p>The LPDIRECTSOUNDCAPTURE type is defined as a reference to the <see cref="T:SharpDX.DirectSound.DirectSoundCapture" /> interface:</p><pre> typedef struct <see cref="T:SharpDX.DirectSound.DirectSoundCapture" /> *LPDIRECTSOUNDCAPTURE;
</pre>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCapture']/*" />
<msdn-id>ee418154</msdn-id>
<unmanaged>IDirectSoundCapture</unmanaged>
<unmanaged-short>IDirectSoundCapture</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundCapture.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.DirectSoundCapture" /> class.
</summary>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundCapture.#ctor(System.Guid)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.DirectSoundCapture" /> class.
</summary>
<param name="device" />
<returns />
</member>
<member name="M:SharpDX.DirectSound.DirectSoundCapture.GetDevices">
<summary>
Enumerates the DirectSoundCapture devices installed in the system.
</summary>
<returns>A collection of the devices found.</returns>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundCapture.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.DirectSoundCapture"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundCapture.op_Explicit(System.IntPtr)~SharpDX.DirectSound.DirectSoundCapture">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.DirectSoundCapture"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.DirectSoundCapture.Capabilities">
<summary>
The GetCaps method retrieves the capabilities of the capture device.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCapture::GetCaps']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapture8.idirectsoundcapture8.getcaps</msdn-id>
<unmanaged>GetCaps</unmanaged>
<unmanaged-short>GetCaps</unmanaged-short>
<unmanaged>HRESULT IDirectSoundCapture::GetCaps([Out] DSCCAPS* pDSCCaps)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundCapture.CreateCaptureBuffer(SharpDX.DirectSound.CaptureBufferDescription,SharpDX.DirectSound.CaptureBufferBase@,SharpDX.ComObject)">
<summary>
The CreateCaptureBuffer method creates a buffer for capturing waveform audio.
</summary>
<param name="cDSCBufferDescRef"><dd> Pointer to a <see cref="T:SharpDX.DirectSound.CaptureBufferDescription" /> structure containing values for the capture buffer being created. </dd></param>
<param name="dSCBufferOut"><dd> Address of a variable that receives an <see cref="T:SharpDX.DirectSound.CaptureBufferBase" /> interface reference. Use QueryInterface to obtain <see cref="T:SharpDX.DirectSound.CaptureBuffer" />. See Remarks. </dd></param>
<param name="unkOuterRef"><dd> Address of the controlling object's <see cref="T:SharpDX.ComObject" /> interface for COM aggregation. Must be <c>null</c>. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values.</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_BADFORMAT </td></tr> <tr><td>DSERR_GENERIC </td></tr> <tr><td>DSERR_NODRIVER </td></tr> <tr><td>DSERR_OUTOFMEMORY </td></tr> <tr><td>DSERR_UNINITIALIZED </td></tr> </table></returns>
<remarks>
<p>On Microsoft Windows98 and Windows2000, each capture device supports a single buffer.</p> <p>The <see cref="T:SharpDX.DirectSound.CaptureBuffer" /> interface is supported only on buffers created by an object of class CLSID_DirectSoundCapture8. If the IDirectSoundCapture8 interface was obtained from DirectSoundCaptureCreate8, <see cref="T:SharpDX.DirectSound.CaptureBuffer" /> is supported. If IDirectSoundCapture8 was obtained from the earlier DirectSoundCaptureCreate function, only <see cref="T:SharpDX.DirectSound.CaptureBufferBase" /> is supported.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCapture::CreateCaptureBuffer']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapture8.idirectsoundcapture8.createcapturebuffer</msdn-id>
<unmanaged>HRESULT IDirectSoundCapture::CreateCaptureBuffer([In] const DSCBUFFERDESC* pcDSCBufferDesc,[Out] IDirectSoundCaptureBuffer** ppDSCBuffer,[In] IUnknown* pUnkOuter)</unmanaged>
<unmanaged-short>IDirectSoundCapture::CreateCaptureBuffer</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundCapture.GetCapabilities(SharpDX.DirectSound.CaptureCapabilities@)">
<summary>
The GetCaps method retrieves the capabilities of the capture device.
</summary>
<param name="dSCCapsRef"><dd> Pointer to a <see cref="T:SharpDX.DirectSound.CaptureCapabilities" /> structure to be receive information about the capture device. When the method is called, the dwSize member must specify the size of the structure in bytes. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values: </p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_UNSUPPORTED </td></tr> <tr><td>DSERR_NODRIVER </td></tr> <tr><td>DSERR_OUTOFMEMORY </td></tr> <tr><td>DSERR_UNINITIALIZED </td></tr> </table></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCapture::GetCaps']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapture8.idirectsoundcapture8.getcaps</msdn-id>
<unmanaged>HRESULT IDirectSoundCapture::GetCaps([Out] DSCCAPS* pDSCCaps)</unmanaged>
<unmanaged-short>IDirectSoundCapture::GetCaps</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.Distortion">
<summary>
<p>The IDirectSoundFXDistortion8 interface is used to set and retrieve effect parameters on a buffer that supports distortion.</p><p>This interface is obtained by calling GetObjectInPath on the buffer that supports the effect.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSoundFXDistortion8 interface exposes the following methods.</p>IDirectSoundFXDistortion8 Members<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundFXDistortion8::GetAllParameters </td><td>The GetAllParameters method retrieves the distortion parameters of a buffer.
</td></tr> <tr><td>IDirectSoundFXDistortion8::SetAllParameters </td><td>The SetAllParameters method sets the distortion parameters of a buffer.
</td></tr> </table>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXDistortion']/*" />
<msdn-id>ee418218</msdn-id>
<unmanaged>IDirectSoundFXDistortion</unmanaged>
<unmanaged-short>IDirectSoundFXDistortion</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Distortion.EdgeDefault">
<summary>
Default percentage of distortion intensity.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Distortion.EdgeMax">
<summary>
Maximum percentage of distortion intensity.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Distortion.EdgeMin">
<summary>
Minimum percentage of distortion intensity.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Distortion.GainDefault">
<summary>
Default amount of signal change after distortion.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Distortion.GainMax">
<summary>
Maximum amount of signal change after distortion.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Distortion.GainMin">
<summary>
Minimum amount of signal change after distortion.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Distortion.PostEQBandwidthDefault">
<summary>
Default width of frequency band that determines range of harmonic content addition.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Distortion.PostEQBandwidthMax">
<summary>
Maximum width of frequency band that determines range of harmonic content addition.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Distortion.PostEQBandwidthMin">
<summary>
Minimum width of frequency band that determines range of harmonic content addition.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Distortion.PostEQCenterFrequencyDefault">
<summary>
Default center frequency of harmonic content addition.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Distortion.PostEQCenterFrequencyMax">
<summary>
Maximum center frequency of harmonic content addition.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Distortion.PostEQCenterFrequencyMin">
<summary>
Minimum center frequency of harmonic content addition.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Distortion.PreLowPassCutoffDefault">
<summary>
Default filter cutoff for high-frequency harmonics attenuation.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Distortion.PreLowPassCutoffMax">
<summary>
Maximum filter cutoff for high-frequency harmonics attenuation.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Distortion.PreLowPassCutoffMin">
<summary>
Minimum filter cutoff for high-frequency harmonics attenuation.
</summary>
</member>
<member name="M:SharpDX.DirectSound.Distortion.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.Distortion"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.Distortion.op_Explicit(System.IntPtr)~SharpDX.DirectSound.Distortion">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.Distortion"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.Distortion.AllParameters">
<summary>
The GetAllParameters method retrieves the distortion parameters of a buffer.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXDistortion::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxdistortion8.idirectsoundfxdistortion8.getallparameters</msdn-id>
<unmanaged>GetAllParameters / SetAllParameters</unmanaged>
<unmanaged-short>GetAllParameters</unmanaged-short>
<unmanaged>HRESULT IDirectSoundFXDistortion::GetAllParameters([Out] DSFXDistortion* pDsFxDistortion)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.Distortion.SetAllParameters(SharpDX.DirectSound.DistortionSettings@)">
<summary>
The SetAllParameters method sets the distortion parameters of a buffer.
</summary>
<param name="cDsFxDistortionRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.DistortionSettings" /> structure that specifies the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK or S_FALSE. See the Remarks for <see cref="T:SharpDX.DirectSound.DistortionSettings" />. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXDistortion::SetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxdistortion8.idirectsoundfxdistortion8.setallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXDistortion::SetAllParameters([In] const DSFXDistortion* pcDsFxDistortion)</unmanaged>
<unmanaged-short>IDirectSoundFXDistortion::SetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.Distortion.GetAllParameters(SharpDX.DirectSound.DistortionSettings@)">
<summary>
The GetAllParameters method retrieves the distortion parameters of a buffer.
</summary>
<param name="dsFxDistortionRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.DistortionSettings" /> structure that receives the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXDistortion::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxdistortion8.idirectsoundfxdistortion8.getallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXDistortion::GetAllParameters([Out] DSFXDistortion* pDsFxDistortion)</unmanaged>
<unmanaged-short>IDirectSoundFXDistortion::GetAllParameters</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.Echo">
<summary>
<p>The IDirectSoundFXEcho8 interface is used to set and retrieve effect parameters on a buffer that supports echo.</p><p>This interface is obtained by calling GetObjectInPath on the buffer that supports the effect.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSoundFXEcho8 interface exposes the following methods.</p>IDirectSoundFXEcho8 Members<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundFXEcho8::GetAllParameters </td><td>The GetAllParameters method retrieves the echo parameters of a buffer.
</td></tr> <tr><td>IDirectSoundFXEcho8::SetAllParameters </td><td>The SetAllParameters method sets the echo parameters of a buffer.
</td></tr> </table>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXEcho']/*" />
<msdn-id>ee418221</msdn-id>
<unmanaged>IDirectSoundFXEcho</unmanaged>
<unmanaged-short>IDirectSoundFXEcho</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Echo.FeedbackDefault">
<summary>
Default percentage of output fed back into input.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Echo.FeedbackMax">
<summary>
Maximum percentage of output fed back into input.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Echo.FeedbackMin">
<summary>
Minimum percentage of output fed back into input.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Echo.LeftDelayDefault">
<summary>
Default delay for left channel, in milliseconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Echo.LeftDelayMax">
<summary>
Maximum delay for left channel, in milliseconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Echo.LeftDelayMin">
<summary>
Minimum delay for left channel, in milliseconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Echo.PanDelayDefault">
<summary>
Default value that specifies whether to swap left and right delays with each successive echo. The default value is zero, meaning no swap.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Echo.PanDelayMax">
<summary>
Maximum value that specifies whether to swap left and right delays with each successive echo. The default value is zero, meaning no swap.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Echo.PanDelayMin">
<summary>
Minimum value that specifies whether to swap left and right delays with each successive echo. The default value is zero, meaning no swap.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Echo.RightDelayDefault">
<summary>
Default delay for right channel, in milliseconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Echo.RightDelayMax">
<summary>
Maximum delay for right channel, in milliseconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Echo.RightDelayMin">
<summary>
Minimum delay for right channel, in milliseconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Echo.WetDryMixDefault">
<summary>
Default ratio of wet (processed) signal to dry (unprocessed) signal.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Echo.WetDryMixMax">
<summary>
Maximum ratio of wet (processed) signal to dry (unprocessed) signal.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Echo.WetDryMixMin">
<summary>
Minimum ratio of wet (processed) signal to dry (unprocessed) signal.
</summary>
</member>
<member name="M:SharpDX.DirectSound.Echo.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.Echo"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.Echo.op_Explicit(System.IntPtr)~SharpDX.DirectSound.Echo">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.Echo"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.Echo.AllParameters">
<summary>
The GetAllParameters method retrieves the echo parameters of a buffer.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXEcho::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxecho8.idirectsoundfxecho8.getallparameters</msdn-id>
<unmanaged>GetAllParameters / SetAllParameters</unmanaged>
<unmanaged-short>GetAllParameters</unmanaged-short>
<unmanaged>HRESULT IDirectSoundFXEcho::GetAllParameters([Out] DSFXEcho* pDsFxEcho)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.Echo.SetAllParameters(SharpDX.DirectSound.EchoSettings@)">
<summary>
The SetAllParameters method sets the echo parameters of a buffer.
</summary>
<param name="cDsFxEchoRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.EchoSettings" /> structure that specifies the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXEcho::SetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxecho8.idirectsoundfxecho8.setallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXEcho::SetAllParameters([In] const DSFXEcho* pcDsFxEcho)</unmanaged>
<unmanaged-short>IDirectSoundFXEcho::SetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.Echo.GetAllParameters(SharpDX.DirectSound.EchoSettings@)">
<summary>
The GetAllParameters method retrieves the echo parameters of a buffer.
</summary>
<param name="dsFxEchoRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.EchoSettings" /> structure that receives the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXEcho::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxecho8.idirectsoundfxecho8.getallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXEcho::GetAllParameters([Out] DSFXEcho* pDsFxEcho)</unmanaged>
<unmanaged-short>IDirectSoundFXEcho::GetAllParameters</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.EnumDelegateCallback">
<summary>
Enumerator callback for DirectSound and DirectCaptureSound.
</summary>
</member>
<member name="M:SharpDX.DirectSound.EnumDelegateCallback.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.EnumDelegateCallback"/> class.
</summary>
</member>
<member name="P:SharpDX.DirectSound.EnumDelegateCallback.NativePointer">
<summary>
Natives the pointer.
</summary>
<returns></returns>
</member>
<member name="P:SharpDX.DirectSound.EnumDelegateCallback.Informations">
<summary>
Gets or sets the device informations.
</summary>
<value>The device informations.</value>
</member>
<member name="T:SharpDX.DirectSound.Flanger">
<summary>
<p>The IDirectSoundFXFlanger8 interface is used to set and retrieve effect parameters on a buffer that supports flange.</p><p>This interface is obtained by calling GetObjectInPath on the buffer that supports the effect.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSoundFXFlanger8 interface exposes the following methods.</p>IDirectSoundFXFlanger8 Members<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundFXFlanger8::GetAllParameters </td><td>The GetAllParameters method retrieves the flange parameters of a buffer.
</td></tr> <tr><td>IDirectSoundFXFlanger8::SetAllParameters </td><td>The SetAllParameters method sets the flange parameters of a buffer.
</td></tr> </table>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXFlanger']/*" />
<msdn-id>ee418225</msdn-id>
<unmanaged>IDirectSoundFXFlanger</unmanaged>
<unmanaged-short>IDirectSoundFXFlanger</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Flanger.DelayDefault">
<summary>
Default number of milliseconds the input is delayed before it is played back.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.DelayMax">
<summary>
Maximum number of milliseconds the input is delayed before it is played back.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.DelayMin">
<summary>
Minimum number of milliseconds the input is delayed before it is played back.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.DepthDefault">
<summary>
Default percentage by which the delay time is modulated by the low-frequency oscillator (LFO), in hundredths of a percentage point.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.DepthMax">
<summary>
Maximum percentage by which the delay time is modulated by the low-frequency oscillator (LFO), in hundredths of a percentage point.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.DepthMin">
<summary>
Minimum percentage by which the delay time is modulated by the low-frequency oscillator (LFO), in hundredths of a percentage point.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.FeedbackDefault">
<summary>
Default percentage of output signal to feed back into the effect's input.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.FeedbackMax">
<summary>
Maximum percentage of output signal to feed back into the effect's input.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.FeedbackMin">
<summary>
Minimum percentage of output signal to feed back into the effect's input.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.FrequencyDefault">
<summary>
Default frequency of the LFO(low-frequency oscillator).
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.FrequencyMax">
<summary>
Maximum frequency of the LFO(low-frequency oscillator).
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.FrequencyMin">
<summary>
Minimum frequency of the LFO(low-frequency oscillator).
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.Phase180">
<summary>
Positive 180 phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.Phase90">
<summary>
Positive 90 phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.PhaseDefault">
<summary>
Default phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.PhaseMax">
<summary>
Maximum phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.PhaseMin">
<summary>
Minimum phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.PhaseNegative180">
<summary>
Negative 180 phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.PhaseNegative90">
<summary>
Negative 90 phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.PhaseZero">
<summary>
Zero phase differential between left and right LFOs.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.WaveformDefault">
<summary>
Default waveform shape of the LFO. By default, the waveform is a sine.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.WaveformSin">
<summary>
Sine waveform shape of the LFO. By default, the waveform is a sine.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.WaveformTriangle">
<summary>
Triangular waveform shape of the LFO. By default, the waveform is a sine.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.WetDryMixDefault">
<summary>
Default ratio of wet (processed) signal to dry (unprocessed) signal.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.WetDryMixMax">
<summary>
Maximum ratio of wet (processed) signal to dry (unprocessed) signal.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Flanger.WetDryMixMin">
<summary>
Minimum ratio of wet (processed) signal to dry (unprocessed) signal.
</summary>
</member>
<member name="M:SharpDX.DirectSound.Flanger.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.Flanger"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.Flanger.op_Explicit(System.IntPtr)~SharpDX.DirectSound.Flanger">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.Flanger"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.Flanger.AllParameters">
<summary>
The GetAllParameters method retrieves the flange parameters of a buffer.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXFlanger::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxflanger8.idirectsoundfxflanger8.getallparameters</msdn-id>
<unmanaged>GetAllParameters / SetAllParameters</unmanaged>
<unmanaged-short>GetAllParameters</unmanaged-short>
<unmanaged>HRESULT IDirectSoundFXFlanger::GetAllParameters([Out] DSFXFlanger* pDsFxFlanger)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.Flanger.SetAllParameters(SharpDX.DirectSound.FlangerSettings@)">
<summary>
The SetAllParameters method sets the flange parameters of a buffer.
</summary>
<param name="cDsFxFlangerRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.FlangerSettings" /> structure that specifies the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXFlanger::SetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxflanger8.idirectsoundfxflanger8.setallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXFlanger::SetAllParameters([In] const DSFXFlanger* pcDsFxFlanger)</unmanaged>
<unmanaged-short>IDirectSoundFXFlanger::SetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.Flanger.GetAllParameters(SharpDX.DirectSound.FlangerSettings@)">
<summary>
The GetAllParameters method retrieves the flange parameters of a buffer.
</summary>
<param name="dsFxFlangerRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.FlangerSettings" /> structure that receives the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXFlanger::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxflanger8.idirectsoundfxflanger8.getallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXFlanger::GetAllParameters([Out] DSFXFlanger* pDsFxFlanger)</unmanaged>
<unmanaged-short>IDirectSoundFXFlanger::GetAllParameters</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.FullDuplex">
<summary>
<p>The IDirectSoundFullDuplex8 interface represents a full-duplex stream.</p><p>The interface is obtained by using the DirectSoundFullDuplexCreate8 function. This function initializes DirectSound capture and playback.</p><p>The interface can also be obtained by using CoCreateInstance or CoCreateInstanceEx to create an object of class CLSID_DirectSoundFullDuplex8.</p><p>IDirectSoundFullDuplex8 is a define for <see cref="T:SharpDX.DirectSound.FullDuplex" />. The interface names are interchangeable.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSoundFullDuplex8 interface exposes the following method.</p>IDirectSoundFullDuplex8 Members<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundFullDuplex8::Initialize </td><td>The Initialize method initializes a full duplex object that was created by using CoCreateInstance.
</td></tr> </table><p>The LPDIRECTSOUNDFULLDUPLEX type is defined as a reference to <see cref="T:SharpDX.DirectSound.FullDuplex" />.</p><pre> typedef struct <see cref="T:SharpDX.DirectSound.FullDuplex" /> *LPDIRECTSOUNDFULLDUPLEX;
</pre>Info<p>Operating System: Requires Microsoft Windows XP or later.</p> <table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFullDuplex']/*" />
<msdn-id>ee418204</msdn-id>
<unmanaged>IDirectSoundFullDuplex</unmanaged>
<unmanaged-short>IDirectSoundFullDuplex</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.FullDuplex.#ctor(System.Guid,System.Guid,SharpDX.DirectSound.CaptureBufferDescription,SharpDX.DirectSound.SoundBufferDescription,System.IntPtr,SharpDX.DirectSound.CooperativeLevel,SharpDX.DirectSound.CaptureBuffer@,SharpDX.DirectSound.SecondarySoundBuffer@)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.FullDuplex" /> class.
</summary>
<param name="captureDevice" />
<param name="playbackDevice" />
<param name="captureDescription" />
<param name="bufferDescription" />
<param name="windowHandle" />
<param name="level" />
<param name="captureBuffer" />
<param name="secondaryBuffer" />
</member>
<member name="M:SharpDX.DirectSound.FullDuplex.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.FullDuplex"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.FullDuplex.op_Explicit(System.IntPtr)~SharpDX.DirectSound.FullDuplex">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.FullDuplex"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="T:SharpDX.DirectSound.Gargle">
<summary>
<p>The IDirectSoundFXGargle8 interface is used to set and retrieve effect parameters on a buffer that supports amplitude modulation.</p><p>This interface is obtained by calling GetObjectInPath on the buffer that supports the effect.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSoundFXGargle8 interface exposes the following methods.</p>IDirectSoundFXGargle8 Members<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundFXGargle8::GetAllParameters </td><td>The GetAllParameters method retrieves the amplitude modulation parameters of a buffer.
</td></tr> <tr><td>IDirectSoundFXGargle8::SetAllParameters </td><td>The SetAllParameters method sets the amplitude modulation parameters of a buffer.
</td></tr> </table>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXGargle']/*" />
<msdn-id>ee418228</msdn-id>
<unmanaged>IDirectSoundFXGargle</unmanaged>
<unmanaged-short>IDirectSoundFXGargle</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Gargle.RateDefault">
<summary>
Default rate of modulation, in Hertz.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Gargle.RateMax">
<summary>
Maximum rate of modulation, in Hertz.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Gargle.RateMin">
<summary>
Minimum rate of modulation, in Hertz.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Gargle.WaveShapeDefault">
<summary>
Default shape of the modulation waveform.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Gargle.WaveShapeSquare">
<summary>
Square shape of the modulation waveform.
</summary>
</member>
<member name="F:SharpDX.DirectSound.Gargle.WaveShapeTriangle">
<summary>
Triangular shape of the modulation waveform.
</summary>
</member>
<member name="M:SharpDX.DirectSound.Gargle.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.Gargle"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.Gargle.op_Explicit(System.IntPtr)~SharpDX.DirectSound.Gargle">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.Gargle"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.Gargle.AllParameters">
<summary>
The GetAllParameters method retrieves the amplitude modulation parameters of a buffer.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXGargle::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxgargle8.idirectsoundfxgargle8.getallparameters</msdn-id>
<unmanaged>GetAllParameters / SetAllParameters</unmanaged>
<unmanaged-short>GetAllParameters</unmanaged-short>
<unmanaged>HRESULT IDirectSoundFXGargle::GetAllParameters([Out] DSFXGargle* pDsFxGargle)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.Gargle.SetAllParameters(SharpDX.DirectSound.GargleSettings)">
<summary>
The SetAllParameters method sets the amplitude modulation parameters of a buffer.
</summary>
<param name="cDsFxGargleRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.GargleSettings" /> structure that specifies the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value can be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXGargle::SetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxgargle8.idirectsoundfxgargle8.setallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXGargle::SetAllParameters([In] const DSFXGargle* pcDsFxGargle)</unmanaged>
<unmanaged-short>IDirectSoundFXGargle::SetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.Gargle.GetAllParameters(SharpDX.DirectSound.GargleSettings@)">
<summary>
The GetAllParameters method retrieves the amplitude modulation parameters of a buffer.
</summary>
<param name="dsFxGargleRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.GargleSettings" /> structure that receives the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value can be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXGargle::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxgargle8.idirectsoundfxgargle8.getallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXGargle::GetAllParameters([Out] DSFXGargle* pDsFxGargle)</unmanaged>
<unmanaged-short>IDirectSoundFXGargle::GetAllParameters</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.AcousticEchoCancelMode">
<summary>
The <see cref="T:SharpDX.DirectSound.AcousticEchoCancelSettings" /> structure contains parameters for acoustic echo cancellation in a capture buffer.
</summary>
<remarks>
<p>The dwMode member is ignored when this structure is passed to IDirectSoundCaptureFXAec8::SetAllParameters.</p> <table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFX_AEC_MODE']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscfxaec</msdn-id>
<unmanaged>DSCFX_AEC_MODE</unmanaged>
<unmanaged-short>DSCFX_AEC_MODE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.AcousticEchoCancelMode.PassThrough">
<summary>
<dd> Boolean value that specifies whether the effect is enabled. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFX_AEC_MODE_PASS_THROUGH']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscfxaec</msdn-id>
<unmanaged>DSCFX_AEC_MODE_PASS_THROUGH</unmanaged>
<unmanaged-short>DSCFX_AEC_MODE_PASS_THROUGH</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.AcousticEchoCancelMode.HalfDuplex">
<summary>
<dd> Boolean value that specifies whether to enable background comfort noise, which makes the capture signal sound more natural by preventing periods of dead silence. By default, background comfort noise is not enabled. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFX_AEC_MODE_HALF_DUPLEX']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscfxaec</msdn-id>
<unmanaged>DSCFX_AEC_MODE_HALF_DUPLEX</unmanaged>
<unmanaged-short>DSCFX_AEC_MODE_HALF_DUPLEX</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.AcousticEchoCancelMode.FullDuplex">
<summary>
<dd> Operation mode. This member contains one of the following values. <table> <tr><th>Value
</th><th>Description
</th></tr> <tr><td><see cref="F:SharpDX.DirectSound.AcousticEchoCancelMode.PassThrough" />
</td><td>The effect is passing capture and render data through without modifying it.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.AcousticEchoCancelMode.HalfDuplex" />
</td><td>The effect is running in half duplex mode. Not presently supported.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.AcousticEchoCancelMode.FullDuplex" />
</td><td>The effect is running in full duplex mode.
</td></tr> </table> </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFX_AEC_MODE_FULL_DUPLEX']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscfxaec</msdn-id>
<unmanaged>DSCFX_AEC_MODE_FULL_DUPLEX</unmanaged>
<unmanaged-short>DSCFX_AEC_MODE_FULL_DUPLEX</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.AcousticEchoCancelStatus">
<summary>
<p>The KSPROPERTY_AEC_STATUS property is used to monitor the status of an AEC node (<strong>KSNODETYPE_ACOUSTIC_ECHO_CANCEL</strong>). This is an optional property of an AEC node.</p>
</summary>
<remarks>
<p>The three least significant bits in the AEC status flags (see preceding table) represent the convergence history (CH) of the AEC algorithm. The CH status bits can be used by a Microsoft DirectSound application to determine whether the algorithm has converged and also whether it has remained in the converged state since the time that it started processing data. Depending on the audio hardware, the AEC algorithm might fail to converge, in which case the resulting capture buffer is likely to include the echo from the speakers. </p><p>When the filter containing the AEC node is created or the node is reset, the AEC algorithm initially sets the three CH status bits to zero. This setting represents the uninitialized state, AEC_STATUS_FD_HISTORY_UNINITIALIZED.</p><p>After the AEC algorithm converges, the CH status switches to the converged state, AEC_STATUS_FD_HISTORY_CONTINUOUSLY_CONVERGED. If the AEC algorithm ever loses convergence, the CH status switches to the diverged state, AEC_STATUS_FD_HISTORY_PREVIOUSLY_DIVERGED. Although the status is most likely to switch to the diverged state from the converged state, it might also switch directly from the uninitialized state to the diverged state. After the CH status has switched to the diverged state, it will remain in that state until the algorithm is reset or starvation is detected.</p><p>When the AEC system filter detects starvation at any of its four pins--capture in, capture out, render in, or render out--it resets its internal state, including the convergence history. </p><p>Note that bit 2 of the three CH status bits is not currently used.</p><p>As an alternative to using the CH status bits, the application can monitor the real-time convergence status by checking the AEC_STATUS_FD_CURRENTLY_CONVERGED flag bit. If this bit is set, the algorithm is currently converged. The algorithm can lose convergence temporarily when changes occur in the acoustic path. The real-time convergence flag is filtered to prevent such momentary losses from inappropriately switching the CH status bits to the DSCFX_AEC_STATUS_FD_HISTORY_PREVIOUSLY_DIVERGED state.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFX_AEC_STATUS']/*" />
<msdn-id>ff537230</msdn-id>
<unmanaged>DSCFX_AEC_STATUS</unmanaged>
<unmanaged-short>DSCFX_AEC_STATUS</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryUninitialized">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFX_AEC_STATUS_HISTORY_UNINITIALIZED']/*" />
<msdn-id>ff537230</msdn-id>
<unmanaged>DSCFX_AEC_STATUS_HISTORY_UNINITIALIZED</unmanaged>
<unmanaged-short>DSCFX_AEC_STATUS_HISTORY_UNINITIALIZED</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryContinuouslyConverged">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFX_AEC_STATUS_HISTORY_CONTINUOUSLY_CONVERGED']/*" />
<msdn-id>ff537230</msdn-id>
<unmanaged>DSCFX_AEC_STATUS_HISTORY_CONTINUOUSLY_CONVERGED</unmanaged>
<unmanaged-short>DSCFX_AEC_STATUS_HISTORY_CONTINUOUSLY_CONVERGED</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryPreviouslyDiverged">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFX_AEC_STATUS_HISTORY_PREVIOUSLY_DIVERGED']/*" />
<msdn-id>ff537230</msdn-id>
<unmanaged>DSCFX_AEC_STATUS_HISTORY_PREVIOUSLY_DIVERGED</unmanaged>
<unmanaged-short>DSCFX_AEC_STATUS_HISTORY_PREVIOUSLY_DIVERGED</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.AcousticEchoCancelStatus.CurrentlyConverged">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFX_AEC_STATUS_CURRENTLY_CONVERGED']/*" />
<msdn-id>ff537230</msdn-id>
<unmanaged>DSCFX_AEC_STATUS_CURRENTLY_CONVERGED</unmanaged>
<unmanaged-short>DSCFX_AEC_STATUS_CURRENTLY_CONVERGED</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.BufferFlags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_FLAGS']/*" />
<unmanaged>DSBCAPS_FLAGS</unmanaged>
<unmanaged-short>DSBCAPS_FLAGS</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.PrimaryBuffer">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_PRIMARYBUFFER']/*" />
<unmanaged>DSBCAPS_PRIMARYBUFFER</unmanaged>
<unmanaged-short>DSBCAPS_PRIMARYBUFFER</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.Static">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_STATIC']/*" />
<unmanaged>DSBCAPS_STATIC</unmanaged>
<unmanaged-short>DSBCAPS_STATIC</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.Hardware">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_LOCHARDWARE']/*" />
<unmanaged>DSBCAPS_LOCHARDWARE</unmanaged>
<unmanaged-short>DSBCAPS_LOCHARDWARE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.Software">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_LOCSOFTWARE']/*" />
<unmanaged>DSBCAPS_LOCSOFTWARE</unmanaged>
<unmanaged-short>DSBCAPS_LOCSOFTWARE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.Control3D">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_CTRL3D']/*" />
<unmanaged>DSBCAPS_CTRL3D</unmanaged>
<unmanaged-short>DSBCAPS_CTRL3D</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.ControlFrequency">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_CTRLFREQUENCY']/*" />
<unmanaged>DSBCAPS_CTRLFREQUENCY</unmanaged>
<unmanaged-short>DSBCAPS_CTRLFREQUENCY</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.ControlPan">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_CTRLPAN']/*" />
<unmanaged>DSBCAPS_CTRLPAN</unmanaged>
<unmanaged-short>DSBCAPS_CTRLPAN</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.ControlVolume">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_CTRLVOLUME']/*" />
<unmanaged>DSBCAPS_CTRLVOLUME</unmanaged>
<unmanaged-short>DSBCAPS_CTRLVOLUME</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.ControlPositionNotify">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_CTRLPOSITIONNOTIFY']/*" />
<unmanaged>DSBCAPS_CTRLPOSITIONNOTIFY</unmanaged>
<unmanaged-short>DSBCAPS_CTRLPOSITIONNOTIFY</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.ControlEffects">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_CTRLFX']/*" />
<unmanaged>DSBCAPS_CTRLFX</unmanaged>
<unmanaged-short>DSBCAPS_CTRLFX</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.StickyFocus">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_STICKYFOCUS']/*" />
<unmanaged>DSBCAPS_STICKYFOCUS</unmanaged>
<unmanaged-short>DSBCAPS_STICKYFOCUS</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.GlobalFocus">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_GLOBALFOCUS']/*" />
<unmanaged>DSBCAPS_GLOBALFOCUS</unmanaged>
<unmanaged-short>DSBCAPS_GLOBALFOCUS</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.GetCurrentPosition2">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_GETCURRENTPOSITION2']/*" />
<unmanaged>DSBCAPS_GETCURRENTPOSITION2</unmanaged>
<unmanaged-short>DSBCAPS_GETCURRENTPOSITION2</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.Mute3DAtMaxDistance">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_MUTE3DATMAXDISTANCE']/*" />
<unmanaged>DSBCAPS_MUTE3DATMAXDISTANCE</unmanaged>
<unmanaged-short>DSBCAPS_MUTE3DATMAXDISTANCE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.Defer">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_LOCDEFER']/*" />
<unmanaged>DSBCAPS_LOCDEFER</unmanaged>
<unmanaged-short>DSBCAPS_LOCDEFER</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.Trueplayposition">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS_TRUEPLAYPOSITION']/*" />
<unmanaged>DSBCAPS_TRUEPLAYPOSITION</unmanaged>
<unmanaged-short>DSBCAPS_TRUEPLAYPOSITION</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferFlags.None">
<summary>
None.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='']/*" />
<unmanaged>None</unmanaged>
<unmanaged-short>None</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.BufferStatus">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBSTATUS_FLAGS']/*" />
<unmanaged>DSBSTATUS_FLAGS</unmanaged>
<unmanaged-short>DSBSTATUS_FLAGS</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferStatus.Playing">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBSTATUS_PLAYING']/*" />
<unmanaged>DSBSTATUS_PLAYING</unmanaged>
<unmanaged-short>DSBSTATUS_PLAYING</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferStatus.BufferLost">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBSTATUS_BUFFERLOST']/*" />
<unmanaged>DSBSTATUS_BUFFERLOST</unmanaged>
<unmanaged-short>DSBSTATUS_BUFFERLOST</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferStatus.Looping">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBSTATUS_LOOPING']/*" />
<unmanaged>DSBSTATUS_LOOPING</unmanaged>
<unmanaged-short>DSBSTATUS_LOOPING</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferStatus.Hardware">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBSTATUS_LOCHARDWARE']/*" />
<unmanaged>DSBSTATUS_LOCHARDWARE</unmanaged>
<unmanaged-short>DSBSTATUS_LOCHARDWARE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferStatus.Software">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBSTATUS_LOCSOFTWARE']/*" />
<unmanaged>DSBSTATUS_LOCSOFTWARE</unmanaged>
<unmanaged-short>DSBSTATUS_LOCSOFTWARE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferStatus.Terminated">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBSTATUS_TERMINATED']/*" />
<unmanaged>DSBSTATUS_TERMINATED</unmanaged>
<unmanaged-short>DSBSTATUS_TERMINATED</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferStatus.None">
<summary>
None.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='']/*" />
<unmanaged>None</unmanaged>
<unmanaged-short>None</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.CapabilitiesFlags">
<summary>
The <see cref="T:SharpDX.DirectSound.Capabilities" /> structure describes the capabilities of a device. It is used by theIDirectSound8::GetCapsmethod.
</summary>
<remarks>
<p>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.</p> <p>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.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS_FLAGS']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>DSCAPS_FLAGS</unmanaged>
<unmanaged-short>DSCAPS_FLAGS</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CapabilitiesFlags.PrimaryBufferMono">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS_PRIMARYMONO']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>DSCAPS_PRIMARYMONO</unmanaged>
<unmanaged-short>DSCAPS_PRIMARYMONO</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CapabilitiesFlags.PrimaryBufferStereo">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS_PRIMARYSTEREO']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>DSCAPS_PRIMARYSTEREO</unmanaged>
<unmanaged-short>DSCAPS_PRIMARYSTEREO</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CapabilitiesFlags.PrimaryBuffer8Bit">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS_PRIMARY8BIT']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>DSCAPS_PRIMARY8BIT</unmanaged>
<unmanaged-short>DSCAPS_PRIMARY8BIT</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CapabilitiesFlags.PrimaryBuffer16Bit">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS_PRIMARY16BIT']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>DSCAPS_PRIMARY16BIT</unmanaged>
<unmanaged-short>DSCAPS_PRIMARY16BIT</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CapabilitiesFlags.ContinousRate">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS_CONTINUOUSRATE']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>DSCAPS_CONTINUOUSRATE</unmanaged>
<unmanaged-short>DSCAPS_CONTINUOUSRATE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CapabilitiesFlags.EmulatedDriver">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS_EMULDRIVER']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>DSCAPS_EMULDRIVER</unmanaged>
<unmanaged-short>DSCAPS_EMULDRIVER</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CapabilitiesFlags.Certified">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS_CERTIFIED']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>DSCAPS_CERTIFIED</unmanaged>
<unmanaged-short>DSCAPS_CERTIFIED</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CapabilitiesFlags.SecondaryBufferMono">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS_SECONDARYMONO']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>DSCAPS_SECONDARYMONO</unmanaged>
<unmanaged-short>DSCAPS_SECONDARYMONO</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CapabilitiesFlags.SecondaryBufferStereo">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS_SECONDARYSTEREO']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>DSCAPS_SECONDARYSTEREO</unmanaged>
<unmanaged-short>DSCAPS_SECONDARYSTEREO</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CapabilitiesFlags.SecondaryBufer8Bit">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS_SECONDARY8BIT']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>DSCAPS_SECONDARY8BIT</unmanaged>
<unmanaged-short>DSCAPS_SECONDARY8BIT</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CapabilitiesFlags.SecondaryBufer16Bit">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCAPS_SECONDARY16BIT']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscaps</msdn-id>
<unmanaged>DSCAPS_SECONDARY16BIT</unmanaged>
<unmanaged-short>DSCAPS_SECONDARY16BIT</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CapabilitiesFlags.None">
<summary>
None.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='']/*" />
<unmanaged>None</unmanaged>
<unmanaged-short>None</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.CaptureBufferCapabilitiesFlags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBCAPS_FLAGS']/*" />
<unmanaged>DSCBCAPS_FLAGS</unmanaged>
<unmanaged-short>DSCBCAPS_FLAGS</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferCapabilitiesFlags.WaveMapped">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBCAPS_WAVEMAPPED']/*" />
<unmanaged>DSCBCAPS_WAVEMAPPED</unmanaged>
<unmanaged-short>DSCBCAPS_WAVEMAPPED</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferCapabilitiesFlags.ControlEffects">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBCAPS_CTRLFX']/*" />
<unmanaged>DSCBCAPS_CTRLFX</unmanaged>
<unmanaged-short>DSCBCAPS_CTRLFX</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferCapabilitiesFlags.None">
<summary>
None.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='']/*" />
<unmanaged>None</unmanaged>
<unmanaged-short>None</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.CaptureBufferStatusFlags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBSTATUS_FLAGS']/*" />
<unmanaged>DSCBSTATUS_FLAGS</unmanaged>
<unmanaged-short>DSCBSTATUS_FLAGS</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferStatusFlags.Capturing">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBSTATUS_CAPTURING']/*" />
<unmanaged>DSCBSTATUS_CAPTURING</unmanaged>
<unmanaged-short>DSCBSTATUS_CAPTURING</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferStatusFlags.Looping">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCBSTATUS_LOOPING']/*" />
<unmanaged>DSCBSTATUS_LOOPING</unmanaged>
<unmanaged-short>DSCBSTATUS_LOOPING</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureBufferStatusFlags.None">
<summary>
None.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='']/*" />
<unmanaged>None</unmanaged>
<unmanaged-short>None</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.CaptureCapabilitiesFlags">
<summary>
The <see cref="T:SharpDX.DirectSound.CaptureCapabilities" /> structure describes the capabilities of the capture device. It is used by theIDirectSoundCapture8::GetCapsmethod.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCCAPS_FLAGS']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsccaps</msdn-id>
<unmanaged>DSCCAPS_FLAGS</unmanaged>
<unmanaged-short>DSCCAPS_FLAGS</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureCapabilitiesFlags.EmulateDriver">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCCAPS_EMULDRIVER']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsccaps</msdn-id>
<unmanaged>DSCCAPS_EMULDRIVER</unmanaged>
<unmanaged-short>DSCCAPS_EMULDRIVER</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureCapabilitiesFlags.Certified">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCCAPS_CERTIFIED']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsccaps</msdn-id>
<unmanaged>DSCCAPS_CERTIFIED</unmanaged>
<unmanaged-short>DSCCAPS_CERTIFIED</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureCapabilitiesFlags.MultipleCapture">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCCAPS_MULTIPLECAPTURE']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsccaps</msdn-id>
<unmanaged>DSCCAPS_MULTIPLECAPTURE</unmanaged>
<unmanaged-short>DSCCAPS_MULTIPLECAPTURE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureCapabilitiesFlags.None">
<summary>
None.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='']/*" />
<unmanaged>None</unmanaged>
<unmanaged-short>None</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.CaptureEffectResult">
<summary>
The <see cref="T:SharpDX.DirectSound.CaptureEffectDescription" /> structure contains parameters for an effect associated with a capture buffer.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFX_ENUM']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsceffectdesc</msdn-id>
<unmanaged>DSCFX_ENUM</unmanaged>
<unmanaged-short>DSCFX_ENUM</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureEffectResult.LocatedInHardware">
<summary>
<dd> Size of the structure, in bytes. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFX_LOCHARDWARE']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsceffectdesc</msdn-id>
<unmanaged>DSCFX_LOCHARDWARE</unmanaged>
<unmanaged-short>DSCFX_LOCHARDWARE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CaptureEffectResult.LocatedInSoftware">
<summary>
<dd> Flags that specify desired parameters of the effect. When this structure is passed to DirectSoundFullDuplexCreate8, or IDirectSoundCapture8::CreateCaptureBuffer, this member must be one of the values shown in the following table.
<table> <tr><th>Value
</th><th>Description
</th></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureEffectResult.LocatedInHardware" />
</td><td>Effect specified by guidDSCFXInstance must be in hardware.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureEffectResult.LocatedInSoftware" />
</td><td>Effect specified by guidDSCFXInstance must be in software.
</td></tr> </table> <p>On return, this member can contain one of the values shown in the following table.</p> <table> <tr><th>Value
</th><th>Description
</th></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureEffectResult.LocatedInHardware" />
</td><td>Effect was created in hardware.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.CaptureEffectResult.LocatedInSoftware" />
</td><td>Effect was created in software.
</td></tr> </table> </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFX_LOCSOFTWARE']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsceffectdesc</msdn-id>
<unmanaged>DSCFX_LOCSOFTWARE</unmanaged>
<unmanaged-short>DSCFX_LOCSOFTWARE</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.CooperativeLevel">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSCL_ENUM']/*" />
<unmanaged>DSSCL_ENUM</unmanaged>
<unmanaged-short>DSSCL_ENUM</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CooperativeLevel.Normal">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSCL_NORMAL']/*" />
<unmanaged>DSSCL_NORMAL</unmanaged>
<unmanaged-short>DSSCL_NORMAL</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CooperativeLevel.Priority">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSCL_PRIORITY']/*" />
<unmanaged>DSSCL_PRIORITY</unmanaged>
<unmanaged-short>DSSCL_PRIORITY</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CooperativeLevel.Exclusive">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSCL_EXCLUSIVE']/*" />
<unmanaged>DSSCL_EXCLUSIVE</unmanaged>
<unmanaged-short>DSSCL_EXCLUSIVE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CooperativeLevel.WritePrimary">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSCL_WRITEPRIMARY']/*" />
<unmanaged>DSSCL_WRITEPRIMARY</unmanaged>
<unmanaged-short>DSSCL_WRITEPRIMARY</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.I3DL2MaterialPreset">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSOUND_ENUM_1']/*" />
<unmanaged>DSOUND_ENUM_1</unmanaged>
<unmanaged-short>DSOUND_ENUM_1</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2MaterialPreset.Present">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXR_PRESENT']/*" />
<unmanaged>DSFXR_PRESENT</unmanaged>
<unmanaged-short>DSFXR_PRESENT</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2MaterialPreset.LocatedInHardware">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXR_LOCHARDWARE']/*" />
<unmanaged>DSFXR_LOCHARDWARE</unmanaged>
<unmanaged-short>DSFXR_LOCHARDWARE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2MaterialPreset.LocatedInSoftware">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXR_LOCSOFTWARE']/*" />
<unmanaged>DSFXR_LOCSOFTWARE</unmanaged>
<unmanaged-short>DSFXR_LOCSOFTWARE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2MaterialPreset.Unallocated">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXR_UNALLOCATED']/*" />
<unmanaged>DSFXR_UNALLOCATED</unmanaged>
<unmanaged-short>DSFXR_UNALLOCATED</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2MaterialPreset.Failed">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXR_FAILED']/*" />
<unmanaged>DSFXR_FAILED</unmanaged>
<unmanaged-short>DSFXR_FAILED</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2MaterialPreset.Unknown">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXR_UNKNOWN']/*" />
<unmanaged>DSFXR_UNKNOWN</unmanaged>
<unmanaged-short>DSFXR_UNKNOWN</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2MaterialPreset.SendLoop">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXR_SENDLOOP']/*" />
<unmanaged>DSFXR_SENDLOOP</unmanaged>
<unmanaged-short>DSFXR_SENDLOOP</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.I3DL2ReverbPreset">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSOUND_ENUM_2']/*" />
<unmanaged>DSOUND_ENUM_2</unmanaged>
<unmanaged-short>DSOUND_ENUM_2</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Default">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_DEFAULT']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_DEFAULT</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_DEFAULT</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Generic">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_GENERIC']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_GENERIC</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_GENERIC</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.PaddedCell">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_PADDEDCELL']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_PADDEDCELL</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_PADDEDCELL</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Room">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_ROOM']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_ROOM</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_ROOM</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Bathroom">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_BATHROOM']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_BATHROOM</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_BATHROOM</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.LivingRoom">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_LIVINGROOM']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_LIVINGROOM</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_LIVINGROOM</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.StoneRoom">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_STONEROOM']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_STONEROOM</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_STONEROOM</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Auditorium">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_AUDITORIUM']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_AUDITORIUM</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_AUDITORIUM</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.ConcertHall">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_CONCERTHALL']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_CONCERTHALL</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_CONCERTHALL</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Cave">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_CAVE']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_CAVE</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_CAVE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Arena">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_ARENA']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_ARENA</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_ARENA</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Hangar">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_HANGAR']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_HANGAR</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_HANGAR</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.CarpetedHallway">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_CARPETEDHALLWAY']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_CARPETEDHALLWAY</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_CARPETEDHALLWAY</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Hallway">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_HALLWAY']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_HALLWAY</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_HALLWAY</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.StoneCorridor">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_STONECORRIDOR']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_STONECORRIDOR</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_STONECORRIDOR</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Alley">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_ALLEY']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_ALLEY</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_ALLEY</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Forest">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_FOREST']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_FOREST</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_FOREST</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.City">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_CITY']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_CITY</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_CITY</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Mountains">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_MOUNTAINS']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_MOUNTAINS</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_MOUNTAINS</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Quarry">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_QUARRY']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_QUARRY</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_QUARRY</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Plain">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_PLAIN']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_PLAIN</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_PLAIN</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.ParkingLot">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_PARKINGLOT']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_PARKINGLOT</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_PARKINGLOT</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.SewerPipe">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_SEWERPIPE']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_SEWERPIPE</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_SEWERPIPE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Underwater">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_UNDERWATER']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_UNDERWATER</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_UNDERWATER</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.SmallRoom">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_SMALLROOM']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_SMALLROOM</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_SMALLROOM</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.MediumRoom">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_MEDIUMROOM']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_MEDIUMROOM</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_MEDIUMROOM</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.LargeRoom">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_LARGEROOM']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_LARGEROOM</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_LARGEROOM</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.MediumHall">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_MEDIUMHALL']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_MEDIUMHALL</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_MEDIUMHALL</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.LargeHall">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_LARGEHALL']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_LARGEHALL</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_LARGEHALL</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbPreset.Plate">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_PLATE']/*" />
<unmanaged>DSFX_I3DL2_ENVIRONMENT_PRESET_PLATE</unmanaged>
<unmanaged-short>DSFX_I3DL2_ENVIRONMENT_PRESET_PLATE</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.LockFlags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBLOCK_ENUM']/*" />
<unmanaged>DSBLOCK_ENUM</unmanaged>
<unmanaged-short>DSBLOCK_ENUM</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.LockFlags.FromWriteCursor">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBLOCK_FROMWRITECURSOR']/*" />
<unmanaged>DSBLOCK_FROMWRITECURSOR</unmanaged>
<unmanaged-short>DSBLOCK_FROMWRITECURSOR</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.LockFlags.EntireBuffer">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBLOCK_ENTIREBUFFER']/*" />
<unmanaged>DSBLOCK_ENTIREBUFFER</unmanaged>
<unmanaged-short>DSBLOCK_ENTIREBUFFER</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.LockFlags.None">
<summary>
None.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='']/*" />
<unmanaged>None</unmanaged>
<unmanaged-short>None</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.Mode3D">
<summary>
The GetMode method retrieves the operation mode for 3D sound processing.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DMODE']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.getmode</msdn-id>
<unmanaged>DS3DMODE</unmanaged>
<unmanaged-short>DS3DMODE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Mode3D.Normal">
<summary>
<dd> Address of a variable that receives the mode setting. This value will be one of those in the following table. <table> <tr><td>Value
</td><td>Description
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.Mode3D.Disable" />
</td><td>Processing of 3D sound is disabled. The sound seems to originate from the center of the listener's head.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.Mode3D.HeadRelative" />
</td><td>Sound parameters (position, velocity, and orientation) are relative to the listener's parameters. In this mode, the absolute parameters of the sound are updated automatically as the listener's parameters change, so that the relative parameters remain constant.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.Mode3D.Normal" />
</td><td>Normal processing. This is the default mode.
</td></tr> </table> </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DMODE_NORMAL']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.getmode</msdn-id>
<unmanaged>DS3DMODE_NORMAL</unmanaged>
<unmanaged-short>DS3DMODE_NORMAL</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Mode3D.HeadRelative">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DMODE_HEADRELATIVE']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.getmode</msdn-id>
<unmanaged>DS3DMODE_HEADRELATIVE</unmanaged>
<unmanaged-short>DS3DMODE_HEADRELATIVE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Mode3D.Disable">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DMODE_DISABLE']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.getmode</msdn-id>
<unmanaged>DS3DMODE_DISABLE</unmanaged>
<unmanaged-short>DS3DMODE_DISABLE</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.PlayFlags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBPLAY_FLAGS']/*" />
<unmanaged>DSBPLAY_FLAGS</unmanaged>
<unmanaged-short>DSBPLAY_FLAGS</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.PlayFlags.Looping">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBPLAY_LOOPING']/*" />
<unmanaged>DSBPLAY_LOOPING</unmanaged>
<unmanaged-short>DSBPLAY_LOOPING</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.PlayFlags.Hardware">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBPLAY_LOCHARDWARE']/*" />
<unmanaged>DSBPLAY_LOCHARDWARE</unmanaged>
<unmanaged-short>DSBPLAY_LOCHARDWARE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.PlayFlags.Software">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBPLAY_LOCSOFTWARE']/*" />
<unmanaged>DSBPLAY_LOCSOFTWARE</unmanaged>
<unmanaged-short>DSBPLAY_LOCSOFTWARE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.PlayFlags.TerminateByTime">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBPLAY_TERMINATEBY_TIME']/*" />
<unmanaged>DSBPLAY_TERMINATEBY_TIME</unmanaged>
<unmanaged-short>DSBPLAY_TERMINATEBY_TIME</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.PlayFlags.TerminateByDistance">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBPLAY_TERMINATEBY_DISTANCE']/*" />
<unmanaged>DSBPLAY_TERMINATEBY_DISTANCE</unmanaged>
<unmanaged-short>DSBPLAY_TERMINATEBY_DISTANCE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.PlayFlags.TerminateByPriority">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBPLAY_TERMINATEBY_PRIORITY']/*" />
<unmanaged>DSBPLAY_TERMINATEBY_PRIORITY</unmanaged>
<unmanaged-short>DSBPLAY_TERMINATEBY_PRIORITY</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.PlayFlags.None">
<summary>
None.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='']/*" />
<unmanaged>None</unmanaged>
<unmanaged-short>None</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.SoundEffectResult">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSOUND_ENUM_0']/*" />
<unmanaged>DSOUND_ENUM_0</unmanaged>
<unmanaged-short>DSOUND_ENUM_0</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectResult.Singlewindow">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_SINGLEWINDOW']/*" />
<unmanaged>DSFX_I3DL2_MATERIAL_PRESET_SINGLEWINDOW</unmanaged>
<unmanaged-short>DSFX_I3DL2_MATERIAL_PRESET_SINGLEWINDOW</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectResult.DoubleWindow">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_DOUBLEWINDOW']/*" />
<unmanaged>DSFX_I3DL2_MATERIAL_PRESET_DOUBLEWINDOW</unmanaged>
<unmanaged-short>DSFX_I3DL2_MATERIAL_PRESET_DOUBLEWINDOW</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectResult.Thindoor">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_THINDOOR']/*" />
<unmanaged>DSFX_I3DL2_MATERIAL_PRESET_THINDOOR</unmanaged>
<unmanaged-short>DSFX_I3DL2_MATERIAL_PRESET_THINDOOR</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectResult.Thickdoor">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_THICKDOOR']/*" />
<unmanaged>DSFX_I3DL2_MATERIAL_PRESET_THICKDOOR</unmanaged>
<unmanaged-short>DSFX_I3DL2_MATERIAL_PRESET_THICKDOOR</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectResult.Woodwall">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_WOODWALL']/*" />
<unmanaged>DSFX_I3DL2_MATERIAL_PRESET_WOODWALL</unmanaged>
<unmanaged-short>DSFX_I3DL2_MATERIAL_PRESET_WOODWALL</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectResult.Brickwall">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_BRICKWALL']/*" />
<unmanaged>DSFX_I3DL2_MATERIAL_PRESET_BRICKWALL</unmanaged>
<unmanaged-short>DSFX_I3DL2_MATERIAL_PRESET_BRICKWALL</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectResult.Stonewall">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_STONEWALL']/*" />
<unmanaged>DSFX_I3DL2_MATERIAL_PRESET_STONEWALL</unmanaged>
<unmanaged-short>DSFX_I3DL2_MATERIAL_PRESET_STONEWALL</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectResult.Curtain">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_CURTAIN']/*" />
<unmanaged>DSFX_I3DL2_MATERIAL_PRESET_CURTAIN</unmanaged>
<unmanaged-short>DSFX_I3DL2_MATERIAL_PRESET_CURTAIN</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.SpeakerConfiguration">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_ENUM']/*" />
<unmanaged>DSSPEAKER_ENUM</unmanaged>
<unmanaged-short>DSSPEAKER_ENUM</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerConfiguration.DirectOut">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_DIRECTOUT']/*" />
<unmanaged>DSSPEAKER_DIRECTOUT</unmanaged>
<unmanaged-short>DSSPEAKER_DIRECTOUT</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerConfiguration.Headphone">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_HEADPHONE']/*" />
<unmanaged>DSSPEAKER_HEADPHONE</unmanaged>
<unmanaged-short>DSSPEAKER_HEADPHONE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerConfiguration.Mono">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_MONO']/*" />
<unmanaged>DSSPEAKER_MONO</unmanaged>
<unmanaged-short>DSSPEAKER_MONO</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerConfiguration.Quadrophonic">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_QUAD']/*" />
<unmanaged>DSSPEAKER_QUAD</unmanaged>
<unmanaged-short>DSSPEAKER_QUAD</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerConfiguration.Stereo">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_STEREO']/*" />
<unmanaged>DSSPEAKER_STEREO</unmanaged>
<unmanaged-short>DSSPEAKER_STEREO</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerConfiguration.Surround">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_SURROUND']/*" />
<unmanaged>DSSPEAKER_SURROUND</unmanaged>
<unmanaged-short>DSSPEAKER_SURROUND</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerConfiguration.FivePointOne">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_5POINT1']/*" />
<unmanaged>DSSPEAKER_5POINT1</unmanaged>
<unmanaged-short>DSSPEAKER_5POINT1</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerConfiguration.SevenPointOne">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_7POINT1']/*" />
<unmanaged>DSSPEAKER_7POINT1</unmanaged>
<unmanaged-short>DSSPEAKER_7POINT1</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerConfiguration.SevenPointOneSurround">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_7POINT1_SURROUND']/*" />
<unmanaged>DSSPEAKER_7POINT1_SURROUND</unmanaged>
<unmanaged-short>DSSPEAKER_7POINT1_SURROUND</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerConfiguration.FivePointOneSurround">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_5POINT1_SURROUND']/*" />
<unmanaged>DSSPEAKER_5POINT1_SURROUND</unmanaged>
<unmanaged-short>DSSPEAKER_5POINT1_SURROUND</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerConfiguration.SevenPointOneWide">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_7POINT1_WIDE']/*" />
<unmanaged>DSSPEAKER_7POINT1_WIDE</unmanaged>
<unmanaged-short>DSSPEAKER_7POINT1_WIDE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerConfiguration.FivePointOneBack">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_5POINT1_BACK']/*" />
<unmanaged>DSSPEAKER_5POINT1_BACK</unmanaged>
<unmanaged-short>DSSPEAKER_5POINT1_BACK</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.SpeakerGeometry">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_GEOMETRY_ENUM']/*" />
<unmanaged>DSSPEAKER_GEOMETRY_ENUM</unmanaged>
<unmanaged-short>DSSPEAKER_GEOMETRY_ENUM</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerGeometry.Minimum">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_GEOMETRY_MIN']/*" />
<unmanaged>DSSPEAKER_GEOMETRY_MIN</unmanaged>
<unmanaged-short>DSSPEAKER_GEOMETRY_MIN</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerGeometry.Narrow">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_GEOMETRY_NARROW']/*" />
<unmanaged>DSSPEAKER_GEOMETRY_NARROW</unmanaged>
<unmanaged-short>DSSPEAKER_GEOMETRY_NARROW</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerGeometry.Wide">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_GEOMETRY_WIDE']/*" />
<unmanaged>DSSPEAKER_GEOMETRY_WIDE</unmanaged>
<unmanaged-short>DSSPEAKER_GEOMETRY_WIDE</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SpeakerGeometry.Maximum">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSSPEAKER_GEOMETRY_MAX']/*" />
<unmanaged>DSSPEAKER_GEOMETRY_MAX</unmanaged>
<unmanaged-short>DSSPEAKER_GEOMETRY_MAX</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.CaptureEffectGuid">
<summary>
Functions
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.DirectSound.CaptureEffectGuid']/*" />
</member>
<member name="F:SharpDX.DirectSound.CaptureEffectGuid.AcousticEchoCancellationCaptureEffect">
<summary>Constant AcousticEchoCancellationCaptureEffect.</summary>
<unmanaged>GUID_DSCFX_CLASS_AEC</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.CaptureEffectGuid.MicrosoftAcousticEchoCancellationCaptureEffect">
<summary>Constant MicrosoftAcousticEchoCancellationCaptureEffect.</summary>
<unmanaged>GUID_DSCFX_MS_AEC</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.CaptureEffectGuid.SystemAcousticEchoCancellationCaptureEffect">
<summary>Constant SystemAcousticEchoCancellationCaptureEffect.</summary>
<unmanaged>GUID_DSCFX_SYSTEM_AEC</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.CaptureEffectGuid.NoiseSuppressionCaptureEffect">
<summary>Constant NoiseSuppressionCaptureEffect.</summary>
<unmanaged>GUID_DSCFX_CLASS_NS</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.CaptureEffectGuid.MicrosoftNoiseSuppressionCaptureEffect">
<summary>Constant MicrosoftNoiseSuppressionCaptureEffect.</summary>
<unmanaged>GUID_DSCFX_MS_NS</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.CaptureEffectGuid.SystemNoiseSuppressionCaptureEffect">
<summary>Constant SystemNoiseSuppressionCaptureEffect.</summary>
<unmanaged>GUID_DSCFX_SYSTEM_NS</unmanaged>
</member>
<member name="T:SharpDX.DirectSound.DirectSound3DAlgorithmGuid">
<summary>
Functions
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.DirectSound.DirectSound3DAlgorithmGuid']/*" />
</member>
<member name="F:SharpDX.DirectSound.DirectSound3DAlgorithmGuid.FullHrt3DAlgorithm">
<summary>Constant FullHrt3DAlgorithm.</summary>
<unmanaged>DS3DALG_HRTF_FULL</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.DirectSound3DAlgorithmGuid.LightHrt3DAlgorithm">
<summary>Constant LightHrt3DAlgorithm.</summary>
<unmanaged>DS3DALG_HRTF_LIGHT</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.DirectSound3DAlgorithmGuid.NoVirtualization3DAlgorithm">
<summary>Constant NoVirtualization3DAlgorithm.</summary>
<unmanaged>DS3DALG_NO_VIRTUALIZATION</unmanaged>
</member>
<member name="T:SharpDX.DirectSound.DSound">
<summary>
Functions
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.DirectSound.DSound']/*" />
</member>
<member name="F:SharpDX.DirectSound.DSound.AllObjects">
<summary>Constant AllObjects.</summary>
<unmanaged>GUID_All_Objects</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.DSound.CaptureCreate8(System.Nullable{System.Guid},SharpDX.DirectSound.DirectSoundCapture,SharpDX.ComObject)">
<summary>
The DirectSoundCaptureCreate8 function creates and initializes an object that supports the IDirectSoundCapture8 interface. Although the older<strong>DirectSoundCaptureCreate</strong>function can also be used to obtain theIDirectSoundCapture8interface, the object created by that function cannot be used to create capture buffers that support theIDirectSoundCaptureBuffer8interface.
</summary>
<param name="cGuidDeviceRef">No documentation.</param>
<param name="dSC8Out">No documentation.</param>
<param name="unkOuterRef">No documentation.</param>
<returns><p>If the function succeeds, it returns DS_OK. If it fails, the return value may be one of the following values.</p> <table> <tr><th>Return Code</th></tr> <tr><td>DSERR_ALLOCATED</td></tr> <tr><td>DSERR_INVALIDPARAM</td></tr> <tr><td>DSERR_NOAGGREGATION</td></tr> <tr><td>DSERR_OUTOFMEMORY</td></tr> </table></returns>
<remarks>
<p>On sound cards that do not support full duplex, this method will fail and return DSERR_ALLOCATED.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DirectSoundCaptureCreate8']/*" />
<msdn-id>microsoft.directx_sdk.reference.directsoundcapturecreate8</msdn-id>
<unmanaged>HRESULT DirectSoundCaptureCreate8([In, Optional] const GUID* pcGuidDevice,[Out, Fast] IDirectSoundCapture** ppDSC8,[In] IUnknown* pUnkOuter)</unmanaged>
<unmanaged-short>DirectSoundCaptureCreate8</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DSound.EnumerateA(SharpDX.FunctionCallback,System.IntPtr)">
<summary>
The DirectSoundEnumerate function enumerates the DirectSound drivers installed in the system.
</summary>
<param name="dSEnumCallbackRef"><dd> Address of the DSEnumCallback function that will be called for each device installed in the system. </dd></param>
<param name="contextRef"><dd> Address of the user-defined context passed to the enumeration callback function every time that function is called. </dd></param>
<returns><p>If the function succeeds, it returns DS_OK. If it fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DirectSoundEnumerateA']/*" />
<msdn-id>microsoft.directx_sdk.reference.directsoundenumerate</msdn-id>
<unmanaged>HRESULT DirectSoundEnumerateA([In] __function__stdcall* pDSEnumCallback,[In, Optional] void* pContext)</unmanaged>
<unmanaged-short>DirectSoundEnumerateA</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DSound.EnumerateW(SharpDX.FunctionCallback,System.IntPtr)">
<summary>
The DirectSoundEnumerate function enumerates the DirectSound drivers installed in the system.
</summary>
<param name="dSEnumCallbackRef"><dd> Address of the DSEnumCallback function that will be called for each device installed in the system. </dd></param>
<param name="contextRef"><dd> Address of the user-defined context passed to the enumeration callback function every time that function is called. </dd></param>
<returns><p>If the function succeeds, it returns DS_OK. If it fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DirectSoundEnumerateW']/*" />
<msdn-id>microsoft.directx_sdk.reference.directsoundenumerate</msdn-id>
<unmanaged>HRESULT DirectSoundEnumerateW([In] __function__stdcall* pDSEnumCallback,[In, Optional] void* pContext)</unmanaged>
<unmanaged-short>DirectSoundEnumerateW</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DSound.CaptureCreate(System.Nullable{System.Guid},SharpDX.DirectSound.DirectSoundCapture@,SharpDX.ComObject)">
<summary>
The DirectSoundCaptureCreate8 function creates and initializes an object that supports the IDirectSoundCapture8 interface. Although the older<strong>DirectSoundCaptureCreate</strong>function can also be used to obtain theIDirectSoundCapture8interface, the object created by that function cannot be used to create capture buffers that support theIDirectSoundCaptureBuffer8interface.
</summary>
<param name="cGuidDeviceRef">No documentation.</param>
<param name="dSCOut">No documentation.</param>
<param name="unkOuterRef">No documentation.</param>
<returns><p>If the function succeeds, it returns DS_OK. If it fails, the return value may be one of the following values.</p> <table> <tr><th>Return Code</th></tr> <tr><td>DSERR_ALLOCATED</td></tr> <tr><td>DSERR_INVALIDPARAM</td></tr> <tr><td>DSERR_NOAGGREGATION</td></tr> <tr><td>DSERR_OUTOFMEMORY</td></tr> </table></returns>
<remarks>
<p>On sound cards that do not support full duplex, this method will fail and return DSERR_ALLOCATED.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DirectSoundCaptureCreate']/*" />
<msdn-id>microsoft.directx_sdk.reference.directsoundcapturecreate8</msdn-id>
<unmanaged>HRESULT DirectSoundCaptureCreate([In, Optional] const GUID* pcGuidDevice,[Out] IDirectSoundCapture** ppDSC,[In] IUnknown* pUnkOuter)</unmanaged>
<unmanaged-short>DirectSoundCaptureCreate</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DSound.FullDuplexCreate(System.Nullable{System.Guid},System.Nullable{System.Guid},SharpDX.DirectSound.CaptureBufferDescription,SharpDX.DirectSound.SoundBufferDescription,System.IntPtr,System.Int32,SharpDX.DirectSound.FullDuplex,SharpDX.DirectSound.CaptureBuffer@,SharpDX.DirectSound.SecondarySoundBuffer@,SharpDX.ComObject)">
<summary>
<p>The <strong>DirectSoundFullDuplexCreate</strong> function is documented under a different name. For complete documentation of this function, see DirectSoundFullDuplexCreate8. </p>
</summary>
<param name="cGuidCaptureDeviceRef">No documentation.</param>
<param name="cGuidRenderDeviceRef">No documentation.</param>
<param name="cDSCBufferDescRef">No documentation.</param>
<param name="cDSBufferDescRef">No documentation.</param>
<param name="hWnd">No documentation.</param>
<param name="dwLevel">No documentation.</param>
<param name="dSFDOut">No documentation.</param>
<param name="dSCBuffer8Out">No documentation.</param>
<param name="dSBuffer8Out">No documentation.</param>
<param name="unkOuterRef">No documentation.</param>
<returns><p>If this function succeeds, it returns <strong><see cref="F:SharpDX.Result.Ok" /></strong>. Otherwise, it returns an <strong><see cref="T:SharpDX.Result" /></strong> error code.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DirectSoundFullDuplexCreate']/*" />
<msdn-id>bb432248</msdn-id>
<unmanaged>HRESULT DirectSoundFullDuplexCreate([In, Optional] const GUID* pcGuidCaptureDevice,[In, Optional] const GUID* pcGuidRenderDevice,[In] const DSCBUFFERDESC* pcDSCBufferDesc,[In] const DSBUFFERDESC* pcDSBufferDesc,[In] HWND hWnd,[In] unsigned int dwLevel,[Out, Fast] IDirectSoundFullDuplex** ppDSFD,[Out] IDirectSoundCaptureBuffer8** ppDSCBuffer8,[Out] IDirectSoundBuffer8** ppDSBuffer8,[In] IUnknown* pUnkOuter)</unmanaged>
<unmanaged-short>DirectSoundFullDuplexCreate</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DSound.Create(System.Nullable{System.Guid},SharpDX.DirectSound.DirectSoundBase@,SharpDX.ComObject)">
<summary>
No documentation.
</summary>
<param name="cGuidDeviceRef">No documentation.</param>
<param name="dSOut">No documentation.</param>
<param name="unkOuterRef">No documentation.</param>
<returns>No documentation.</returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DirectSoundCreate']/*" />
<unmanaged>HRESULT DirectSoundCreate([In, Optional] const GUID* pcGuidDevice,[Out] IDirectSound** ppDS,[In] IUnknown* pUnkOuter)</unmanaged>
<unmanaged-short>DirectSoundCreate</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DSound.GetDeviceID(System.Nullable{System.Guid},System.Guid@)">
<summary>
The GetDeviceID function retrieves the unique device identifier of the default playback and capture devices selected by the user in Control Panel.
</summary>
<param name="guidSrcRef"><dd> Address of a variable that specifies a valid device identifier, or the address of one of the following predefined variables.<table> <tr><th>Value</th><th>Description</th></tr> <tr><td>DSDEVID_DefaultPlayback</td><td>System-wide default audio playback device.</td></tr> <tr><td>DSDEVID_DefaultCapture</td><td>System-wide default audio capture device.</td></tr> <tr><td>DSDEVID_DefaultVoicePlayback</td><td>Default voice playback device.</td></tr> <tr><td>DSDEVID_DefaultVoiceCapture</td><td>Default voice capture device.</td></tr> </table> </dd></param>
<param name="guidDestRef"><dd> Address of a variable that receives the unique identifier of the device. </dd></param>
<returns><p>If the function succeeds, it returns DS_OK. If it fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>If pGuidSrc points to a valid device identifier, the same value is returned in pGuidDest. If pGuidSrc is one of the listed constants, pGuidDest returns the address of the corresponding device <see cref="T:System.Guid" />.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='GetDeviceID']/*" />
<msdn-id>microsoft.directx_sdk.reference.getdeviceid</msdn-id>
<unmanaged>HRESULT GetDeviceID([In, Optional] const GUID* pGuidSrc,[Out] GUID* pGuidDest)</unmanaged>
<unmanaged-short>GetDeviceID</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DSound.CaptureEnumerateA(SharpDX.FunctionCallback,System.IntPtr)">
<summary>
The DirectSoundCaptureEnumerate function enumerates the DirectSoundCapture objects installed in the system.
</summary>
<param name="dSEnumCallbackRef"><dd> Address of the DSEnumCallback function that will be called for each DirectSoundCapture object installed in the system. </dd></param>
<param name="contextRef"><dd> Address of the user-defined context passed to the enumeration callback function every time that function is called. </dd></param>
<returns><p>If the function succeeds, it returns DS_OK. If it fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DirectSoundCaptureEnumerateA']/*" />
<msdn-id>microsoft.directx_sdk.reference.directsoundcaptureenumerate</msdn-id>
<unmanaged>HRESULT DirectSoundCaptureEnumerateA([In] __function__stdcall* pDSEnumCallback,[In, Optional] void* pContext)</unmanaged>
<unmanaged-short>DirectSoundCaptureEnumerateA</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DSound.CaptureEnumerateW(SharpDX.FunctionCallback,System.IntPtr)">
<summary>
The DirectSoundCaptureEnumerate function enumerates the DirectSoundCapture objects installed in the system.
</summary>
<param name="dSEnumCallbackRef"><dd> Address of the DSEnumCallback function that will be called for each DirectSoundCapture object installed in the system. </dd></param>
<param name="contextRef"><dd> Address of the user-defined context passed to the enumeration callback function every time that function is called. </dd></param>
<returns><p>If the function succeeds, it returns DS_OK. If it fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DirectSoundCaptureEnumerateW']/*" />
<msdn-id>microsoft.directx_sdk.reference.directsoundcaptureenumerate</msdn-id>
<unmanaged>HRESULT DirectSoundCaptureEnumerateW([In] __function__stdcall* pDSEnumCallback,[In, Optional] void* pContext)</unmanaged>
<unmanaged-short>DirectSoundCaptureEnumerateW</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DSound.Create8(System.Nullable{System.Guid},SharpDX.DirectSound.DirectSound,SharpDX.ComObject)">
<summary>
The DirectSoundCreate8 function creates and initializes an object that supports theIDirectSound8interface.
</summary>
<param name="cGuidDeviceRef">No documentation.</param>
<param name="dS8Out">No documentation.</param>
<param name="unkOuterRef">No documentation.</param>
<returns><p>If the function succeeds, it returns DS_OK. If it fails, the return value may be one of the following.</p> <table> <tr><th>Return Code</th></tr> <tr><td>DSERR_ALLOCATED</td></tr> <tr><td>DSERR_INVALIDPARAM</td></tr> <tr><td>DSERR_NOAGGREGATION</td></tr> <tr><td>DSERR_NODRIVER</td></tr> <tr><td>DSERR_OUTOFMEMORY</td></tr> </table></returns>
<remarks>
<p>The application must call the IDirectSound8::SetCooperativeLevel method immediately after creating a device object.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DirectSoundCreate8']/*" />
<msdn-id>microsoft.directx_sdk.reference.directsoundcreate8</msdn-id>
<unmanaged>HRESULT DirectSoundCreate8([In, Optional] const GUID* pcGuidDevice,[Out, Fast] IDirectSound8** ppDS8,[In] IUnknown* pUnkOuter)</unmanaged>
<unmanaged-short>DirectSoundCreate8</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.SoundEffectGuid">
<summary>
Functions
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.DirectSound.SoundEffectGuid']/*" />
</member>
<member name="F:SharpDX.DirectSound.SoundEffectGuid.StandardFlanger">
<summary>Constant StandardFlanger.</summary>
<unmanaged>GUID_DSFX_STANDARD_FLANGER</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectGuid.StandardChorus">
<summary>Constant StandardChorus.</summary>
<unmanaged>GUID_DSFX_STANDARD_CHORUS</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectGuid.StandardCompressor">
<summary>Constant StandardCompressor.</summary>
<unmanaged>GUID_DSFX_STANDARD_COMPRESSOR</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectGuid.StandardI3DL2REVERB">
<summary>Constant StandardI3DL2REVERB.</summary>
<unmanaged>GUID_DSFX_STANDARD_I3DL2REVERB</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectGuid.WavesReverb">
<summary>Constant WavesReverb.</summary>
<unmanaged>GUID_DSFX_WAVES_REVERB</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectGuid.StandardGargle">
<summary>Constant StandardGargle.</summary>
<unmanaged>GUID_DSFX_STANDARD_GARGLE</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectGuid.StandardEcho">
<summary>Constant StandardEcho.</summary>
<unmanaged>GUID_DSFX_STANDARD_ECHO</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectGuid.StandardParameq">
<summary>Constant StandardParameq.</summary>
<unmanaged>GUID_DSFX_STANDARD_PARAMEQ</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.SoundEffectGuid.StandardDistortion">
<summary>Constant StandardDistortion.</summary>
<unmanaged>GUID_DSFX_STANDARD_DISTORTION</unmanaged>
</member>
<member name="T:SharpDX.DirectSound.Volume">
<summary>
Functions
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.DirectSound.Volume']/*" />
</member>
<member name="F:SharpDX.DirectSound.Volume.Minimum">
<summary>Constant Minimum.</summary>
<unmanaged>DSBVOLUME_MIN</unmanaged>
</member>
<member name="F:SharpDX.DirectSound.Volume.Maximum">
<summary>Constant Maximum.</summary>
<unmanaged>DSBVOLUME_MAX</unmanaged>
</member>
<member name="T:SharpDX.DirectSound.AcousticEchoCancel">
<summary>
<p>The IDirectSoundCaptureFXAec8 interface is used to set and retrieve parameters on a capture buffer that supports acoustic echo cancellation. This interface requires Microsoft Windows XP or later operating systems.</p><p>IDirectSoundCaptureFXAec8 is a define for <see cref="T:SharpDX.DirectSound.AcousticEchoCancel" />. The interface names are interchangeable.</p><p>This interface is obtained by calling GetObjectInPath on the buffer that supports the effect.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSoundCaptureFXAec8 interface exposes the following methods.</p>IDirectSoundCaptureFXAec8 Members<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundCaptureFXAec8::GetAllParameters </td><td>The IDirectSoundCaptureFXAec8::GetAllParameters method retrieves the acoustic echo cancellation parameters of a buffer.
</td></tr> <tr><td>IDirectSoundCaptureFXAec8::GetStatus </td><td>The IDirectSoundCaptureFXAec8::GetStatus method retrieves the status of the effect.
</td></tr> <tr><td>IDirectSoundCaptureFXAec8::Reset </td><td>The IDirectSoundCaptureFXAec8::Reset method resets the effect to its initial state.
</td></tr> <tr><td>IDirectSoundCaptureFXAec8::SetAllParameters </td><td>The IDirectSoundCaptureFXAec8::SetAllParameters method sets the acoustic echo cancellation parameters of a buffer.
</td></tr> </table><p>The LPDIRECTSOUNDCAPTUREFXAEC8 type is defined as a reference to the IDirectSoundCaptureFXAec8 interface:</p><pre> typedef struct IDirectSoundCaptureFXAec8 *LPDIRECTSOUNDCAPTUREFXAEC8;
</pre>Info<p>Operating System: Requires Microsoft WindowsXP or later.</p> <table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureFXAec']/*" />
<msdn-id>ee418187</msdn-id>
<unmanaged>IDirectSoundCaptureFXAec</unmanaged>
<unmanaged-short>IDirectSoundCaptureFXAec</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.AcousticEchoCancel.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.AcousticEchoCancel"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.AcousticEchoCancel.op_Explicit(System.IntPtr)~SharpDX.DirectSound.AcousticEchoCancel">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.AcousticEchoCancel"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.AcousticEchoCancel.AllParameters">
<summary>
The GetAllParameters method retrieves the acoustic echo cancellation parameters of a buffer.
</summary>
<remarks>
<table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureFXAec::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturefxaec8.idirectsoundcapturefxaec8.getallparameters</msdn-id>
<unmanaged>GetAllParameters / SetAllParameters</unmanaged>
<unmanaged-short>GetAllParameters</unmanaged-short>
<unmanaged>HRESULT IDirectSoundCaptureFXAec::GetAllParameters([Out] DSCFXAec* pDscFxAec)</unmanaged>
</member>
<member name="P:SharpDX.DirectSound.AcousticEchoCancel.Status">
<summary>
The IDirectSoundCaptureFXAec8::GetStatus method retrieves the status of the effect.
</summary>
<remarks>
<table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table> <p>The three least significant bits in *pdwStatus describe the convergence history; that is, the success of the effect in canceling the echo. The convergence history can be used by the application to determine if the algorithm has converged and remained in the converged state since it started processing data.</p> <p>Initially, the AEC algorithm sets the three lower bits to 0 for the uninitialized state (<see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryUninitialized" />). When the AEC algorithm has converged, the convergence history is switched to the <see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryContinuouslyConverged" /> state. If the AEC algorithm ever loses convergence, the convergence history is then transitioned to the <see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryPreviouslyDiverged" /> state. A transition from <see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryUninitialized" /> to <see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryPreviouslyDiverged" /> is also possible. The convergence history remains in the <see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryPreviouslyDiverged" /> state until the algorithm is reset or timely data is no longer arriving on the capture or render stream.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureFXAec::GetStatus']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturefxaec8.idirectsoundcapturefxaec8.getstatus</msdn-id>
<unmanaged>GetStatus</unmanaged>
<unmanaged-short>GetStatus</unmanaged-short>
<unmanaged>HRESULT IDirectSoundCaptureFXAec::GetStatus([Out] DSCFX_AEC_STATUS* pdwStatus)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.AcousticEchoCancel.SetAllParameters(SharpDX.DirectSound.AcousticEchoCancelSettings)">
<summary>
The SetAllParameters method sets the acoustic echo cancellation parameters of a buffer.
</summary>
<param name="dscFxAecRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.AcousticEchoCancelSettings" /> structure that specifies the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following values.</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_OUTOFMEMORY </td></tr> </table></returns>
<remarks>
<table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureFXAec::SetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturefxaec8.idirectsoundcapturefxaec8.setallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureFXAec::SetAllParameters([In] const DSCFXAec* pDscFxAec)</unmanaged>
<unmanaged-short>IDirectSoundCaptureFXAec::SetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.AcousticEchoCancel.GetAllParameters(SharpDX.DirectSound.AcousticEchoCancelSettings@)">
<summary>
The GetAllParameters method retrieves the acoustic echo cancellation parameters of a buffer.
</summary>
<param name="dscFxAecRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.AcousticEchoCancelSettings" /> structure that receives the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following values.</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_OUTOFMEMORY </td></tr> </table> <p>If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureFXAec::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturefxaec8.idirectsoundcapturefxaec8.getallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureFXAec::GetAllParameters([Out] DSCFXAec* pDscFxAec)</unmanaged>
<unmanaged-short>IDirectSoundCaptureFXAec::GetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.AcousticEchoCancel.GetStatus(SharpDX.DirectSound.AcousticEchoCancelStatus@)">
<summary>
The IDirectSoundCaptureFXAec8::GetStatus method retrieves the status of the effect.
</summary>
<param name="tatusRef"><dd> Address of a DWORD variable to receive the status. The following flags are defined. See Remarks. <table> <tr><td>Constant</td><td>Value</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryUninitialized" /></td><td>0x0</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryContinuouslyConverged" /></td><td>0x1</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryPreviouslyDiverged" /></td><td>0x2</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.CurrentlyConverged" /></td><td>0x8</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following values.</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_OUTOFMEMORY </td></tr> </table></returns>
<remarks>
<table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table> <p>The three least significant bits in *pdwStatus describe the convergence history; that is, the success of the effect in canceling the echo. The convergence history can be used by the application to determine if the algorithm has converged and remained in the converged state since it started processing data.</p> <p>Initially, the AEC algorithm sets the three lower bits to 0 for the uninitialized state (<see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryUninitialized" />). When the AEC algorithm has converged, the convergence history is switched to the <see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryContinuouslyConverged" /> state. If the AEC algorithm ever loses convergence, the convergence history is then transitioned to the <see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryPreviouslyDiverged" /> state. A transition from <see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryUninitialized" /> to <see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryPreviouslyDiverged" /> is also possible. The convergence history remains in the <see cref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryPreviouslyDiverged" /> state until the algorithm is reset or timely data is no longer arriving on the capture or render stream.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureFXAec::GetStatus']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturefxaec8.idirectsoundcapturefxaec8.getstatus</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureFXAec::GetStatus([Out] DSCFX_AEC_STATUS* pdwStatus)</unmanaged>
<unmanaged-short>IDirectSoundCaptureFXAec::GetStatus</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.AcousticEchoCancel.Reset">
<summary>
The IDirectSoundCaptureFXAec8::Reset method resets the effect to its initial state.
</summary>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_OUTOFMEMORY.</p></returns>
<remarks>
<table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table> <p>Applications should not reset an effect except when necessary because it has entered an incorrect state. This might be done in response to user input. An effect must not be reset arbitrarily at startup, because another application might be using the same effect.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureFXAec::Reset']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturefxaec8.idirectsoundcapturefxaec8.reset</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureFXAec::Reset()</unmanaged>
<unmanaged-short>IDirectSoundCaptureFXAec::Reset</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.DirectSoundBase">
<summary>
<p>The <see cref="T:SharpDX.DirectSound.DirectSound" /> interface is used to create buffer objects, manage devices, and set up the environment. This interface supersedes <see cref="T:SharpDX.DirectSound.DirectSoundBase" /> and adds new methods.</p><p>Obtain this interface by using the DirectSoundCreate8 or DirectSoundFullDuplexCreate8 function, or by using CoCreateInstance or CoCreateInstanceEx to create an object of class CLSID_DirectSound8.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the <see cref="T:SharpDX.DirectSound.DirectSound" /> interface exposes the following methods.</p>IDirectSound8 Members<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSound8::Compact </td><td>The Compact method has no effect.
</td></tr> <tr><td>IDirectSound8::CreateSoundBuffer </td><td>The CreateSoundBuffer method creates a sound buffer object to manage audio samples.
</td></tr> <tr><td>IDirectSound8::DuplicateSoundBuffer </td><td>The DuplicateSoundBuffer method creates a new secondary buffer that shares the original buffer's memory.
</td></tr> <tr><td>IDirectSound8::GetCaps </td><td>The GetCaps method retrieves the capabilities of the hardware device that is represented by the device object.
</td></tr> <tr><td>IDirectSound8::GetSpeakerConfig </td><td>The GetSpeakerConfig method retrieves the speaker configuration.
</td></tr> <tr><td>IDirectSound8::Initialize </td><td>The Initialize method initializes a device object that was created by using the CoCreateInstance function.
</td></tr> <tr><td>IDirectSound8::SetCooperativeLevel </td><td>The SetCooperativeLevel method sets the cooperative level of the application for this sound device.
</td></tr> <tr><td>IDirectSound8::SetSpeakerConfig </td><td>The SetSpeakerConfig method specifies the speaker configuration of the device.
</td></tr> <tr><td><see cref="M:SharpDX.DirectSound.DirectSound.VerifyCertification(System.Int32@)" /> </td><td>The VerifyCertification method ascertains whether the device driver is certified for DirectX.
</td></tr> </table><p>The LPDIRECTSOUND8 type is defined as a reference to the <see cref="T:SharpDX.DirectSound.DirectSound" /> interface:</p><pre> typedef struct <see cref="T:SharpDX.DirectSound.DirectSound" /> *LPDIRECTSOUND8;
</pre>
</summary>
<remarks>
<p>Only objects of class CLSID_DirectSound8 support this interface. All device objects created by DirectSoundCreate8 and DirectSoundFullDuplexCreate8 fall into this category. Objects of class CLSID_DirectSound, which include all those created by using the earlier DirectSoundCreate function, support only the earlier <see cref="T:SharpDX.DirectSound.DirectSoundBase" /> interface.</p> <p>The behavior of CLSID_DirectSound8 objects is somewhat different from that of CLSID_DirectSound objects. These differences are found in the <see cref="T:SharpDX.DirectSound.DirectSoundBase" /> interface as well as the <see cref="T:SharpDX.DirectSound.DirectSound" /> interface. Specific differences in the behavior of the newer object include the following:</p> <ul> <li><p>In calls to <see cref="M:SharpDX.DirectSound.DirectSoundBase.CreateSoundBuffer(SharpDX.DirectSound.SoundBufferDescription,System.IntPtr@,SharpDX.ComObject)" /> and CreateSoundBuffer, <see cref="F:SharpDX.DirectSound.BufferFlags.Control3D" /> cannot be set on a buffer with a non-mono format, and <see cref="F:SharpDX.DirectSound.BufferFlags.Control3D" /> cannot be combined with <see cref="F:SharpDX.DirectSound.BufferFlags.ControlPan" />.</p></li> <li><p>New buffer creation flags are supported.</p></li> <li><p>Buffers are not filled with silence on creation.</p></li> <li><p>The <see cref="T:SharpDX.DirectSound.SoundBuffer" /> interface returned by CreateSoundBuffer can be queried for the <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> interface.</p></li> <li><p>WAV formats in the <see cref="T:SharpDX.DirectSound.SoundBufferDescription" /> structure that have the <see cref="F:SharpDX.Multimedia.WaveFormatEncoding.Extensible" /> format tag are checked more strictly for validity.</p></li> </ul>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound']/*" />
<msdn-id>ee418035</msdn-id>
<unmanaged>IDirectSound</unmanaged>
<unmanaged-short>IDirectSound</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundBase.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.DirectSoundBase"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundBase.op_Explicit(System.IntPtr)~SharpDX.DirectSound.DirectSoundBase">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.DirectSoundBase"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.DirectSoundBase.Capabilities">
<summary>
The GetCaps method retrieves the capabilities of the hardware device that is represented by the device object.
</summary>
<remarks>
<p>Information retrieved in the <see cref="T:SharpDX.DirectSound.Capabilities" /> structure describes the maximum capabilities of the sound device and those currently available, such as the number of hardware mixing channels and the amount of on-board sound memory. You can use this information to fine-tune performance and optimize resource allocation.</p> <p>Because of resource-sharing requirements, the maximum capabilities in one area might be available only at the cost of another area.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound::GetCaps']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound8.idirectsound8.getcaps</msdn-id>
<unmanaged>GetCaps</unmanaged>
<unmanaged-short>GetCaps</unmanaged-short>
<unmanaged>HRESULT IDirectSound::GetCaps([Out] DSCAPS* pDSCaps)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundBase.CreateSoundBuffer(SharpDX.DirectSound.SoundBufferDescription,System.IntPtr@,SharpDX.ComObject)">
<summary>
The CreateSoundBuffer method creates a sound buffer object to manage audio samples.
</summary>
<param name="cDSBufferDescRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.SoundBufferDescription" /> structure that describes the sound buffer to create. </dd></param>
<param name="dSBufferOut"><dd> Address of a variable that receives the <see cref="T:SharpDX.DirectSound.SoundBuffer" /> interface of the new buffer object. Use QueryInterface to obtain <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" />. <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> is not available for the primary buffer. </dd></param>
<param name="unkOuterRef"><dd> Address of the controlling object's <see cref="T:SharpDX.ComObject" /> interface for COM aggregation. Must be <c>null</c>. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK, or DS_NO_VIRTUALIZATION if a requested 3D algorithm was not available and stereo panning was substituted. See the description of the guid3DAlgorithm member of <see cref="T:SharpDX.DirectSound.SoundBufferDescription" />. If the method fails, the return value may be one of the error values shown in the following table.</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_ALLOCATED </td></tr> <tr><td>DSERR_BADFORMAT </td></tr> <tr><td>DSERR_BUFFERTOOSMALL </td></tr> <tr><td>DSERR_CONTROLUNAVAIL </td></tr> <tr><td>DSERR_DS8_REQUIRED </td></tr> <tr><td>DSERR_INVALIDCALL </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_NOAGGREGATION </td></tr> <tr><td>DSERR_OUTOFMEMORY </td></tr> <tr><td>DSERR_UNINITIALIZED </td></tr> <tr><td>DSERR_UNSUPPORTED </td></tr> </table></returns>
<remarks>
<p>DirectSound does not initialize the contents of the buffer, and the application cannot assume that it contains silence.</p> <p>If an attempt is made to create a buffer with the <see cref="F:SharpDX.DirectSound.BufferFlags.Hardware" /> flag on a system where hardware acceleration is not available, the method fails with either DSERR_CONTROLUNAVAIL or DSERR_INVALIDCALL, depending on the operating system.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound::CreateSoundBuffer']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound8.idirectsound8.createsoundbuffer</msdn-id>
<unmanaged>HRESULT IDirectSound::CreateSoundBuffer([In] const DSBUFFERDESC* pcDSBufferDesc,[Out] void** ppDSBuffer,[In] IUnknown* pUnkOuter)</unmanaged>
<unmanaged-short>IDirectSound::CreateSoundBuffer</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundBase.GetCapabilities(SharpDX.DirectSound.Capabilities@)">
<summary>
The GetCaps method retrieves the capabilities of the hardware device that is represented by the device object.
</summary>
<param name="dSCapsRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.Capabilities" /> structure that receives the capabilities of this sound device. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the error values shown in the following table.</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_GENERIC </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_UNINITIALIZED </td></tr> </table></returns>
<remarks>
<p>Information retrieved in the <see cref="T:SharpDX.DirectSound.Capabilities" /> structure describes the maximum capabilities of the sound device and those currently available, such as the number of hardware mixing channels and the amount of on-board sound memory. You can use this information to fine-tune performance and optimize resource allocation.</p> <p>Because of resource-sharing requirements, the maximum capabilities in one area might be available only at the cost of another area.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound::GetCaps']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound8.idirectsound8.getcaps</msdn-id>
<unmanaged>HRESULT IDirectSound::GetCaps([Out] DSCAPS* pDSCaps)</unmanaged>
<unmanaged-short>IDirectSound::GetCaps</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundBase.DuplicateSoundBuffer(SharpDX.DirectSound.SoundBuffer,System.IntPtr@)">
<summary>
The DuplicateSoundBuffer method creates a new secondary buffer that shares the original buffer's memory.
</summary>
<param name="dSBufferOriginalRef"><dd> Address of the <see cref="T:SharpDX.DirectSound.SoundBuffer" /> or <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> interface of the buffer to duplicate. </dd></param>
<param name="dSBufferDuplicateOut"><dd> Address of a variable that receives the <see cref="T:SharpDX.DirectSound.SoundBuffer" /> interface reference for the new buffer. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_ALLOCATED </td></tr> <tr><td>DSERR_INVALIDCALL </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_OUTOFMEMORY </td></tr> <tr><td>DSERR_UNINITIALIZED </td></tr> </table></returns>
<remarks>
<p>This method is not valid for buffers created with the <see cref="F:SharpDX.DirectSound.BufferFlags.ControlEffects" /> flag.</p> <p>Initially, the duplicate buffer will have the same parameters as the original buffer. However, the application can change the parameters of each buffer independently, and each can be played or stopped without affecting the other.</p> <p>The buffer memory is released when the last object referencing it is released.</p> <p>There is a known issue with volume levels of duplicated buffers. The duplicated buffer will play at full volume unless you change the volume to a different value than the original buffer's volume setting. If the volume stays the same (even if you explicitly set the same volume in the duplicated buffer with a IDirectSoundBuffer8::SetVolume call), the buffer will play at full volume regardless. To work around this problem, immediately set the volume of the duplicated buffer to something slightly different than what it was, even if you change it one millibel. The volume may then be immediately set back again to the original desired value.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound::DuplicateSoundBuffer']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound8.idirectsound8.duplicatesoundbuffer</msdn-id>
<unmanaged>HRESULT IDirectSound::DuplicateSoundBuffer([In] IDirectSoundBuffer* pDSBufferOriginal,[Out] void** ppDSBufferDuplicate)</unmanaged>
<unmanaged-short>IDirectSound::DuplicateSoundBuffer</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundBase.SetCooperativeLevel(System.IntPtr,SharpDX.DirectSound.CooperativeLevel)">
<summary>
The SetCooperativeLevel method sets the cooperative level of the application for this sound device.
</summary>
<param name="hwnd"><dd> Handle to the application window. </dd></param>
<param name="level"><dd> Requested level. Specify one of the values shown in the following table. <table> <tr><td>Value</td><td>Description</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.CooperativeLevel.Exclusive" /></td><td>For DirectX 8.0 and later, has the same effect as <see cref="F:SharpDX.DirectSound.CooperativeLevel.Priority" />. For previous versions, sets the application to the exclusive level. This means that when it has the input focus, the application will be the only one audible; sounds from applications with the <see cref="F:SharpDX.DirectSound.BufferFlags.GlobalFocus" /> flag set will be muted. With this level, it also has all the privileges of the <see cref="F:SharpDX.DirectSound.CooperativeLevel.Priority" /> level. DirectSound will restore the hardware format, as specified by the most recent call to the SetFormat method, after the application gains the input focus.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.CooperativeLevel.Normal" /></td><td>Sets the normal level. This level has the smoothest multitasking and resource-sharing behavior, but because it does not allow the primary buffer format to change, output is restricted to the default 8-bit format.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.CooperativeLevel.Priority" /></td><td>Sets the priority level. Applications with this cooperative level can call the SetFormat and Compact methods.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.CooperativeLevel.WritePrimary" /></td><td>Sets the write-primary level. The application has write access to the primary buffer. No secondary buffers can be played. This level cannot be set if the DirectSound driver is being emulated for the device; that is, if the GetCaps method returns the <see cref="F:SharpDX.DirectSound.CapabilitiesFlags.EmulatedDriver" /> flag in the <see cref="T:SharpDX.DirectSound.Capabilities" /> structure.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the error values shown in the following table.</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_ALLOCATED </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_UNINITIALIZED </td></tr> <tr><td>DSERR_UNSUPPORTED </td></tr> </table></returns>
<remarks>
<p>The application must set the cooperative level by calling this method before its buffers can be played. The recommended cooperative level is <see cref="F:SharpDX.DirectSound.CooperativeLevel.Priority" />.</p> <p>Do not call this method if any buffers are locked.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound::SetCooperativeLevel']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound8.idirectsound8.setcooperativelevel</msdn-id>
<unmanaged>HRESULT IDirectSound::SetCooperativeLevel([In] HWND hwnd,[In] DSSCL_ENUM dwLevel)</unmanaged>
<unmanaged-short>IDirectSound::SetCooperativeLevel</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundBase.Compact">
<summary>
The Compact method has no effect.
</summary>
<returns><p>The return value is DS_OK.</p></returns>
<remarks>
<p>This method was formerly used for compacting the on-board memory of ISA sound cards.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound::Compact']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound8.idirectsound8.compact</msdn-id>
<unmanaged>HRESULT IDirectSound::Compact()</unmanaged>
<unmanaged-short>IDirectSound::Compact</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundBase.GetSpeakerConfiguration(System.Int32@)">
<summary>
The GetSpeakerConfig method retrieves the speaker configuration.
</summary>
<param name="peakerConfigRef"><dd> Address of the speaker configuration (see remarks in IDirectSound8::SetSpeakerConfig). </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the error values shown in the following table.</p> <table> <tr><th>Return code</th></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_UNINITIALIZED </td></tr> </table></returns>
<remarks>
<p>The value returned at pdwSpeakerConfig can be a packed DWORD containing both configuration and geometry information. Use the DSSPEAKER_CONFIG and DSSPEAKER_GEOMETRY macros to unpack the DWORD, as in the following example:</p> <pre> if (DSSPEAKER_CONFIG(dwSpeakerConfig) == <see cref="F:SharpDX.DirectSound.SpeakerConfiguration.Stereo" />) { if (DSSPEAKER_GEOMETRY(dwSpeakerConfig) == <see cref="F:SharpDX.DirectSound.SpeakerGeometry.Wide" />) { // Configuration is wide stereo. ...} } </pre> <p>To use #defines implemented in Windows Vista, set the DIRECTSOUND_VERSION to 0x1000 before including dsound.h.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound::GetSpeakerConfig']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound8.idirectsound8.getspeakerconfig</msdn-id>
<unmanaged>HRESULT IDirectSound::GetSpeakerConfig([Out] unsigned int* pdwSpeakerConfig)</unmanaged>
<unmanaged-short>IDirectSound::GetSpeakerConfig</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.DirectSoundBase.SetSpeakerConfiguration(System.Int32)">
<summary>
The<strong>SetSpeakerConfig</strong>method specifies the speaker configuration of the device.
</summary>
<param name="speakerConfig"><dd> The speaker configuration. See the following remarks. </dd></param>
<returns>No documentation.</returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound::SetSpeakerConfig']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound8.idirectsound8.setspeakerconfig</msdn-id>
<unmanaged>HRESULT IDirectSound::SetSpeakerConfig([In] unsigned int dwSpeakerConfig)</unmanaged>
<unmanaged-short>IDirectSound::SetSpeakerConfig</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.I3DL2Reverb">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb']/*" />
<msdn-id>bb280379</msdn-id>
<unmanaged>IDirectSoundFXI3DL2Reverb</unmanaged>
<unmanaged-short>IDirectSoundFXI3DL2Reverb</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.I3DL2Reverb.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.I3DL2Reverb"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.I3DL2Reverb.op_Explicit(System.IntPtr)~SharpDX.DirectSound.I3DL2Reverb">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.I3DL2Reverb"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.I3DL2Reverb.AllParameters">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::GetAllParameters']/*" />
<unmanaged>GetAllParameters / SetAllParameters</unmanaged>
<unmanaged-short>GetAllParameters</unmanaged-short>
<unmanaged>HRESULT IDirectSoundFXI3DL2Reverb::GetAllParameters([Out] DSFXI3DL2Reverb* pDsFxI3DL2Reverb)</unmanaged>
</member>
<member name="P:SharpDX.DirectSound.I3DL2Reverb.Preset">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::GetPreset']/*" />
<unmanaged>GetPreset / SetPreset</unmanaged>
<unmanaged-short>GetPreset</unmanaged-short>
<unmanaged>HRESULT IDirectSoundFXI3DL2Reverb::GetPreset([Out] unsigned int* pdwPreset)</unmanaged>
</member>
<member name="P:SharpDX.DirectSound.I3DL2Reverb.Quality">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::GetQuality']/*" />
<unmanaged>GetQuality / SetQuality</unmanaged>
<unmanaged-short>GetQuality</unmanaged-short>
<unmanaged>HRESULT IDirectSoundFXI3DL2Reverb::GetQuality([Out] int* plQuality)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.I3DL2Reverb.SetAllParameters(SharpDX.DirectSound.I3DL2ReverbSettings@)">
<summary>
No documentation.
</summary>
<param name="cDsFxI3DL2ReverbRef">No documentation.</param>
<returns>No documentation.</returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::SetAllParameters']/*" />
<unmanaged>HRESULT IDirectSoundFXI3DL2Reverb::SetAllParameters([In] const DSFXI3DL2Reverb* pcDsFxI3DL2Reverb)</unmanaged>
<unmanaged-short>IDirectSoundFXI3DL2Reverb::SetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.I3DL2Reverb.GetAllParameters(SharpDX.DirectSound.I3DL2ReverbSettings@)">
<summary>
No documentation.
</summary>
<param name="dsFxI3DL2ReverbRef">No documentation.</param>
<returns>No documentation.</returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::GetAllParameters']/*" />
<unmanaged>HRESULT IDirectSoundFXI3DL2Reverb::GetAllParameters([Out] DSFXI3DL2Reverb* pDsFxI3DL2Reverb)</unmanaged>
<unmanaged-short>IDirectSoundFXI3DL2Reverb::GetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.I3DL2Reverb.SetPreset(System.Int32)">
<summary>
No documentation.
</summary>
<param name="preset">No documentation.</param>
<returns>No documentation.</returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::SetPreset']/*" />
<unmanaged>HRESULT IDirectSoundFXI3DL2Reverb::SetPreset([In] unsigned int dwPreset)</unmanaged>
<unmanaged-short>IDirectSoundFXI3DL2Reverb::SetPreset</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.I3DL2Reverb.GetPreset(System.Int32@)">
<summary>
No documentation.
</summary>
<param name="resetRef">No documentation.</param>
<returns>No documentation.</returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::GetPreset']/*" />
<unmanaged>HRESULT IDirectSoundFXI3DL2Reverb::GetPreset([Out] unsigned int* pdwPreset)</unmanaged>
<unmanaged-short>IDirectSoundFXI3DL2Reverb::GetPreset</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.I3DL2Reverb.SetQuality(System.Int32)">
<summary>
No documentation.
</summary>
<param name="quality">No documentation.</param>
<returns>No documentation.</returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::SetQuality']/*" />
<unmanaged>HRESULT IDirectSoundFXI3DL2Reverb::SetQuality([In] int lQuality)</unmanaged>
<unmanaged-short>IDirectSoundFXI3DL2Reverb::SetQuality</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.I3DL2Reverb.GetQuality(System.Int32@)">
<summary>
No documentation.
</summary>
<param name="lQualityRef">No documentation.</param>
<returns>No documentation.</returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::GetQuality']/*" />
<unmanaged>HRESULT IDirectSoundFXI3DL2Reverb::GetQuality([Out] int* plQuality)</unmanaged>
<unmanaged-short>IDirectSoundFXI3DL2Reverb::GetQuality</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.DecayHFRatioDefault">
<summary>
Default ratio of the decay time at high frequencies to the decay time at low frequencies.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.DecayHFRatioMax">
<summary>
Maximum ratio of the decay time at high frequencies to the decay time at low frequencies.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.DecayHFRatioMin">
<summary>
Minimum ratio of the decay time at high frequencies to the decay time at low frequencies.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.DecayTimeDefault">
<summary>
Default decay time, in seconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.DecayTimeMax">
<summary>
Maximum decay time, in seconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.DecayTimeMin">
<summary>
Minimum decay time, in seconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.DensityDefault">
<summary>
Default modal density in the late reverberation decay, in percent.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.DensityMax">
<summary>
Maximum modal density in the late reverberation decay, in percent.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.DensityMin">
<summary>
Minimum modal density in the late reverberation decay, in percent.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.DiffusionDefault">
<summary>
Default echo density in the late reverberation decay, in percent.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.DiffusionMax">
<summary>
Maximum echo density in the late reverberation decay, in percent.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.DiffusionMin">
<summary>
Minimum echo density in the late reverberation decay, in percent.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.HFReferenceDefault">
<summary>
Default reference high frequency, in hertz.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.HFReferenceMax">
<summary>
Maximum reference high frequency, in hertz.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.HFReferenceMin">
<summary>
Minimum reference high frequency, in hertz.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.ReflectionsDefault">
<summary>
Default attenuation of early reflections relative to Room, in mB.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.ReflectionsDelayDefault">
<summary>
Default delay time of the first reflection relative to the direct path, in seconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.ReflectionsDelayMax">
<summary>
Maximum delay time of the first reflection relative to the direct path, in seconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.ReflectionsDelayMin">
<summary>
Minimum delay time of the first reflection relative to the direct path, in seconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.ReflectionsMax">
<summary>
Maximum attenuation of early reflections relative to Room, in mB.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.ReflectionsMin">
<summary>
Minimum attenuation of early reflections relative to Room, in mB.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.ReverbDefault">
<summary>
Default attenuation of late reverberation relative to Room, in mB.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.ReverbDelayDefault">
<summary>
Default time limit between the early reflections and the late reverberation relative to the time of the first reflection, in seconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.ReverbDelayMax">
<summary>
Maximum time limit between the early reflections and the late reverberation relative to the time of the first reflection, in seconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.ReverbDelayMin">
<summary>
Minimum time limit between the early reflections and the late reverberation relative to the time of the first reflection, in seconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.ReverbMax">
<summary>
Maximum attenuation of late reverberation relative to Room, in mB.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.ReverbMin">
<summary>
Minimum attenuation of late reverberation relative to Room, in mB.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.RoomDefault">
<summary>
Default attenuation of the room effect, in millibels (mB).
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.RoomHFDefault">
<summary>
Default attenuation of the room high-frequency effect, in mB.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.RoomHFMax">
<summary>
Maximum attenuation of the room high-frequency effect, in mB.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.RoomHFMin">
<summary>
Minimum attenuation of the room high-frequency effect, in mB.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.RoomMax">
<summary>
Maximum attenuation of the room effect, in millibels (mB).
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.RoomMin">
<summary>
Minimum attenuation of the room effect, in millibels (mB).
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.RoomRolloffFactorDefault">
<summary>
Default rolloff factor for the reflected signals. The rolloff factor for the direct path is controlled by the DirectSound listener.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.RoomRolloffFactorMax">
<summary>
Maximum rolloff factor for the reflected signals. The rolloff factor for the direct path is controlled by the DirectSound listener.
</summary>
</member>
<member name="F:SharpDX.DirectSound.I3DL2Reverb.RoomRolloffFactorMin">
<summary>
Minimum rolloff factor for the reflected signals. The rolloff factor for the direct path is controlled by the DirectSound listener.
</summary>
</member>
<member name="T:SharpDX.DirectSound.NoiseSuppress">
<summary>
<p>The IDirectSoundCaptureFXNoiseSuppress8 interface is used to set and retrieve parameters on a capture buffer that supports noise suppression. This interface requires Microsoft WindowsXP or later.</p><p>IDirectSoundCaptureFXNoiseSuppress8 is a define for <see cref="T:SharpDX.DirectSound.NoiseSuppress" />. The interface names are interchangeable.</p><p>This interface is obtained by calling GetObjectInPath on the buffer that supports the effect.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSoundCaptureFXNoiseSuppress8 interface exposes the following methods.</p>IDirectSoundCaptureFXNoiseSuppress8 Members<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundCaptureFXNoiseSuppress8::GetAllParameters </td><td>The IDirectSoundCaptureFXNoiseSuppress8::GetAllParameters method retrieves the noise suppression parameters of a buffer.
</td></tr> <tr><td>IDirectSoundCaptureFXNoiseSuppress8::Reset </td><td>The IDirectSoundCaptureFXNoiseSuppress8::Reset method resets the effect to its initial state.
</td></tr> <tr><td>IDirectSoundCaptureFXNoiseSuppress8::SetAllParameters </td><td>The IDirectSoundCaptureFXNoiseSuppress8::SetAllParameters method sets the noise suppression parameters of a buffer.
</td></tr> </table><p>The LPDIRECTSOUNDNOISESUPPRESS8 type is defined as a reference to the IDirectSoundNoiseSuppress8 interface:</p><pre> typedef struct IDirectSoundCaptureFXNoiseSuppress8 *LPDIRECTSOUNDCAPTUREFXNOISESUPPRESS8;
</pre>Info<p>Operating System: Requires Microsoft WindowsXP or later.</p> <table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureFXNoiseSuppress']/*" />
<msdn-id>ee418197</msdn-id>
<unmanaged>IDirectSoundCaptureFXNoiseSuppress</unmanaged>
<unmanaged-short>IDirectSoundCaptureFXNoiseSuppress</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.NoiseSuppress.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.NoiseSuppress"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.NoiseSuppress.op_Explicit(System.IntPtr)~SharpDX.DirectSound.NoiseSuppress">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.NoiseSuppress"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.NoiseSuppress.AllParameters">
<summary>
The GetAllParameters method retrieves the noise suppression parameters of a buffer.
</summary>
<remarks>
<table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureFXNoiseSuppress::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturefxnoisesuppress8.idirectsoundcapturefxnoisesuppress8.getallparameters</msdn-id>
<unmanaged>GetAllParameters / SetAllParameters</unmanaged>
<unmanaged-short>GetAllParameters</unmanaged-short>
<unmanaged>HRESULT IDirectSoundCaptureFXNoiseSuppress::GetAllParameters([Out] DSCFXNoiseSuppress* pDscFxNoiseSuppress)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.NoiseSuppress.SetAllParameters(SharpDX.DirectSound.NoiseSuppressSettings)">
<summary>
The SetAllParameters method sets the noise suppression parameters of a buffer.
</summary>
<param name="cDscFxNoiseSuppressRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.NoiseSuppressSettings" /> structure that specifies the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_OUTOFMEMORY </td></tr> </table></returns>
<remarks>
<table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureFXNoiseSuppress::SetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturefxnoisesuppress8.idirectsoundcapturefxnoisesuppress8.setallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureFXNoiseSuppress::SetAllParameters([In] const DSCFXNoiseSuppress* pcDscFxNoiseSuppress)</unmanaged>
<unmanaged-short>IDirectSoundCaptureFXNoiseSuppress::SetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.NoiseSuppress.GetAllParameters(SharpDX.DirectSound.NoiseSuppressSettings@)">
<summary>
The GetAllParameters method retrieves the noise suppression parameters of a buffer.
</summary>
<param name="dscFxNoiseSuppressRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.NoiseSuppressSettings" /> structure that receives the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_OUTOFMEMORY </td></tr> </table></returns>
<remarks>
<table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureFXNoiseSuppress::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturefxnoisesuppress8.idirectsoundcapturefxnoisesuppress8.getallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureFXNoiseSuppress::GetAllParameters([Out] DSCFXNoiseSuppress* pDscFxNoiseSuppress)</unmanaged>
<unmanaged-short>IDirectSoundCaptureFXNoiseSuppress::GetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.NoiseSuppress.Reset">
<summary>
The IDirectSoundCaptureFXNoiseSuppress8::Reset method resets the effect to its initial state.
</summary>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_OUTOFMEMORY.</p></returns>
<remarks>
<table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table> <p>Applications should not reset an effect except when necessary because it has entered an incorrect state. This might be done in response to user input. An effect must not be reset arbitrarily at startup, because another application might be using the same effect.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundCaptureFXNoiseSuppress::Reset']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundcapturefxnoisesuppress8.idirectsoundcapturefxnoisesuppress8.reset</msdn-id>
<unmanaged>HRESULT IDirectSoundCaptureFXNoiseSuppress::Reset()</unmanaged>
<unmanaged-short>IDirectSoundCaptureFXNoiseSuppress::Reset</unmanaged-short>
</member>
<member name="P:SharpDX.DirectSound.NoiseSuppress.Enabled">
<summary>
Gets or sets he noise suppression parameters of a buffer.
</summary>
</member>
<member name="T:SharpDX.DirectSound.ParametricEqualizer">
<summary>
<p>The IDirectSoundFXParamEq8 interface is used to set and retrieve effect parameters on a buffer that supports parametric equalizer effects.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSoundFXParamEq8 interface exposes the following methods.</p>IDirectSoundFXParamEq8 Members<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundFXParamEq8::GetAllParameters </td><td>The GetAllParameters method retrieves the parametric equalizer parameters of a buffer.
</td></tr> <tr><td>IDirectSoundFXParamEq8::SetAllParameters </td><td>The SetAllParameters method sets the parametric equalizer parameters of a buffer.
</td></tr> </table>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXParamEq']/*" />
<msdn-id>ee418238</msdn-id>
<unmanaged>IDirectSoundFXParamEq</unmanaged>
<unmanaged-short>IDirectSoundFXParamEq</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.ParametricEqualizer.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.ParametricEqualizer"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.ParametricEqualizer.op_Explicit(System.IntPtr)~SharpDX.DirectSound.ParametricEqualizer">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.ParametricEqualizer"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.ParametricEqualizer.AllParameters">
<summary>
The GetAllParameters method retrieves the parametric equalizer parameters of a buffer.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXParamEq::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxparameq8.idirectsoundfxparameq8.getallparameters</msdn-id>
<unmanaged>GetAllParameters / SetAllParameters</unmanaged>
<unmanaged-short>GetAllParameters</unmanaged-short>
<unmanaged>HRESULT IDirectSoundFXParamEq::GetAllParameters([Out] DSFXParamEq* pDsFxParamEq)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.ParametricEqualizer.SetAllParameters(SharpDX.DirectSound.ParametricEqualizerSettings)">
<summary>
The SetAllParameters method sets the parametric equalizer parameters of a buffer.
</summary>
<param name="cDsFxParamEqRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.ParametricEqualizerSettings" /> structure that specifies the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK or S_FALSE. See the Remarks for <see cref="T:SharpDX.DirectSound.ParametricEqualizerSettings" />. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXParamEq::SetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxparameq8.idirectsoundfxparameq8.setallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXParamEq::SetAllParameters([In] const DSFXParamEq* pcDsFxParamEq)</unmanaged>
<unmanaged-short>IDirectSoundFXParamEq::SetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.ParametricEqualizer.GetAllParameters(SharpDX.DirectSound.ParametricEqualizerSettings@)">
<summary>
The GetAllParameters method retrieves the parametric equalizer parameters of a buffer.
</summary>
<param name="dsFxParamEqRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.ParametricEqualizerSettings" /> structure that receives the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXParamEq::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxparameq8.idirectsoundfxparameq8.getallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXParamEq::GetAllParameters([Out] DSFXParamEq* pDsFxParamEq)</unmanaged>
<unmanaged-short>IDirectSoundFXParamEq::GetAllParameters</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.ParametricEqualizer.BandwidthDefault">
<summary>
Default bandwidth, in semitones.
</summary>
</member>
<member name="F:SharpDX.DirectSound.ParametricEqualizer.BandwidthMax">
<summary>
Maximum bandwidth, in semitones.
</summary>
</member>
<member name="F:SharpDX.DirectSound.ParametricEqualizer.BandwidthMin">
<summary>
Minimum bandwidth, in semitones.
</summary>
</member>
<member name="F:SharpDX.DirectSound.ParametricEqualizer.CenterDefault">
<summary>
Default center frequency, in hertz.
</summary>
</member>
<member name="F:SharpDX.DirectSound.ParametricEqualizer.CenterMax">
<summary>
Maximum center frequency, in hertz.
</summary>
</member>
<member name="F:SharpDX.DirectSound.ParametricEqualizer.CenterMin">
<summary>
Minimum center frequency, in hertz.
</summary>
</member>
<member name="F:SharpDX.DirectSound.ParametricEqualizer.GainDefault">
<summary>
Default gain.
</summary>
</member>
<member name="F:SharpDX.DirectSound.ParametricEqualizer.GainMax">
<summary>
Maximum gain.
</summary>
</member>
<member name="F:SharpDX.DirectSound.ParametricEqualizer.GainMin">
<summary>
Minimum gain.
</summary>
</member>
<member name="T:SharpDX.DirectSound.SecondarySoundBuffer">
<summary>
<p>The <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> interface is used to manage sound buffers.</p><p>The <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> interface supersedes <see cref="T:SharpDX.DirectSound.SoundBuffer" /> and adds new methods.</p><p>To obtain the interface, use the CreateSoundBuffer method to retrieve <see cref="T:SharpDX.DirectSound.SoundBuffer" />, and then pass IID_IDirectSoundBuffer8 to IDirectSoundBuffer::QueryInterface.</p><p>For the primary buffer, you must use the <see cref="T:SharpDX.DirectSound.SoundBuffer" /> interface; <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> is not available. <see cref="T:SharpDX.DirectSound.SoundBuffer" /> is not documented separately. For documentation, see the corresponding <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> methods.</p><p>Not all methods of <see cref="T:SharpDX.DirectSound.SoundBuffer" /> are valid for primary buffers. For example, SetCurrentPosition will fail. See the reference topics for individual methods.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> interface exposes the following methods, arranged by category.</p>Effects<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td><see cref="M:SharpDX.DirectSound.SecondarySoundBuffer.GetEffect(System.Guid,System.Int32,System.Guid,System.IntPtr@)" /> </td><td>The GetObjectInPath method retrieves an interface for an effect object associated with the buffer.
</td></tr> <tr><td><see cref="M:SharpDX.DirectSound.SecondarySoundBuffer.SetEffect(System.Int32,SharpDX.DirectSound.SoundBufferEffectDescription[],SharpDX.DirectSound.SoundEffectResult[])" /> </td><td>Number of elements in the pDSFXDesc and pdwResultCodes arrays. If this value is 0, pDSFXDesc and pdwResultCodes must both be <c>null</c>. Set to 0 to remove all effects from the buffer.
</td></tr> </table>Resource Management<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td><see cref="M:SharpDX.DirectSound.SecondarySoundBuffer.AcquireResources(System.Int32,System.Int32,System.Int32[])" /> </td><td>The AcquireResources method allocates resources for a buffer that was created with the <see cref="F:SharpDX.DirectSound.BufferFlags.Defer" /> flag in the DSBUFFERDESCDSBUFFERDESC
</td></tr> <tr><td>IDirectSoundBuffer8::Restore </td><td>The Restore method restores the memory allocation for a lost sound buffer.
</td></tr> </table>Play Management<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundBuffer8::GetCurrentPosition </td><td>The GetCurrentPosition method retrieves the position of the play and write cursors in the sound buffer.
</td></tr> <tr><td>IDirectSoundBuffer8::Lock </td><td>The Lock method readies all or part of the buffer for a data write and returns references to which data can be written.
</td></tr> <tr><td>IDirectSoundBuffer8::Play </td><td>The Play method causes the sound buffer to play, starting at the play cursor.
</td></tr> <tr><td>IDirectSoundBuffer8::SetCurrentPosition </td><td>The SetCurrentPosition method sets the position of the play cursor, which is the point at which the next byte of data is read from the buffer.
</td></tr> <tr><td>IDirectSoundBuffer8::Stop </td><td>The Stop method causes the sound buffer to stop playing.
</td></tr> <tr><td>IDirectSoundBuffer8::Unlock </td><td>The Unlock method releases a locked sound buffer.
</td></tr> </table>Sound Parameters<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundBuffer8::GetFrequency </td><td>The GetFrequency method retrieves the frequency, in samples per second, at which the buffer is playing.
</td></tr> <tr><td>IDirectSoundBuffer8::GetPan </td><td>The GetPan method retrieves the relative volume of the left and right audio channels.
</td></tr> <tr><td>IDirectSoundBuffer8::GetVolume </td><td>The GetVolume method retrieves the attenuation of the sound.
</td></tr> <tr><td>IDirectSoundBuffer8::SetFrequency </td><td>The SetFrequency method sets the frequency at which the audio samples are played.
</td></tr> <tr><td>IDirectSoundBuffer8::SetPan </td><td>The SetPan method sets the relative volume of the left and right channels.
</td></tr> <tr><td>IDirectSoundBuffer8::SetVolume </td><td>The SetVolume method sets the attenuation of the sound.
</td></tr> </table>Miscellaneous<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundBuffer8::GetCaps </td><td>The GetCaps method retrieves the capabilities of the buffer object.
</td></tr> <tr><td>IDirectSoundBuffer8::GetFormat </td><td>The GetFormat method retrieves a description of the format of the sound data in the buffer, or the buffer size needed to retrieve the format description.
</td></tr> <tr><td>IDirectSoundBuffer8::GetStatus </td><td>The GetStatus method retrieves the status of the sound buffer.
</td></tr> <tr><td>IDirectSoundBuffer8::Initialize </td><td>The Initialize method initializes a sound buffer object if it has not yet been initialized.
</td></tr> <tr><td>IDirectSoundBuffer8::SetFormat </td><td>The SetFormat method sets the format of the primary buffer. Whenever this application has the input focus, DirectSound will set the primary buffer to the specified format.
</td></tr> </table><p>The LPDIRECTSOUNDBUFFER8 type is defined as a reference to the <see cref="T:SharpDX.DirectSound.SoundBuffer" /> interface:</p><pre> typedef struct <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> *LPDIRECTSOUNDBUFFER8;
</pre>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer8']/*" />
<msdn-id>ee418055</msdn-id>
<unmanaged>IDirectSoundBuffer8</unmanaged>
<unmanaged-short>IDirectSoundBuffer8</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SecondarySoundBuffer.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.SecondarySoundBuffer.op_Explicit(System.IntPtr)~SharpDX.DirectSound.SecondarySoundBuffer">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="M:SharpDX.DirectSound.SecondarySoundBuffer.SetEffect(System.Int32,SharpDX.DirectSound.SoundBufferEffectDescription[],SharpDX.DirectSound.SoundEffectResult[])">
<summary>
The SetFX method enables effects on a buffer.<p>For this method to succeed, CoInitialize must have been called. Additionally, the buffer must not be playing or locked.</p>
</summary>
<param name="effectsCount"><dd> Number of elements in the pDSFXDesc and pdwResultCodes arrays. If this value is 0, pDSFXDesc and pdwResultCodes must both be <c>null</c>. Set to 0 to remove all effects from the buffer. </dd></param>
<param name="dSFXDescRef"><dd> Address of an array of <see cref="T:SharpDX.DirectSound.SoundBufferEffectDescription" /> structures, of size dwEffectsCount, that specifies the effects wanted on the buffer. Must be <c>null</c> if dwEffectsCount is 0. </dd></param>
<param name="esultCodesRef"><dd> Address of an array of DWORD elements, of size <em>dwEffectsCount</em>. Each element receives one of the values shown in the following table, indicating the result of the attempt to create the corresponding effect in the <em>pDSFXDesc</em> array. <table><tr><th>Note </th></tr><tr><td>This parameter must be <c>null</c> if <em>dwEffectsCount</em> is 0, or can be <c>null</c> if results are not wanted.</td></tr></table> <table> <tr><th>Value</th><th>Description</th></tr> <tr><td><see cref="F:SharpDX.DirectSound.I3DL2MaterialPreset.LocatedInHardware" /></td><td>Effect is instantiated in hardware.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.I3DL2MaterialPreset.LocatedInSoftware" /></td><td>Effect is instantiated in software.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.I3DL2MaterialPreset.Unallocated" /></td><td>Effect has not yet been assigned to hardware or software. This value is returned if the buffer was created with the <see cref="F:SharpDX.DirectSound.BufferFlags.Defer" /> flag in <see cref="T:SharpDX.DirectSound.SoundBufferDescription" />.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.I3DL2MaterialPreset.Failed" /></td><td>No effect was created because resources weren't available.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.I3DL2MaterialPreset.Present" /></td><td>Effect is available but was not created because one of the other effects requested could not be created. If any of the effects requested cannot be created, none of them are, and the call fails.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.I3DL2MaterialPreset.Unknown" /></td><td>Effect is not registered on the system, and the method failed as a result.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK or DS_INCOMPLETE. If the method fails, the return value may be one of the error values shown in the following table.</p> <table> <tr><th>Return code</th></tr> <tr><td>CO_E_NOTINITIALIZED</td></tr> <tr><td>DSERR_CONTROLUNAVAIL </td></tr> <tr><td>DSERR_GENERIC </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_INVALIDCALL </td></tr> <tr><td>DSERR_NOINTERFACE </td></tr> <tr><td>DSERR_PRIOLEVELNEEDED </td></tr> </table> <p>In addition, the method can return an error value from DMO methods, including <see cref="!:SharpDX.MediaFoundation.IMediaObject.SetInputType" /> and <see cref="!:SharpDX.MediaFoundation.IMediaObject.SetOutputType" />. See the DirectShow documentation for possible error values.</p></returns>
<remarks>
<p>If the method fails, the value for each effect in pdwResultCodes is either DSFXF_PRESENT or <see cref="F:SharpDX.DirectSound.I3DL2MaterialPreset.Unknown" />. Check these values to determine which effects caused the failure.</p> <p>For the method to succeed, the buffer must have been created with the <see cref="F:SharpDX.DirectSound.BufferFlags.ControlEffects" /> flag and must not be playing or locked.</p> <p>If the method returns DSERR_NOINTERFACE or another COM error, check the result code array for <see cref="F:SharpDX.DirectSound.I3DL2MaterialPreset.Present" /> or <see cref="F:SharpDX.DirectSound.I3DL2MaterialPreset.Unknown" /> to ascertain which effect caused the error. If the method returns DSERR_INVALIDPARAM, check the result codes for <see cref="F:SharpDX.DirectSound.I3DL2MaterialPreset.Failed" /> to see which effects failed to acquire resources.</p> <p>An effect must be set on a buffer before the effect interface can be obtained. To obtain the effect interface, use GetObjectInPath.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer8::SetFX']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.setfx</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer8::SetFX([In] unsigned int dwEffectsCount,[In, Buffer, Optional] DSEFFECTDESC* pDSFXDesc,[InOut, Buffer] DSOUND_ENUM_0* pdwResultCodes)</unmanaged>
<unmanaged-short>IDirectSoundBuffer8::SetFX</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SecondarySoundBuffer.AcquireResources(System.Int32,System.Int32,System.Int32[])">
<summary>
The AcquireResources method allocates resources for a buffer that was created with the <see cref="F:SharpDX.DirectSound.BufferFlags.Defer" /> flag in theDSBUFFERDESCstructure.
</summary>
<param name="flags">No documentation.</param>
<param name="effectsCount">No documentation.</param>
<param name="esultCodesRef">No documentation.</param>
<returns><p>If the method succeeds, the return value is DS_OK or DS_INCOMPLETE. If the method fails, the return value may be one of the error values shown in the following table.</p> <table> <tr><th>Return code</th></tr> <tr><td>DSERR_CONTROLUNAVAIL </td></tr> <tr><td>DSERR_INVALIDCALL </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> </table></returns>
<remarks>
<p>Normally, buffers created with <see cref="F:SharpDX.DirectSound.BufferFlags.Defer" /> are not allocated resources until Play is called. <see cref="M:SharpDX.DirectSound.SecondarySoundBuffer.AcquireResources(System.Int32,System.Int32,System.Int32[])" /> can be used to allocate resources for a deferred buffer before it is played. By doing so, the application can retrieve information about effects processing and set effect parameters. If the method fails, check the values in pdwResultCodes to determine which effects caused the failure.</p> <p>A buffer with acquired resources that is not yet playing is not a candidate for premature termination by the voice management flags passed to the Play method.</p> <p>Resources that have been acquired by AcquireResources are released when playback is stopped.</p> <p>If the method is called on a buffer on which it has already been called, the status of the effects is returned but no additional resources are allocated.</p> <p>The dwEffectsCount parameter to this function must be the same as the one passed in the call to SetFX.</p> <p>If an attempt is made to acquire resources for a buffer with the <see cref="F:SharpDX.DirectSound.BufferFlags.Hardware" /> flag on a system where hardware acceleration is not available, the method fails with either DSERR_CONTROLUNAVAIL or DSERR_INVALIDCALL, depending on the operating system.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer8::AcquireResources']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.acquireresources</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer8::AcquireResources([In] unsigned int dwFlags,[In] unsigned int dwEffectsCount,[Out, Buffer] unsigned int* pdwResultCodes)</unmanaged>
<unmanaged-short>IDirectSoundBuffer8::AcquireResources</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SecondarySoundBuffer.GetEffect(System.Guid,System.Int32,System.Guid,System.IntPtr@)">
<summary>
The GetObjectInPath method retrieves an interface for an effect object associated with the buffer.
</summary>
<param name="rguidObject"><dd> Unique class identifier of the object being searched for, such as <see cref="F:SharpDX.DirectSound.SoundEffectGuid.StandardEcho" />. Set this parameter to <see cref="F:SharpDX.DirectSound.DSound.AllObjects" /> to search for objects of any class. </dd></param>
<param name="index"><dd> Index of the object within objects of that class in the path. See Remarks. </dd></param>
<param name="rguidInterface"><dd> Unique identifier of the desired interface. See Remarks. </dd></param>
<param name="objectOut"><dd> Address of a variable that receives the desired interface reference. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_CONTROLUNAVAIL </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_OBJECTNOTFOUND </td></tr> </table></returns>
<remarks>
<p>Any DMO that has been set on a buffer by using SetFX can be retrieved, even it has not been allocated resources.</p> <p>The following interfaces can be retrieved for the various DMOs supplied with DirectX.</p> <table> <tr><td>rguidInterface
</td><td>*ppObject
</td></tr> <tr><td>IID_IDirectSoundFXGargle8
</td><td>IDirectSoundFXGargle8 </td></tr> <tr><td>IID_IDirectSoundFXChorus8
</td><td>IDirectSoundFXChorus8 </td></tr> <tr><td>IID_IDirectSoundFXFlanger8
</td><td>IDirectSoundFXFlanger8 </td></tr> <tr><td>IID_IDirectSoundFXEcho8
</td><td>IDirectSoundFXEcho8 </td></tr> <tr><td>IID_IDirectSoundFXDistortion8
</td><td>IDirectSoundFXDistortion8 </td></tr> <tr><td>IID_IDirectSoundFXCompressor8
</td><td>IDirectSoundFXCompressor8 </td></tr> <tr><td>IID_IDirectSoundFXParamEq8
</td><td>IDirectSoundFXParamEq8 </td></tr> <tr><td>IID_IDirectSoundFXWavesReverb8
</td><td>IDirectSoundFXWavesReverb8 </td></tr> <tr><td>IID_IDirectSoundFXI3DL2Reverb8
</td><td>IDirectSoundFXI3DL2Reverb8 </td></tr> </table> <p>In addition, the following interfaces are available for any of the standard DMOs. For information on these interfaces, see the Help for DirectX Media Objects.</p> <table> <tr><td>rguidInterface
</td><td>*ppObject
</td></tr> <tr><td>IID_IMediaObject
</td><td><see cref="!:SharpDX.MediaFoundation.IMediaObject" />
</td></tr> <tr><td>IID_IMediaObjectInPlace
</td><td><see cref="!:SharpDX.MediaFoundation.IMediaObjectInPlace" />
</td></tr> <tr><td>IID_IMediaParams
</td><td>IMediaParams
</td></tr> </table> <p>NoteWhen the DirectSound API is used to play buffers, parameter curves (envelopes) set by using the IMediaParams interface do not work, because DirectSound does not timestamp the DMO buffers.</p> <p>The value in dwIndex is the index of the object within the array of effects passed to SetFX. This is not necessarily the actual position of the object in the effects chain, because some effects might not have been created.</p> <p>An object is returned solely on the basis of whether it matches rguidObject and dwIndex. It is up to the application to ensure that rguidInterface specifies an interface that can be expected to be found on the object.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer8::GetObjectInPath']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.getobjectinpath</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer8::GetObjectInPath([In] const GUID&amp; rguidObject,[In] unsigned int dwIndex,[In] const GUID&amp; rguidInterface,[Out] void** ppObject)</unmanaged>
<unmanaged-short>IDirectSoundBuffer8::GetObjectInPath</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SecondarySoundBuffer.#ctor(SharpDX.DirectSound.DirectSound,SharpDX.DirectSound.SoundBufferDescription)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer"/> class.
</summary>
<param name="dSound">an instance of the <see cref="T:SharpDX.DirectSound.DirectSound"/></param>
<param name="bufferDescription">The buffer description.</param>
</member>
<member name="M:SharpDX.DirectSound.SecondarySoundBuffer.GetEffect``1(System.Int32)">
<summary>
Retrieves an interface to an effect object associated with the buffer.
</summary>
<param name="index">Index of the object within objects of that class in the path. See Remarks. </param>
<returns>an effect object associated with the buffer</returns>
<unmanaged>HRESULT IDirectSoundCaptureBuffer8::GetObjectInPath([In] GUID* rguidObject,[None] int dwIndex,[In] GUID* rguidInterface,[Out] void** ppObject)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.SecondarySoundBuffer.SetEffect(System.Guid[])">
<summary>
Enables effects on a buffer.
</summary>
<param name="effects">Effects guids</param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IDirectSoundBuffer8::SetFX([None] int dwEffectsCount,[In, Buffer, Optional] LPDSEFFECTDESC pDSFXDesc,[Out, Buffer, Optional] int* pdwResultCodes)</unmanaged>
</member>
<member name="T:SharpDX.DirectSound.SoundBuffer">
<summary>
<p>The <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> interface is used to manage sound buffers.</p><p>The <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> interface supersedes <see cref="T:SharpDX.DirectSound.SoundBuffer" /> and adds new methods.</p><p>To obtain the interface, use the CreateSoundBuffer method to retrieve <see cref="T:SharpDX.DirectSound.SoundBuffer" />, and then pass IID_IDirectSoundBuffer8 to IDirectSoundBuffer::QueryInterface.</p><p>For the primary buffer, you must use the <see cref="T:SharpDX.DirectSound.SoundBuffer" /> interface; <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> is not available. <see cref="T:SharpDX.DirectSound.SoundBuffer" /> is not documented separately. For documentation, see the corresponding <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> methods.</p><p>Not all methods of <see cref="T:SharpDX.DirectSound.SoundBuffer" /> are valid for primary buffers. For example, SetCurrentPosition will fail. See the reference topics for individual methods.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> interface exposes the following methods, arranged by category.</p>Effects<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td><see cref="M:SharpDX.DirectSound.SecondarySoundBuffer.GetEffect(System.Guid,System.Int32,System.Guid,System.IntPtr@)" /> </td><td>The GetObjectInPath method retrieves an interface for an effect object associated with the buffer.
</td></tr> <tr><td><see cref="M:SharpDX.DirectSound.SecondarySoundBuffer.SetEffect(System.Int32,SharpDX.DirectSound.SoundBufferEffectDescription[],SharpDX.DirectSound.SoundEffectResult[])" /> </td><td>Number of elements in the pDSFXDesc and pdwResultCodes arrays. If this value is 0, pDSFXDesc and pdwResultCodes must both be <c>null</c>. Set to 0 to remove all effects from the buffer.
</td></tr> </table>Resource Management<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td><see cref="M:SharpDX.DirectSound.SecondarySoundBuffer.AcquireResources(System.Int32,System.Int32,System.Int32[])" /> </td><td>The AcquireResources method allocates resources for a buffer that was created with the <see cref="F:SharpDX.DirectSound.BufferFlags.Defer" /> flag in the DSBUFFERDESCDSBUFFERDESC
</td></tr> <tr><td>IDirectSoundBuffer8::Restore </td><td>The Restore method restores the memory allocation for a lost sound buffer.
</td></tr> </table>Play Management<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundBuffer8::GetCurrentPosition </td><td>The GetCurrentPosition method retrieves the position of the play and write cursors in the sound buffer.
</td></tr> <tr><td>IDirectSoundBuffer8::Lock </td><td>The Lock method readies all or part of the buffer for a data write and returns references to which data can be written.
</td></tr> <tr><td>IDirectSoundBuffer8::Play </td><td>The Play method causes the sound buffer to play, starting at the play cursor.
</td></tr> <tr><td>IDirectSoundBuffer8::SetCurrentPosition </td><td>The SetCurrentPosition method sets the position of the play cursor, which is the point at which the next byte of data is read from the buffer.
</td></tr> <tr><td>IDirectSoundBuffer8::Stop </td><td>The Stop method causes the sound buffer to stop playing.
</td></tr> <tr><td>IDirectSoundBuffer8::Unlock </td><td>The Unlock method releases a locked sound buffer.
</td></tr> </table>Sound Parameters<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundBuffer8::GetFrequency </td><td>The GetFrequency method retrieves the frequency, in samples per second, at which the buffer is playing.
</td></tr> <tr><td>IDirectSoundBuffer8::GetPan </td><td>The GetPan method retrieves the relative volume of the left and right audio channels.
</td></tr> <tr><td>IDirectSoundBuffer8::GetVolume </td><td>The GetVolume method retrieves the attenuation of the sound.
</td></tr> <tr><td>IDirectSoundBuffer8::SetFrequency </td><td>The SetFrequency method sets the frequency at which the audio samples are played.
</td></tr> <tr><td>IDirectSoundBuffer8::SetPan </td><td>The SetPan method sets the relative volume of the left and right channels.
</td></tr> <tr><td>IDirectSoundBuffer8::SetVolume </td><td>The SetVolume method sets the attenuation of the sound.
</td></tr> </table>Miscellaneous<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundBuffer8::GetCaps </td><td>The GetCaps method retrieves the capabilities of the buffer object.
</td></tr> <tr><td>IDirectSoundBuffer8::GetFormat </td><td>The GetFormat method retrieves a description of the format of the sound data in the buffer, or the buffer size needed to retrieve the format description.
</td></tr> <tr><td>IDirectSoundBuffer8::GetStatus </td><td>The GetStatus method retrieves the status of the sound buffer.
</td></tr> <tr><td>IDirectSoundBuffer8::Initialize </td><td>The Initialize method initializes a sound buffer object if it has not yet been initialized.
</td></tr> <tr><td>IDirectSoundBuffer8::SetFormat </td><td>The SetFormat method sets the format of the primary buffer. Whenever this application has the input focus, DirectSound will set the primary buffer to the specified format.
</td></tr> </table><p>The LPDIRECTSOUNDBUFFER8 type is defined as a reference to the <see cref="T:SharpDX.DirectSound.SoundBuffer" /> interface:</p><pre> typedef struct <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> *LPDIRECTSOUNDBUFFER8;
</pre>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer']/*" />
<msdn-id>ee418055</msdn-id>
<unmanaged>IDirectSoundBuffer</unmanaged>
<unmanaged-short>IDirectSoundBuffer</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.SoundBuffer"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.op_Explicit(System.IntPtr)~SharpDX.DirectSound.SoundBuffer">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.SoundBuffer"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer.Capabilities">
<summary>
The GetCaps method retrieves the capabilities of the buffer object.
</summary>
<remarks>
<p>The <see cref="T:SharpDX.DirectSound.BufferCapabilities" /> structure contains similar information to the <see cref="T:SharpDX.DirectSound.SoundBufferDescription" /> structure passed to the CreateSoundBuffer method, with some additional information. This additional information can include the buffer's location, either in hardware or software, and performance measures.</p> <p>The flags specified in the dwFlags member of the <see cref="T:SharpDX.DirectSound.BufferCapabilities" /> structure are the same flags used by the <see cref="T:SharpDX.DirectSound.SoundBufferDescription" /> structure. The only difference is that in the <see cref="T:SharpDX.DirectSound.BufferCapabilities" /> structure, either <see cref="F:SharpDX.DirectSound.BufferFlags.Hardware" /> or <see cref="F:SharpDX.DirectSound.BufferFlags.Software" /> will be specified according to the location of the buffer memory. In the <see cref="T:SharpDX.DirectSound.SoundBufferDescription" /> structure, these flags are optional and, depending on which flag is specified, force the buffer to be located in either hardware or software.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::GetCaps']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.getcaps</msdn-id>
<unmanaged>GetCaps</unmanaged>
<unmanaged-short>GetCaps</unmanaged-short>
<unmanaged>HRESULT IDirectSoundBuffer::GetCaps([Out] DSBCAPS* pDSBufferCaps)</unmanaged>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer.Volume">
<summary>
The GetVolume method retrieves the attenuation of the sound.
</summary>
<remarks>
<p>The return value is between <see cref="F:SharpDX.DirectSound.Volume.Maximum" /> and <see cref="F:SharpDX.DirectSound.Volume.Minimum" />. These values are defined as 0 and ?10,000, respectively. The value <see cref="F:SharpDX.DirectSound.Volume.Maximum" /> represents the original, unadjusted volume of the sound. The value <see cref="F:SharpDX.DirectSound.Volume.Minimum" /> indicates an audio volume attenuated by 100 dB, which, for practical purposes, is silence.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::GetVolume']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.getvolume</msdn-id>
<unmanaged>GetVolume / SetVolume</unmanaged>
<unmanaged-short>GetVolume</unmanaged-short>
<unmanaged>HRESULT IDirectSoundBuffer::GetVolume([Out] int* plVolume)</unmanaged>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer.Pan">
<summary>
The GetPan method retrieves the relative volume of the left and right audio channels.
</summary>
<remarks>
<p>The returned value is measured in hundredths of a decibel (dB), in the range of DSBPAN_LEFT to DSBPAN_RIGHT. These values are defined in Dsound.h as -10,000 and 10,000 respectively. The value DSBPAN_LEFT means the right channel is effectively silent. The value DSBPAN_RIGHT means the left channel is effectively silent. The neutral value is DSBPAN_CENTER, defined as 0, which means that both channels are at full volume. When one channel is attenuated, the other remains at full volume.</p> <p>The pan control acts cumulatively with the volume control.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::GetPan']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.getpan</msdn-id>
<unmanaged>GetPan / SetPan</unmanaged>
<unmanaged-short>GetPan</unmanaged-short>
<unmanaged>HRESULT IDirectSoundBuffer::GetPan([Out] int* plPan)</unmanaged>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer.Frequency">
<summary>
The GetFrequency method retrieves the frequency, in samples per second, at which the buffer is playing.
</summary>
<remarks>
<p>The frequency value for software buffers is in the range of DSBFREQUENCY_MIN to DSBFREQUENCY_MAX, defined in Dsound.h. Hardware buffers can return other values.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::GetFrequency']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.getfrequency</msdn-id>
<unmanaged>GetFrequency / SetFrequency</unmanaged>
<unmanaged-short>GetFrequency</unmanaged-short>
<unmanaged>HRESULT IDirectSoundBuffer::GetFrequency([Out] unsigned int* pdwFrequency)</unmanaged>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer.Status">
<summary>
The GetStatus method retrieves the status of the sound buffer.
</summary>
<remarks>
<p><see cref="F:SharpDX.DirectSound.BufferStatus.Playing" /> is set if the buffer is being heard. Because of latency, a call to Play or Stop might not immediately change the status.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::GetStatus']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.getstatus</msdn-id>
<unmanaged>GetStatus</unmanaged>
<unmanaged-short>GetStatus</unmanaged-short>
<unmanaged>HRESULT IDirectSoundBuffer::GetStatus([Out] unsigned int* pdwStatus)</unmanaged>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer.CurrentPosition">
<summary>
The SetCurrentPosition method sets the position of the play cursor, which is the point at which the next byte of data is read from the buffer.
</summary>
<remarks>
<p>This method cannot be called on the primary buffer.</p> <p>If the buffer is playing, the cursor immediately moves to the new position and play continues from that point. If it is not playing, playback will begin from the new position the next time the Play method is called.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::SetCurrentPosition']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.setcurrentposition</msdn-id>
<unmanaged>SetCurrentPosition</unmanaged>
<unmanaged-short>SetCurrentPosition</unmanaged-short>
<unmanaged>HRESULT IDirectSoundBuffer::SetCurrentPosition([In] unsigned int dwNewPosition)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.GetCapabilities(SharpDX.DirectSound.BufferCapabilities@)">
<summary>
The GetCaps method retrieves the capabilities of the buffer object.
</summary>
<param name="dSBufferCapsRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.BufferCapabilities" /> structure to contain the capabilities of this sound buffer. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The <see cref="T:SharpDX.DirectSound.BufferCapabilities" /> structure contains similar information to the <see cref="T:SharpDX.DirectSound.SoundBufferDescription" /> structure passed to the CreateSoundBuffer method, with some additional information. This additional information can include the buffer's location, either in hardware or software, and performance measures.</p> <p>The flags specified in the dwFlags member of the <see cref="T:SharpDX.DirectSound.BufferCapabilities" /> structure are the same flags used by the <see cref="T:SharpDX.DirectSound.SoundBufferDescription" /> structure. The only difference is that in the <see cref="T:SharpDX.DirectSound.BufferCapabilities" /> structure, either <see cref="F:SharpDX.DirectSound.BufferFlags.Hardware" /> or <see cref="F:SharpDX.DirectSound.BufferFlags.Software" /> will be specified according to the location of the buffer memory. In the <see cref="T:SharpDX.DirectSound.SoundBufferDescription" /> structure, these flags are optional and, depending on which flag is specified, force the buffer to be located in either hardware or software.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::GetCaps']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.getcaps</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::GetCaps([Out] DSBCAPS* pDSBufferCaps)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::GetCaps</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.GetCurrentPosition(System.Int32@,System.Int32@)">
<summary>
The GetCurrentPosition method retrieves the position of the play and write cursors in the sound buffer.
</summary>
<param name="urrentPlayCursorRef"><dd> Address of a variable that receives the offset, in bytes, of the play cursor. This parameter can be <c>null</c> if the value is not wanted. </dd></param>
<param name="urrentWriteCursorRef"><dd> Address of a variable that receives the offset, in bytes, of the write cursor. This parameter can be <c>null</c> if the value is not wanted. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values: </p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_PRIOLEVELNEEDED </td></tr> </table></returns>
<remarks>
<p>The write cursor is the point in the buffer ahead of which it is safe to write data to the buffer. Data should not be written to the part of the buffer after the play cursor and before the write cursor.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::GetCurrentPosition']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.getcurrentposition</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::GetCurrentPosition([Out, Optional] unsigned int* pdwCurrentPlayCursor,[Out, Optional] unsigned int* pdwCurrentWriteCursor)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::GetCurrentPosition</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.GetFormat(SharpDX.Multimedia.WaveFormat[],System.Int32,System.Int32@)">
<summary>
The GetFormat method retrieves a description of the format of the sound data in the buffer, or the buffer size needed to retrieve the format description.
</summary>
<param name="wfxFormatRef"><dd> Address of a <see cref="T:SharpDX.Multimedia.WaveFormat" /> or <see cref="T:SharpDX.Multimedia.WaveFormatExtensible" /> structure that receives a description of the sound data in the buffer. To retrieve the buffer size needed to contain the format description, specify <c>null</c>. In this case the variable at pdwSizeWritten receives the size of the structure needed to receive the data. </dd></param>
<param name="sizeAllocated"><dd> Size, in bytes, of the structure at pwfxFormat. If pwfxFormat is not <c>null</c>, this value must be equal to or greater than the size of the expected data. </dd></param>
<param name="izeWrittenRef"><dd> Address of a variable that receives the number of bytes written to the structure at pwfxFormat. This parameter can be <c>null</c>. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The format structure can have a variable length that depends on the format. Before retrieving the format description, the application should query the buffer object for the size of the format by calling this method and specifying <c>null</c> for the pwfxFormat parameter. The necessary size of the structure is returned in the pdwSizeWritten parameter. The application can then allocate sufficient memory and call GetFormat again to retrieve the format description.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::GetFormat']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.getformat</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::GetFormat([Out, Buffer, Optional] WAVEFORMATEX* pwfxFormat,[In] unsigned int dwSizeAllocated,[Out, Optional] unsigned int* pdwSizeWritten)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::GetFormat</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.GetVolume(System.Int32@)">
<summary>
The GetVolume method retrieves the attenuation of the sound.
</summary>
<param name="lVolumeRef"><dd> Address of a variable that receives the attenuation, in hundredths of a decibel. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_CONTROLUNAVAIL </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_PRIOLEVELNEEDED </td></tr> </table></returns>
<remarks>
<p>The return value is between <see cref="F:SharpDX.DirectSound.Volume.Maximum" /> and <see cref="F:SharpDX.DirectSound.Volume.Minimum" />. These values are defined as 0 and ?10,000, respectively. The value <see cref="F:SharpDX.DirectSound.Volume.Maximum" /> represents the original, unadjusted volume of the sound. The value <see cref="F:SharpDX.DirectSound.Volume.Minimum" /> indicates an audio volume attenuated by 100 dB, which, for practical purposes, is silence.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::GetVolume']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.getvolume</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::GetVolume([Out] int* plVolume)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::GetVolume</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.GetPan(System.Int32@)">
<summary>
The GetPan method retrieves the relative volume of the left and right audio channels.
</summary>
<param name="lPanRef"><dd> Address of a variable that receives the relative volume, in hundredths of a decibel. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_CONTROLUNAVAIL </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_PRIOLEVELNEEDED </td></tr> </table></returns>
<remarks>
<p>The returned value is measured in hundredths of a decibel (dB), in the range of DSBPAN_LEFT to DSBPAN_RIGHT. These values are defined in Dsound.h as -10,000 and 10,000 respectively. The value DSBPAN_LEFT means the right channel is effectively silent. The value DSBPAN_RIGHT means the left channel is effectively silent. The neutral value is DSBPAN_CENTER, defined as 0, which means that both channels are at full volume. When one channel is attenuated, the other remains at full volume.</p> <p>The pan control acts cumulatively with the volume control.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::GetPan']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.getpan</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::GetPan([Out] int* plPan)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::GetPan</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.GetFrequency(System.Int32@)">
<summary>
The GetFrequency method retrieves the frequency, in samples per second, at which the buffer is playing.
</summary>
<param name="requencyRef"><dd> Address of a variable that receives the frequency at which the audio buffer is being played, in hertz. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_CONTROLUNAVAIL </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_PRIOLEVELNEEDED </td></tr> </table></returns>
<remarks>
<p>The frequency value for software buffers is in the range of DSBFREQUENCY_MIN to DSBFREQUENCY_MAX, defined in Dsound.h. Hardware buffers can return other values.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::GetFrequency']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.getfrequency</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::GetFrequency([Out] unsigned int* pdwFrequency)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::GetFrequency</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.GetStatus(System.Int32@)">
<summary>
The GetStatus method retrieves the status of the sound buffer.
</summary>
<param name="tatusRef"><dd> Address of a variable that receives the status of the sound buffer. The status can be a combination of the following flags: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.BufferStatus.BufferLost" /></td><td>The buffer is lost and must be restored before it can be played or locked.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.BufferStatus.Looping" /></td><td>The buffer is being looped. If this value is not set, the buffer will stop when it reaches the end of the sound data. This value is returned only in combination with <see cref="F:SharpDX.DirectSound.BufferStatus.Playing" />.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.BufferStatus.Playing" /></td><td>The buffer is playing. If this value is not set, the buffer is stopped.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.BufferStatus.Software" /></td><td>The buffer is playing in software. Set only for buffers created with the <see cref="F:SharpDX.DirectSound.BufferFlags.Defer" /> flag.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.BufferStatus.Hardware" /></td><td>The buffer is playing in hardware. Set only for buffers created with the <see cref="F:SharpDX.DirectSound.BufferFlags.Defer" /> flag.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.BufferStatus.Terminated" /></td><td>The buffer was prematurely terminated by the voice manager and is not playing. Set only for buffers created with the <see cref="F:SharpDX.DirectSound.BufferFlags.Defer" /> flag.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p><see cref="F:SharpDX.DirectSound.BufferStatus.Playing" /> is set if the buffer is being heard. Because of latency, a call to Play or Stop might not immediately change the status.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::GetStatus']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.getstatus</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::GetStatus([Out] unsigned int* pdwStatus)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::GetStatus</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.Initialize(SharpDX.DirectSound.DirectSoundBase,SharpDX.DirectSound.SoundBufferDescription)">
<summary>
The Initialize method initializes a sound buffer object if it has not yet been initialized.
</summary>
<param name="directSoundRef"><dd> Address of the device object associated with this buffer. </dd></param>
<param name="cDSBufferDescRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.SoundBufferDescription" /> structure that contains the values used to initialize this sound buffer. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values.</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_ALREADYINITIALIZED </td></tr> </table></returns>
<remarks>
<p>Because the CreateSoundBuffer method calls Initialize internally, applications do not need to call this method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::Initialize']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.initialize</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::Initialize([In] IDirectSound* pDirectSound,[In] const DSBUFFERDESC* pcDSBufferDesc)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::Initialize</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.Lock(System.Int32,System.Int32,System.IntPtr@,System.Int32@,System.IntPtr@,System.Int32@,SharpDX.DirectSound.LockFlags)">
<summary>
The Lock method readies all or part of the buffer for a data write and returns references to which data can be written.
</summary>
<param name="offset"><dd> Offset, in bytes, from the start of the buffer to the point where the lock begins. This parameter is ignored if <see cref="F:SharpDX.DirectSound.LockFlags.FromWriteCursor" /> is specified in the dwFlags parameter. </dd></param>
<param name="bytes"><dd> Size, in bytes, of the portion of the buffer to lock. The buffer is conceptually circular, so this number can exceed the number of bytes between dwOffset and the end of the buffer. </dd></param>
<param name="dioPtr1Out"><dd> Address of a variable that receives a reference to the first locked part of the buffer. </dd></param>
<param name="udioBytes1Ref"><dd> Address of a variable that receives the number of bytes in the block at ppvAudioPtr1. If this value is less than dwBytes, the lock has wrapped and ppvAudioPtr2 points to a second block of data at the beginning of the buffer. </dd></param>
<param name="dioPtr2Out"><dd> Address of a variable that receives a reference to the second locked part of the capture buffer. If <c>null</c> is returned, the ppvAudioPtr1 parameter points to the entire locked portion of the capture buffer. </dd></param>
<param name="udioBytes2Ref"><dd> Address of a variable that receives the number of bytes in the block at ppvAudioPtr2. If ppvAudioPtr2 is <c>null</c>, this value is zero. </dd></param>
<param name="flags"><dd> Flags modifying the lock event. The following flags are defined: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.LockFlags.FromWriteCursor" /></td><td>Start the lock at the write cursor. The dwOffset parameter is ignored.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.LockFlags.EntireBuffer" /></td><td>Lock the entire buffer. The dwBytes parameter is ignored.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_BUFFERLOST</td></tr> <tr><td>DSERR_INVALIDCALL</td></tr> <tr><td>DSERR_INVALIDPARAM</td></tr> <tr><td>DSERR_PRIOLEVELNEEDED</td></tr> </table></returns>
<remarks>
<p>This method accepts an offset and a byte count, and returns two write references and their associated sizes. If the locked portion does not extend to the end of the buffer and wrap to the beginning, the second reference, ppvAudioBytes2, receives <c>null</c>. If the lock does wrap, ppvAudioBytes2 points to the beginning of the buffer.</p> <p>If the application passes <c>null</c> for the ppvAudioPtr2 and pdwAudioBytes2 parameters, the lock extends no further than the end of the buffer and does not wrap.</p> <p>After writing data to the references returned by this method, the application must immediately call Unlock to notify DirectSound that the data is ready for playback. Failure to do so can cause audio breakup or silence on some sound device configurations.</p> <p>This method returns write references only. The application should not try to read sound data from this reference, because the data might not be valid. For example, if the buffer is located in on-card memory, the reference might be an address to a temporary buffer in system memory. When IDirectSoundBuffer8::Unlock is called, the contents of this temporary buffer are transferred to the on-card memory.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::Lock']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.lock</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::Lock([In] unsigned int dwOffset,[In] unsigned int dwBytes,[Out] void** ppvAudioPtr1,[Out] unsigned int* pdwAudioBytes1,[Out] void** ppvAudioPtr2,[Out, Optional] unsigned int* pdwAudioBytes2,[In] DSBLOCK_ENUM dwFlags)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::Lock</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.Play(System.Int32,System.Int32,SharpDX.DirectSound.PlayFlags)">
<summary>
The Play method causes the sound buffer to play, starting at the play cursor.
</summary>
<param name="reserved1"><dd> Reserved. Must be 0. </dd></param>
<param name="priority"><dd> Priority for the sound, used by the voice manager when assigning hardware mixing resources. The lowest priority is 0, and the highest priority is 0xFFFFFFFF. If the buffer was not created with the <see cref="F:SharpDX.DirectSound.BufferFlags.Defer" /> flag, this value must be 0. </dd></param>
<param name="flags"><dd> Flags specifying how to play the buffer. The following flags are defined: <p>Looping flag</p> <table> <tr><td>Value</td><td>Description</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.PlayFlags.Looping" /></td><td>After the end of the audio buffer is reached, play restarts at the beginning of the buffer. Play continues until explicitly stopped. This flag must be set when playing a primary buffer.</td></tr> </table> <p>Voice allocation flags</p> <p>The voice allocation flags are valid only for buffers created with the <see cref="F:SharpDX.DirectSound.BufferFlags.Defer" /> flag. One of the following flags can be used to force the processing of the sound into hardware or software. If neither DBSPLAY_LOCHARDWARE nor DBSPLAY_LOCSOFTWARE is set, the sound is played in either software or hardware, depending on the availability of resources at the time the method is called. See Remarks.</p> <table> <tr><td>Value</td><td>Description</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.PlayFlags.Hardware" /></td><td>Play this voice in a hardware buffer only. If the hardware has no available voices and no voice management flags are set, the call to IDirectSoundBuffer8::Play fails. This flag cannot be combined with <see cref="F:SharpDX.DirectSound.PlayFlags.Software" />.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.PlayFlags.Software" /></td><td>Play this voice in a software buffer only. This flag cannot be combined with <see cref="F:SharpDX.DirectSound.PlayFlags.Hardware" /> or any voice management flag.</td></tr> </table> <p>Voice management flags</p> <p>The voice management flags are valid only for buffers created with the <see cref="F:SharpDX.DirectSound.BufferFlags.Defer" /> flag, and are used for sounds that are to play in hardware. These flags enable hardware resources that are already in use to be yielded to the current sound. Only buffers created with the <see cref="F:SharpDX.DirectSound.BufferFlags.Defer" /> flag are candidates for premature termination. See Remarks.</p> <table> <tr><td>Value</td><td>Description</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.PlayFlags.TerminateByTime" /></td><td>If the hardware has no available voices, a currently playing nonlooping buffer will be stopped to make room for the new buffer. The buffer prematurely terminated is the one with the least time left to play.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.PlayFlags.TerminateByDistance" /></td><td>If the hardware has no available voices, a currently playing buffer will be stopped to make room for the new buffer. The buffer prematurely terminated will be selected from buffers that have the buffer's DSBCAPS_ MUTE3DATMAXDISTANCE flag set and are beyond their maximum distance. If there are no such buffers, the method fails.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.PlayFlags.TerminateByPriority" /></td><td>If the hardware has no available voices, a currently playing buffer will be stopped to make room for the new buffer. The buffer prematurely terminated will be the one with the lowest priority as set by the dwPriority parameter passed to IDirectSoundBuffer8::Play for the buffer.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_BUFFERLOST</td></tr> <tr><td>DSERR_INVALIDCALL </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_PRIOLEVELNEEDED </td></tr> </table></returns>
<remarks>
<p>If SetCooperativeLevel has not been called, the method returns DS_OK, but no sound will be produced until a cooperative level has been set.</p> <p>If the application is multithreaded, the thread that plays the buffer must continue to exist as long as the buffer is playing. Buffers created on WDM drivers stop playing when the thread is terminated.</p> <p>If the buffer specified in the method is already playing, the call to the method succeeds and the buffer continues to play. However, the flags defined in the most recent call supersede flags defined in previous calls.</p> <p>When called on the primary buffer, this method causes the buffer to start playing to the sound device. If the application has set the <see cref="F:SharpDX.DirectSound.CooperativeLevel.WritePrimary" /> cooperative level, any audio data put in the primary buffer by the application is sent to the sound device. Under any other cooperative level, the primary buffer plays silence if no secondary buffers are playing. Primary buffers must be played with the <see cref="F:SharpDX.DirectSound.PlayFlags.Looping" /> flag set.</p> <p>If the method is called with a voice allocation or voice management flag set on a buffer that was not created with the <see cref="F:SharpDX.DirectSound.BufferFlags.Defer" /> flag, the call fails with DSERR_INVALIDPARAM.</p> <p><see cref="F:SharpDX.DirectSound.PlayFlags.TerminateByTime" /> and <see cref="F:SharpDX.DirectSound.PlayFlags.TerminateByDistance" /> cannot be combined, but either may be combined with <see cref="F:SharpDX.DirectSound.PlayFlags.TerminateByPriority" />, in which case the <see cref="F:SharpDX.DirectSound.PlayFlags.TerminateByTime" /> or <see cref="F:SharpDX.DirectSound.PlayFlags.TerminateByDistance" /> flag is used to determine which buffer should be terminated in the event of a priority tie.</p> <p>The following table shows the behavior of the method under various combinations of the voice allocation and voice management flags when no free hardware voices are available.</p> <table> <tr><td> </td><td><see cref="F:SharpDX.DirectSound.PlayFlags.Hardware" />
</td><td>Neither <see cref="F:SharpDX.DirectSound.PlayFlags.Hardware" /> nor <see cref="F:SharpDX.DirectSound.PlayFlags.Software" />
</td><td><see cref="F:SharpDX.DirectSound.PlayFlags.Software" />
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.PlayFlags.TerminateByTime" />
</td><td>Sound with least time left to play is terminated and the new sound plays on the released voice.
</td><td>Sound with least time left to play is terminated and the new sound plays on the released voice.
</td><td>New sound plays in software.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.PlayFlags.TerminateByDistance" />
</td><td>If any sounds currently playing in hardware are beyond their maximum distance and have the <see cref="F:SharpDX.DirectSound.BufferFlags.Mute3DAtMaxDistance" /> flag set, one of them is terminated and the new sound plays in hardware. Otherwise, the call fails.
</td><td>If any sounds currently playing in hardware are beyond their maximum distance and have the <see cref="F:SharpDX.DirectSound.BufferFlags.Mute3DAtMaxDistance" /> flag set, one of them is terminated and the new sound plays in hardware. Otherwise, the new sound plays in software.
</td><td>New sound plays in software.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.PlayFlags.TerminateByPriority" />
</td><td>If the new sound's priority is higher than or equal to that of any sound currently playing in hardware, one of the lowest-priority sounds is terminated and the new sound plays in hardware. Otherwise, the call fails.
</td><td>If the new sound's priority is higher than or equal to that of any sound currently playing in hardware, one of the lowest-priority sounds is terminated and the new sound plays in hardware. Otherwise, the new sound plays in software.
</td><td>New sound plays in software.
</td></tr> </table>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::Play']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.play</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::Play([In] unsigned int dwReserved1,[In] unsigned int dwPriority,[In] DSBPLAY_FLAGS dwFlags)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::Play</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.SetCurrentPosition(System.Int32)">
<summary>
The SetCurrentPosition method sets the position of the play cursor, which is the point at which the next byte of data is read from the buffer.
</summary>
<param name="newPosition"><dd> Offset of the play cursor, in bytes, from the beginning of the buffer. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDCALL </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_PRIOLEVELNEEDED </td></tr> </table></returns>
<remarks>
<p>This method cannot be called on the primary buffer.</p> <p>If the buffer is playing, the cursor immediately moves to the new position and play continues from that point. If it is not playing, playback will begin from the new position the next time the Play method is called.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::SetCurrentPosition']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.setcurrentposition</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::SetCurrentPosition([In] unsigned int dwNewPosition)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::SetCurrentPosition</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.SetFormat(System.IntPtr)">
<summary>
The SetFormat method sets the format of the primary buffer. Whenever this application has the input focus, DirectSound will set the primary buffer to the specified format.
</summary>
<param name="cfxFormatRef"><dd> Address of a <see cref="T:SharpDX.Multimedia.WaveFormat" /> structure that describes the new format for the primary sound buffer. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_BADFORMAT </td></tr> <tr><td>DSERR_INVALIDCALL </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_OUTOFMEMORY </td></tr> <tr><td>DSERR_PRIOLEVELNEEDED </td></tr> <tr><td>DSERR_UNSUPPORTED </td></tr> </table></returns>
<remarks>
<p>The format of the primary buffer should be set before secondary buffers are created.</p> <p>The method fails if the application has the <see cref="F:SharpDX.DirectSound.CooperativeLevel.Normal" /> cooperative level.</p> <p>If the application is using DirectSound at the <see cref="F:SharpDX.DirectSound.CooperativeLevel.WritePrimary" /> cooperative level, and the format is not supported, the method fails.</p> <p>If the cooperative level is <see cref="F:SharpDX.DirectSound.CooperativeLevel.Priority" />, DirectSound stops the primary buffer, changes the format, and restarts the buffer. The method succeeds even if the hardware does not support the requested format; DirectSound sets the buffer to the closest supported format. To determine whether this has happened, an application can call the GetFormat method for the primary buffer and compare the result with the format that was requested with the SetFormat method.</p> <p>This method is not available for secondary sound buffers. If a new format is required, the application must create a new DirectSoundBuffer object.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::SetFormat']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.setformat</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::SetFormat([In] const void* pcfxFormat)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::SetFormat</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.SetVolume(System.Int32)">
<summary>
The SetVolume method sets the attenuation of the sound.
</summary>
<param name="volume"><dd> Attenuation, in hundredths of a decibel (dB). </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_CONTROLUNAVAIL </td></tr> <tr><td>DSERR_GENERIC </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_PRIOLEVELNEEDED </td></tr> </table></returns>
<remarks>
<p>Allowable values are between <see cref="F:SharpDX.DirectSound.Volume.Maximum" /> (no attenuation) and <see cref="F:SharpDX.DirectSound.Volume.Minimum" /> (silence). These values are defined in Dsound.h as 0 and ?10,000 respectively. The value <see cref="F:SharpDX.DirectSound.Volume.Maximum" /> represents the original, unadjusted volume of the stream. The value <see cref="F:SharpDX.DirectSound.Volume.Minimum" /> indicates an audio volume attenuated by 100 dB, which, for all practical purposes, is silence. DirectSound does not support amplification.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::SetVolume']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.setvolume</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::SetVolume([In] int lVolume)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::SetVolume</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.SetPan(System.Int32)">
<summary>
The SetPan method sets the relative volume of the left and right channels.
</summary>
<param name="pan"><dd> Relative volume between the left and right channels. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_CONTROLUNAVAIL </td></tr> <tr><td>DSERR_GENERIC </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_PRIOLEVELNEEDED </td></tr> </table></returns>
<remarks>
<p>The returned value is measured in hundredths of a decibel (dB), in the range of DSBPAN_LEFT to DSBPAN_RIGHT. These values are defined in Dsound.h as -10,000 and 10,000 respectively. The value DSBPAN_LEFT means the right channel is attenuated by 100 dB and is effectively silent. The value DSBPAN_RIGHT means the left channel is silent. The neutral value is DSBPAN_CENTER, defined as 0, which means that both channels are at full volume. When one channel is attenuated, the other remains at full volume.</p> <p>The pan control acts cumulatively with the volume control.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::SetPan']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.setpan</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::SetPan([In] int lPan)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::SetPan</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.SetFrequency(System.Int32)">
<summary>
The SetFrequency method sets the frequency at which the audio samples are played.
</summary>
<param name="frequency"><dd> Frequency, in hertz (Hz), at which to play the audio samples. A value of DSBFREQUENCY_ORIGINAL resets the frequency to the default value of the buffer format. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_CONTROLUNAVAIL </td></tr> <tr><td>DSERR_GENERIC </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_PRIOLEVELNEEDED </td></tr> </table></returns>
<remarks>
<p>Increasing or decreasing the frequency changes the perceived pitch of the audio data. This method does not affect the format of the buffer.</p> <p>Before setting the frequency, you should ascertain whether the frequency is supported by checking the dwMinSecondarySampleRate and dwMaxSecondarySampleRate members of the <see cref="T:SharpDX.DirectSound.Capabilities" /> structure for the device. Some operating systems do not support frequencies greater than 100,000 Hz.</p> <p>This method is not valid for the primary buffer.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::SetFrequency']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.setfrequency</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::SetFrequency([In] unsigned int dwFrequency)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::SetFrequency</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.Stop">
<summary>
The Stop method causes the sound buffer to stop playing.
</summary>
<returns><p>If the method succeeds, the return value is DS_OK. Returns an error code if the method fails.</p></returns>
<remarks>
<p>For secondary sound buffers, IDirectSoundBuffer8::Stop sets the play cursor to the sample that follows the last sample played. This means that when the Play method is next called on the buffer, it will continue playing where it left off.</p> <p>For the primary buffer, if an application has the <see cref="F:SharpDX.DirectSound.CooperativeLevel.WritePrimary" /> level, this method will stop the buffer and reset the play cursor to 0 (the beginning of the buffer). This is necessary because the primary buffers on most sound cards can play only from the beginning of the buffer.</p> <p>However, if IDirectSoundBuffer8::Stop is called on a primary buffer and the application has a cooperative level other than <see cref="F:SharpDX.DirectSound.CooperativeLevel.WritePrimary" />, this method simply reverses the effects of IDirectSoundBuffer8::Play. It configures the primary buffer to stop if no secondary buffers are playing. If other buffers are playing in this or other applications, the primary buffer will not actually stop until they are stopped. This method is useful because playing the primary buffer consumes processing overhead even if the buffer is playing sound data with the amplitude of 0 decibels.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::Stop']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.stop</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::Stop()</unmanaged>
<unmanaged-short>IDirectSoundBuffer::Stop</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.Unlock(System.IntPtr,System.Int32,System.IntPtr,System.Int32)">
<summary>
The Unlock method releases a locked sound buffer.
</summary>
<param name="vAudioPtr1Ref"><dd> Address of the value retrieved in the ppvAudioPtr1 parameter of the Lock method. </dd></param>
<param name="audioBytes1"><dd> Number of bytes written to the portion of the buffer at pvAudioPtr1. See Remarks. </dd></param>
<param name="vAudioPtr2Ref"><dd> Address of the value retrieved in the ppvAudioPtr2 parameter of the IDirectSoundBuffer8::Lock method. </dd></param>
<param name="audioBytes2"><dd> Number of bytes written to the portion of the buffer at pvAudioPtr2. See Remarks. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDCALL </td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_PRIOLEVELNEEDED </td></tr> </table></returns>
<remarks>
<p>An application must pass both references, pvAudioPtr1 and pvAudioPtr2, returned by the IDirectSoundBuffer8::Lock method to ensure the correct pairing of IDirectSoundBuffer8::Lock and IDirectSoundBuffer8::Unlock. The second reference is needed even if nothing was written to the second reference.</p> <p>The values in dwAudioBytes1 and dwAudioBytes2 must specify the number of bytes actually written to each part of the buffer, which might be less than the size of the lock. DirectSound uses these values to determine how much data to commit to the device.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::Unlock']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.unlock</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::Unlock([In, Buffer] void* pvAudioPtr1,[In] unsigned int dwAudioBytes1,[In, Buffer, Optional] void* pvAudioPtr2,[In] unsigned int dwAudioBytes2)</unmanaged>
<unmanaged-short>IDirectSoundBuffer::Unlock</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.Restore">
<summary>
The Restore method restores the memory allocation for a lost sound buffer.
</summary>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values:</p> <p>Return code</p> <ul> <li><p>DSERR_BUFFERLOST</p></li> <li><p>DSERR_INVALIDCALL</p></li> <li><p>DSERR_PRIOLEVELNEEDED</p></li> </ul></returns>
<remarks>
<p>If the application does not have the input focus, IDirectSoundBuffer8::Restore might not succeed. For example, if the application with the input focus has the <see cref="F:SharpDX.DirectSound.CooperativeLevel.WritePrimary" /> cooperative level, no other application will be able to restore its buffers. Similarly, an application with the <see cref="F:SharpDX.DirectSound.CooperativeLevel.WritePrimary" /> cooperative level must have the input focus to restore its primary buffer.</p> <p>After DirectSound restores the buffer memory, the application must rewrite the buffer with valid sound data. DirectSound cannot restore the contents of the memory, only the memory itself.</p> <p>The application can receive notification that a buffer is lost when it specifies that buffer in a call to the Lock or Play method. These methods return DSERR_BUFFERLOST to indicate a lost buffer. The GetStatus method can also be used to retrieve the status of the sound buffer and test for the <see cref="F:SharpDX.DirectSound.BufferStatus.BufferLost" /> flag.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::Restore']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundbuffer8.idirectsoundbuffer8.restore</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::Restore()</unmanaged>
<unmanaged-short>IDirectSoundBuffer::Restore</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.Play(System.Int32,SharpDX.DirectSound.PlayFlags)">
<unmanaged>HRESULT IDirectSoundBuffer::Play([None] int dwReserved1,[None] int dwPriority,[None] int dwFlags)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.Lock(System.Int32,System.Int32,SharpDX.DirectSound.LockFlags,SharpDX.DataStream@)">
<summary>
The Lock method readies all or part of the buffer for a data write and returns pointers to which data can be written.
</summary>
<param name="offset"> Offset, in bytes, from the start of the buffer to the point where the lock begins. This parameter is ignored if DSBLOCK_FROMWRITECURSOR is specified in the dwFlags parameter. </param>
<param name="sizeBytes"> Size, in bytes, of the portion of the buffer to lock. The buffer is conceptually circular, so this number can exceed the number of bytes between dwOffset and the end of the buffer. </param>
<param name="flags"> Flags modifying the lock event. The following flags are defined: ValueDescription DSBLOCK_FROMWRITECURSORStart the lock at the write cursor. The dwOffset parameter is ignored. DSBLOCK_ENTIREBUFFERLock the entire buffer. The dwBytes parameter is ignored. </param>
<param name="secondPart"> Address of a variable that receives a pointer to the second locked part of the capture buffer. If NULL is returned, the ppvAudioPtr1 parameter points to the entire locked portion of the capture buffer. </param>
<returns>Address of a variable that receives a pointer to the first locked part of the buffer.</returns>
<unmanaged>HRESULT IDirectSoundBuffer::Lock([None] int dwOffset,[None] int dwBytes,[Out] void** ppvAudioPtr1,[Out] int* pdwAudioBytes1,[Out] void** ppvAudioPtr2,[Out, Optional] int* pdwAudioBytes2,[None] int dwFlags)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.Unlock(SharpDX.DataStream,SharpDX.DataStream)">
<summary>
The Unlock method releases a locked sound buffer.
</summary>
<param name="dataPart1"> Address of the value retrieved in the ppvAudioPtr1 parameter of the {{Lock}} method. </param>
<param name="dataPart2"> Address of the value retrieved in the ppvAudioPtr2 parameter of the IDirectSoundBuffer8::Lock method. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IDirectSoundBuffer::Unlock([In, Buffer] void* pvAudioPtr1,[None] int dwAudioBytes1,[In, Buffer, Optional] void* pvAudioPtr2,[None] int dwAudioBytes2)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.Write``1(``0[],System.Int32,SharpDX.DirectSound.LockFlags)">
<summary>
Writes data to the buffer.
</summary>
<typeparam name="T"></typeparam>
<param name="data">The data.</param>
<param name="bufferOffset">The buffer offset.</param>
<param name="flags">The flags.</param>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.Write``1(``0[],System.Int32,System.Int32,System.Int32,SharpDX.DirectSound.LockFlags)">
<summary>
Writes data to the buffer.
</summary>
<typeparam name="T"></typeparam>
<param name="data">The data.</param>
<param name="startIndex">The start index.</param>
<param name="count">The count.</param>
<param name="bufferOffset">The buffer offset.</param>
<param name="flags">The flags.</param>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer.SetNotificationPositions(SharpDX.DirectSound.NotificationPosition[])">
<summary>
Sets the notification positions.
</summary>
<param name="positions">The positions.</param>
<returns></returns>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer.Format">
<summary>
Sets the new format for the primary sound buffer.
</summary>
<value>
The wave format.
</value>
<!-- No matching elements were found for the following include tag --><include file="Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundBuffer::SetFormat']/*" />
<unmanaged>HRESULT IDirectSoundBuffer::SetFormat([In] const WAVEFORMATEX* pcfxFormat)</unmanaged>
</member>
<member name="T:SharpDX.DirectSound.SoundBuffer3D">
<summary>
<p>The IDirectSound3DBuffer8 interface is used to retrieve and set parameters that describe the position, orientation, and environment of a sound buffer in 3D space.</p><p>IDirectSound3DBuffer8 is a define for <see cref="T:SharpDX.DirectSound.SoundBuffer3D" />. The two interface names are interchangeable.</p><p>The IDirectSound3DBuffer8 interface is obtained from a buffer that was created with the <see cref="F:SharpDX.DirectSound.BufferFlags.Control3D" /> flag. You can get it from the <see cref="T:SharpDX.DirectSound.SecondarySoundBuffer" /> interface by using the QueryInterface method.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSound3DBuffer8 interface exposes the following methods, arranged by category.</p>3D mode<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSound3DBuffer8::GetMode </td><td>The GetMode method retrieves the operation mode for 3D sound processing.
</td></tr> <tr><td>IDirectSound3DBuffer8::SetMode </td><td>The SetMode method sets the operation mode for 3D sound processing.
</td></tr> </table>Batch Parameters<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSound3DBuffer8::GetAllParameters </td><td>The GetAllParameters method retrieves the 3D properties of the sound buffer.
</td></tr> <tr><td>IDirectSound3DBuffer8::SetAllParameters </td><td>The SetAllParameters method sets all 3D sound buffer properties.
</td></tr> </table>Minimum and Maximum Distance<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSound3DBuffer8::GetMaxDistance </td><td>The GetMaxDistance method retrieves the maximum distance, which is the distance from the listener beyond which sounds in this buffer are no longer attenuated.
</td></tr> <tr><td>IDirectSound3DBuffer8::GetMinDistance </td><td>The GetMinDistance method retrieves the minimum distance, which is the distance from the listener at which sounds in this buffer begin to be attenuated.
</td></tr> <tr><td>IDirectSound3DBuffer8::SetMaxDistance </td><td>The SetMaxDistance method sets the maximum distance, which is the distance from the listener beyond which sounds in this buffer are no longer attenuated.
</td></tr> <tr><td>IDirectSound3DBuffer8::SetMinDistance </td><td>The SetMinDistance method sets the minimum distance, which is the distance from the listener at which sounds in this buffer begin to be attenuated.
</td></tr> </table>Position<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSound3DBuffer8::GetPosition </td><td>The GetPosition method retrieves the position of the sound source.
</td></tr> <tr><td>IDirectSound3DBuffer8::SetPosition </td><td>The SetPosition method sets the position of the sound source.
</td></tr> </table>Sound Projection Cone<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSound3DBuffer8::GetConeAngles </td><td>The GetConeAngles method retrieves the inside and outside angles of the sound projection cone.
</td></tr> <tr><td>IDirectSound3DBuffer8::GetConeOrientation </td><td>The GetConeOrientation method retrieves the orientation of the sound projection cone.
</td></tr> <tr><td>IDirectSound3DBuffer8::GetConeOutsideVolume </td><td>The GetConeOutsideVolume method retrieves the volume of the sound outside the outside angle of the sound projection cone.
</td></tr> <tr><td>IDirectSound3DBuffer8::SetConeAngles </td><td>The SetConeAngles method sets the inside and outside angles of the sound projection cone.
</td></tr> <tr><td>IDirectSound3DBuffer8::SetConeOrientation </td><td>The SetConeOrientation method sets the orientation of the sound projection cone.
</td></tr> <tr><td>IDirectSound3DBuffer8::SetConeOutsideVolume </td><td>The SetConeOutsideVolume method sets the volume of the sound outside the outside angle of the sound projection cone.
</td></tr> </table>Velocity<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSound3DBuffer8::GetVelocity </td><td>The GetVelocity method retrieves the velocity of the sound source.
</td></tr> <tr><td>IDirectSound3DBuffer8::SetVelocity </td><td>The SetVelocity method sets the velocity of the sound source.
</td></tr> </table><p>The LPDIRECTSOUND3DBUFFER type is defined as a reference to the IDirectSound3DBuffer8 interface:</p><pre> typedef struct <see cref="T:SharpDX.DirectSound.SoundBuffer3D" /> *LPDIRECTSOUND3DBUFFER;
</pre>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer']/*" />
<msdn-id>ee417960</msdn-id>
<unmanaged>IDirectSound3DBuffer</unmanaged>
<unmanaged-short>IDirectSound3DBuffer</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.SoundBuffer3D"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.op_Explicit(System.IntPtr)~SharpDX.DirectSound.SoundBuffer3D">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.SoundBuffer3D"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.GetAllParameters(SharpDX.DirectSound.Buffer3DSettings@)">
<summary>
The GetAllParameters method retrieves the 3D properties of the sound buffer.
</summary>
<param name="ds3dBufferRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.Buffer3DSettings" /> structure that receives the information describing the 3D characteristics of the sound buffer. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK.</p> <p>If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.getallparameters</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::GetAllParameters([Out] DS3DBUFFER* pDs3dBuffer)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::GetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.GetConeAngles(System.Int32@,System.Int32@)">
<summary>
The GetConeAngles method retrieves the inside and outside angles of the sound projection cone.
</summary>
<param name="nsideConeAngleRef"><dd> Addresses of a variable that receives the inside angle of the sound projection cone, in degrees. This is the angle within which the sound is at its normal volume. </dd></param>
<param name="utsideConeAngleRef"><dd> Addresses of a variable that receives the outside angle of the sound projection cone, in degrees. This is the angle outside of which the sound is at its outside volume. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The minimum, maximum, and default cone angles are defined in Dsound.h as DS3D_MINCONEANGLE, DS3D_MAXCONEANGLE, and DS3D_DEFAULTCONEANGLE.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::GetConeAngles']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.getconeangles</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::GetConeAngles([Out] unsigned int* pdwInsideConeAngle,[Out] unsigned int* pdwOutsideConeAngle)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::GetConeAngles</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.GetConeOrientation(SharpDX.Mathematics.Interop.RawVector3@)">
<summary>
The GetConeOrientation method retrieves the orientation of the sound projection cone.
</summary>
<param name="vOrientationRef"><dd> Address of a <see cref="T:SharpDX.Mathematics.Interop.RawVector3" /> structure that receives the orientation of the sound projection cone. The vector information represents the center of the sound cone. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The values returned are not necessarily the same as those set by using the SetConeOrientation method. DirectSound normalizes orientation vectors so that all axes have a magnitude of less than or equal to 1.0.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::GetConeOrientation']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.getconeorientation</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::GetConeOrientation([Out] D3DVECTOR* pvOrientation)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::GetConeOrientation</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.GetConeOutsideVolume(System.Int32@)">
<summary>
The GetConeOutsideVolume method retrieves the volume of the sound outside the outside angle of the sound projection cone.
</summary>
<param name="lConeOutsideVolumeRef"><dd> Address of a variable that receives the cone outside volume for this buffer. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>Volume levels are expressed as attenuation, in hundredths of a decibel. Allowable values are between <see cref="F:SharpDX.DirectSound.Volume.Maximum" /> (no attenuation) and <see cref="F:SharpDX.DirectSound.Volume.Minimum" /> (silence). The default value is DS3D_DEFAULTCONEOUTSIDEVOLUME (no attenuation). These values are defined in Dsound.h. DirectSound does not support amplification.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::GetConeOutsideVolume']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.getconeoutsidevolume</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::GetConeOutsideVolume([Out] int* plConeOutsideVolume)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::GetConeOutsideVolume</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.GetMaxDistance(System.Single@)">
<summary>
The GetMaxDistance method retrieves the maximum distance, which is the distance from the listener beyond which sounds in this buffer are no longer attenuated.
</summary>
<param name="flMaxDistanceRef"><dd> Address of a variable that receives the maximum distance, in meters by default. D3DVALUE is defined as float. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The default maximum distance, defined as DS3D_DEFAULTMAXDISTANCE, is effectively infinite.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::GetMaxDistance']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.getmaxdistance</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::GetMaxDistance([Out] float* pflMaxDistance)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::GetMaxDistance</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.GetMinDistance(System.Single@)">
<summary>
The GetMinDistance method retrieves the minimum distance, which is the distance from the listener at which sounds in this buffer begin to be attenuated.
</summary>
<param name="flMinDistanceRef"><dd> Address of a variable that receives the minimum distance, in meters by default. D3DVALUE is defined as float. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>By default, the minimum distance value is DS3D_DEFAULTMINDISTANCE, defined as 1.0 (corresponding to 1.0 meter at the default distance factor of 1.0 meters per unit).</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::GetMinDistance']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.getmindistance</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::GetMinDistance([Out] float* pflMinDistance)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::GetMinDistance</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.GetMode(System.Int32@)">
<summary>
The GetMode method retrieves the operation mode for 3D sound processing.
</summary>
<param name="odeRef"><dd> Address of a variable that receives the mode setting. This value will be one of those in the following table. <table> <tr><td>Value</td><td>Description</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.Mode3D.Disable" /></td><td>Processing of 3D sound is disabled. The sound seems to originate from the center of the listener's head.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.Mode3D.HeadRelative" /></td><td>Sound parameters (position, velocity, and orientation) are relative to the listener's parameters. In this mode, the absolute parameters of the sound are updated automatically as the listener's parameters change, so that the relative parameters remain constant.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.Mode3D.Normal" /></td><td>Normal processing. This is the default mode.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::GetMode']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.getmode</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::GetMode([Out] unsigned int* pdwMode)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::GetMode</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.GetPosition(SharpDX.Mathematics.Interop.RawVector3@)">
<summary>
The GetPosition method retrieves the position of the sound source.
</summary>
<param name="vPositionRef"><dd> Address of a <see cref="T:SharpDX.Mathematics.Interop.RawVector3" /> structure that receives the position of the sound buffer. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>By default, distance units are meters, but the units can be changed by using the SetDistanceFactor method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::GetPosition']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.getposition</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::GetPosition([Out] D3DVECTOR* pvPosition)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::GetPosition</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.GetVelocity(SharpDX.Mathematics.Interop.RawVector3@)">
<summary>
The GetVelocity method retrieves the velocity of the sound source.
</summary>
<param name="vVelocityRef"><dd> Address of a <see cref="T:SharpDX.Mathematics.Interop.RawVector3" /> structure that receives the sound buffer's velocity, in meters per second by default. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>Velocity is used for Doppler effects only. It does not actually move the buffer. For more information, see Doppler Effect.</p> <p>The default unit of measurement is meters per second, but this can be changed by using the SetDistanceFactor method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::GetVelocity']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.getvelocity</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::GetVelocity([Out] D3DVECTOR* pvVelocity)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::GetVelocity</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.SetAllParameters(SharpDX.DirectSound.Buffer3DSettings,System.Int32)">
<summary>
The SetAllParameters method sets all 3D sound buffer properties.
</summary>
<param name="cDs3dBufferRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.Buffer3DSettings" /> structure that describes the 3D characteristics of the sound buffer. </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of the following: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::SetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.setallparameters</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::SetAllParameters([In] const DS3DBUFFER* pcDs3dBuffer,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::SetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.SetConeAngles(System.Int32,System.Int32,System.Int32)">
<summary>
The SetConeAngles method sets the inside and outside angles of the sound projection cone.
</summary>
<param name="insideConeAngle"><dd> Inside cone angle, in degrees. This is the angle within which the sound is at its normal volume. </dd></param>
<param name="outsideConeAngle"><dd> Outside cone angle, in degrees. This is the angle outside of which the sound is at its outside volume. </dd></param>
<param name="apply"><dd> Value that indicates when the setting should be applied. Must be one of the following: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The minimum, maximum, and default cone angles are defined in Dsound.h as DS3D_MINCONEANGLE, DS3D_MAXCONEANGLE, and DS3D_DEFAULTCONEANGLE. Each angle must be in the range of 0 degrees (no cone) to 360 degrees (the full sphere). The default value is 360.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::SetConeAngles']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.setconeangles</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::SetConeAngles([In] unsigned int dwInsideConeAngle,[In] unsigned int dwOutsideConeAngle,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::SetConeAngles</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.SetConeOrientation(System.Single,System.Single,System.Single,System.Int32)">
<summary>
The SetConeOrientation method sets the orientation of the sound projection cone.
</summary>
<param name="x"><dd> Value that specifies the x coordinate of the sound cone orientation vector. D3DVALUE is defined as float. </dd></param>
<param name="y"><dd> Value that specifies the y coordinate of the sound cone orientation vector. D3DVALUE is defined as float. </dd></param>
<param name="z"><dd> Value that specifies the z coordinate of the sound cone orientation vector. D3DVALUE is defined as float. </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of the following: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>This method has no effect unless the cone angle and cone outside volume have also been set to values other than the default.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::SetConeOrientation']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.setconeorientation</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::SetConeOrientation([In] float x,[In] float y,[In] float z,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::SetConeOrientation</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.SetConeOutsideVolume(System.Int32,System.Int32)">
<summary>
The SetConeOutsideVolume method sets the volume of the sound outside the outside angle of the sound projection cone.
</summary>
<param name="coneOutsideVolume"><dd> Cone outside volume, in hundredths of a decibel. </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of the those shown in the following table.<table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>Volume levels are represented by attenuation. Allowable values are between <see cref="F:SharpDX.DirectSound.Volume.Maximum" /> (no attenuation) and <see cref="F:SharpDX.DirectSound.Volume.Minimum" /> (silence). The default value is DS3D_DEFAULTCONEOUTSIDEVOLUME (no attenuation). These values are defined in Dsound.h. DirectSound does not support amplification.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::SetConeOutsideVolume']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.setconeoutsidevolume</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::SetConeOutsideVolume([In] int lConeOutsideVolume,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::SetConeOutsideVolume</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.SetMaxDistance(System.Single,System.Int32)">
<summary>
The SetMaxDistance method sets the maximum distance, which is the distance from the listener beyond which sounds in this buffer are no longer attenuated.
</summary>
<param name="maxDistance"><dd> Maximum distance, in meters by default. D3DVALUE is defined as float. </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of the following: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The default maximum distance, defined as DS3D_DEFAULTMAXDISTANCE, is effectively infinite.</p> <p>The default unit of measurement is meters, but this can be changed by using the SetDistanceFactor method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::SetMaxDistance']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.setmaxdistance</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::SetMaxDistance([In] float flMaxDistance,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::SetMaxDistance</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.SetMinDistance(System.Single,System.Int32)">
<summary>
The SetMinDistance method sets the minimum distance, which is the distance from the listener at which sounds in this buffer begin to be attenuated.
</summary>
<param name="minDistance"><dd> Minimum distance, in meters by default. D3DVALUE is defined as float. </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of the following: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>By default, the minimum distance value is DS3D_DEFAULTMINDISTANCE, defined as 1.0 (corresponding to 1.0 meter at the default distance factor of 1.0 meters per unit).</p> <p>The default unit of measurement is meters, but this can be changed by using the SetDistanceFactor method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::SetMinDistance']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.setmindistance</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::SetMinDistance([In] float flMinDistance,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::SetMinDistance</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.SetMode(System.Int32,System.Int32)">
<summary>
The SetMode method sets the operation mode for 3D sound processing.
</summary>
<param name="mode"><dd> Flag specifying the 3D sound processing mode to be set. The flags in the following table are defined.<table> <tr><th>Value</th><th>Description</th></tr> <tr><td><see cref="F:SharpDX.DirectSound.Mode3D.Disable" /></td><td>Processing of 3D sound is disabled. The sound seems to originate from the center of the listener's head.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.Mode3D.HeadRelative" /></td><td>Sound parameters (position, velocity, and orientation) are relative to the listener's parameters. In this mode, the absolute parameters of the sound are updated automatically as the listener's parameters change, so that the relative parameters remain constant.</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.Mode3D.Normal" /></td><td>Normal processing. This is the default mode.</td></tr> </table> </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of those in the following table. <table> <tr><th>Value</th><th>Description</th></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::SetMode']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.setmode</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::SetMode([In] unsigned int dwMode,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::SetMode</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.SetPosition(System.Single,System.Single,System.Single,System.Int32)">
<summary>
The SetPosition method sets the position of the sound source.
</summary>
<param name="x"><dd> Value that specifies the x coordinate of the position vector. DirectSound may adjust these values to prevent floating-point overflow. D3DVALUE is defined as float. </dd></param>
<param name="y"><dd> Value that specifies the y coordinate of the position vector. DirectSound may adjust these values to prevent floating-point overflow. D3DVALUE is defined as float. </dd></param>
<param name="z"><dd> Value that specifies the z coordinate of the position vector. DirectSound may adjust these values to prevent floating-point overflow. D3DVALUE is defined as float. </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of the following: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The default unit of measurement is meters, but this can be changed by using the SetDistanceFactor method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::SetPosition']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.setposition</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::SetPosition([In] float x,[In] float y,[In] float z,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::SetPosition</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.SetVelocity(System.Single,System.Single,System.Single,System.Int32)">
<summary>
The SetVelocity method sets the velocity of the sound source.
</summary>
<param name="x"><dd> Value that specifies the x coordinate of the velocity vector, in meters per second by default. DirectSound may adjust these values to prevent floating-point overflow. D3DVALUE is defined as float. </dd></param>
<param name="y"><dd> Value that specifies the y coordinate of the velocity vector, in meters per second by default. DirectSound may adjust these values to prevent floating-point overflow. D3DVALUE is defined as float. </dd></param>
<param name="z"><dd> Value that specifies the z coordinate of the velocity vector, in meters per second by default. DirectSound may adjust these values to prevent floating-point overflow. D3DVALUE is defined as float. </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of the following: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>Velocity is used only for calculating Doppler effect. It does not change the position of the buffer. For more information, see Doppler Effect.</p> <p>The default unit of measurement is meters per second, but this can be changed by using the SetDistanceFactor method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DBuffer::SetVelocity']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dbuffer8.idirectsound3dbuffer8.setvelocity</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::SetVelocity([In] float x,[In] float y,[In] float z,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DBuffer::SetVelocity</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundBuffer3D.DefaultConeAngle">
<summary>
Default cone angle, in degrees.
</summary>
</member>
<member name="F:SharpDX.DirectSound.SoundBuffer3D.DefaultConeOutsideVolume">
<summary>
Default outside cone volume. Volume levels are expressed as attenuation, in hundredths of a decibel.
</summary>
</member>
<member name="F:SharpDX.DirectSound.SoundBuffer3D.DefaultMaxDistance">
<summary>
Default maximum distance, in meters.
</summary>
</member>
<member name="F:SharpDX.DirectSound.SoundBuffer3D.DefaultMinDistance">
<summary>
Default minimum distance, in meters.
</summary>
</member>
<member name="F:SharpDX.DirectSound.SoundBuffer3D.MaxConeAngle">
<summary>
Maximum cone angle, in degrees.
</summary>
</member>
<member name="F:SharpDX.DirectSound.SoundBuffer3D.MinConeAngle">
<summary>
Minimum cone angle, in degrees.
</summary>
</member>
<member name="M:SharpDX.DirectSound.SoundBuffer3D.#ctor(SharpDX.DirectSound.SoundBuffer)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.SoundBuffer3D" /> class.
</summary>
<param name="soundBuffer" />
<returns />
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer3D.AllParameters">
<summary>
Gets or sets all the parameters of a buffer
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer3D.ConeOrientation">
<summary>
The orientation of the sound projection cone.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer3D.ConeOutsideVolume">
<summary>
The volume of the sound outside the outside angle of the sound projection cone.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer3D.Deferred">
<summary>
Settings are not applied until the application calls the SoundListener3D.CommitDeferredSettings() if true.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer3D.InsideConeAngle">
<summary>
The inside angle of the sound projection cone.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer3D.MaxDistance">
<summary>
The maximum distance, which is the distance from the listener beyond which sounds in this buffer are no longer attenuated.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer3D.MinDistance">
<summary>
The minimum distance, which is the distance from the listener at which sounds in this buffer begin to be attenuated.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer3D.Mode">
<summary>
The operation mode for 3-D sound processing.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer3D.OutsideConeAngle">
<summary>
The outside angle of the sound projection cone.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer3D.Position">
<summary>
The position of the sound source.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundBuffer3D.Velocity">
<summary>
The velocity of the sound source.
</summary>
</member>
<member name="T:SharpDX.DirectSound.SoundBufferNotifier">
<summary>
<p>The IDirectSoundNotify8 interface sets up notification events for a playback or capture buffer.</p><p>IDirectSoundNotify8 is a define for <see cref="T:SharpDX.DirectSound.SoundBufferNotifier" />. The two interface names are interchangeable.</p><p>The interface is obtained by calling the QueryInterface method of an existing interface on a DirectSound buffer object. Secondary buffers support notifications only if they are created with the <see cref="F:SharpDX.DirectSound.BufferFlags.ControlPositionNotify" /> flag.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSoundNotify8 interface exposes the following method.</p>IDirectSoundNotify8 Member<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundNotify8::SetNotificationPositions </td><td>The SetNotificationPositions method sets the notification positions. During capture or playback, whenever the read or play cursor reaches one of the specified offsets, the associated event is signaled.
</td></tr> </table><p>The LPDIRECTSOUNDNOTIFY type is defined as a reference to the <see cref="T:SharpDX.DirectSound.SoundBufferNotifier" /> interface:</p><pre> typedef struct <see cref="T:SharpDX.DirectSound.SoundBufferNotifier" /> *LPDIRECTSOUNDNOTIFY;
</pre>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundNotify']/*" />
<msdn-id>ee418244</msdn-id>
<unmanaged>IDirectSoundNotify</unmanaged>
<unmanaged-short>IDirectSoundNotify</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBufferNotifier.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.SoundBufferNotifier"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.SoundBufferNotifier.op_Explicit(System.IntPtr)~SharpDX.DirectSound.SoundBufferNotifier">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.SoundBufferNotifier"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="M:SharpDX.DirectSound.SoundBufferNotifier.SetNotificationPositions(System.Int32,SharpDX.DirectSound.NotificationPosition[])">
<summary>
The SetNotificationPositions method sets the notification positions. During capture or playback, whenever the read or play cursor reaches one of the specified offsets, the associated event is signaled.
</summary>
<param name="positionNotifies"><dd> Number of <see cref="T:SharpDX.DirectSound.NotificationPosition" /> structures. </dd></param>
<param name="cPositionNotifiesRef"><dd> Pointer to an array of <see cref="T:SharpDX.DirectSound.NotificationPosition" /> structures (the maximum array size is DSBNOTIFICATIONS_MAX). </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be one of the following error values: </p> <table> <tr><td>Return code</td></tr> <tr><td>DSERR_INVALIDPARAM </td></tr> <tr><td>DSERR_OUTOFMEMORY </td></tr> </table></returns>
<remarks>
<p>The value DSBPN_OFFSETSTOP can be specified in the dwOffset member to tell DirectSound to signal the associated event when the Stop or Stop method is called or when the end of the buffer has been reached and the playback is not looping. If it is used, this should be the last item in the position-notify array.</p> <p>If a position-notify array has already been set, the method replaces the previous array.</p> <p>The buffer must be stopped when this method is called.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundNotify::SetNotificationPositions']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundnotify8.idirectsoundnotify8.setnotificationpositions</msdn-id>
<unmanaged>HRESULT IDirectSoundNotify::SetNotificationPositions([In] unsigned int dwPositionNotifies,[In, Buffer] const DSBPOSITIONNOTIFY* pcPositionNotifies)</unmanaged>
<unmanaged-short>IDirectSoundNotify::SetNotificationPositions</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.SoundListener3D">
<summary>
<p>The IDirectSound3DListener8 interface is used to retrieve and set parameters that describe a listener's position, orientation, and listening environment in 3D space.</p><p>The interface can be obtained by calling the IDirectSoundBuffer8::QueryInterface method on a primary buffer created with the <see cref="F:SharpDX.DirectSound.BufferFlags.Control3D" /> flag.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSound3DListener8 interface exposes the following methods, arranged by category.</p>Batch Parameters<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSound3DListener8::CommitDeferredSettings </td><td>The CommitDeferredSettings method commits any deferred settings made since the last call to this method.
</td></tr> <tr><td>IDirectSound3DListener8::GetAllParameters </td><td>The GetAllParameters method retrieves all 3D parameters of the sound environment and the listener.
</td></tr> <tr><td>IDirectSound3DListener8::SetAllParameters </td><td>The SetAllParameters method sets all 3D parameters of the sound environment and the listener.
</td></tr> </table>Global Sound Properties<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSound3DListener8::GetDistanceFactor </td><td>The GetDistanceFactor method retrieves the distance factor, which is the number of meters in a vector unit.
</td></tr> <tr><td>IDirectSound3DListener8::GetDopplerFactor </td><td>The GetDopplerFactor method retrieves the multiplier for the Doppler effect.
</td></tr> <tr><td>IDirectSound3DListener8::GetRolloffFactor </td><td>The GetRolloffFactor method retrieves the rolloff factor, which determines the rate of attenuation over distance.
</td></tr> <tr><td>IDirectSound3DListener8::SetDistanceFactor </td><td>The SetDistanceFactor method sets the distance factor, which is the number of meters in a vector unit.
</td></tr> <tr><td>IDirectSound3DListener8::SetDopplerFactor </td><td>The SetDopplerFactor method sets the multiplier for the Doppler effect.
</td></tr> <tr><td>IDirectSound3DListener8::SetRolloffFactor </td><td>The SetRolloffFactor method sets the rolloff factor, which determines the rate of attenuation over distance.
</td></tr> </table>Listener Properties<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSound3DListener8::GetOrientation </td><td>The GetOrientation method retrieves the orientation of the listener's head.
</td></tr> <tr><td>IDirectSound3DListener8::GetPosition </td><td>The GetPosition method retrieves the listener's position.
</td></tr> <tr><td>IDirectSound3DListener8::GetVelocity </td><td>The GetVelocity method retrieves the listener's velocity.
</td></tr> <tr><td>IDirectSound3DListener8::SetOrientation </td><td>The SetOrientation method sets the orientation of the listener's head.
</td></tr> <tr><td>IDirectSound3DListener8::SetPosition </td><td>The SetPosition method sets the listener's position.
</td></tr> <tr><td>IDirectSound3DListener8::SetVelocity </td><td>The SetVelocity method sets the listener's velocity.
</td></tr> </table><p>The LPDIRECTSOUND3DLISTENER type is defined as a reference to the <see cref="T:SharpDX.DirectSound.SoundListener3D" /> interface:</p><pre> typedef struct <see cref="T:SharpDX.DirectSound.SoundListener3D" /> *LPDIRECTSOUND3DLISTENER;
</pre>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener']/*" />
<msdn-id>ee418003</msdn-id>
<unmanaged>IDirectSound3DListener</unmanaged>
<unmanaged-short>IDirectSound3DListener</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.SoundListener3D"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.op_Explicit(System.IntPtr)~SharpDX.DirectSound.SoundListener3D">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.SoundListener3D"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.GetAllParameters(SharpDX.DirectSound.Listener3DSettings@)">
<summary>
The GetAllParameters method retrieves all 3D parameters of the sound environment and the listener.
</summary>
<param name="listenerRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.Listener3DSettings" /> structure that receives the state of the 3D world and listener. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.getallparameters</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::GetAllParameters([Out] DS3DLISTENER* pListener)</unmanaged>
<unmanaged-short>IDirectSound3DListener::GetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.GetDistanceFactor(System.Single@)">
<summary>
The GetDistanceFactor method retrieves the distance factor, which is the number of meters in a vector unit.
</summary>
<param name="flDistanceFactorRef"><dd> Address of a variable that receives the distance factor value. D3DVALUE is defined as float. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::GetDistanceFactor']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.getdistancefactor</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::GetDistanceFactor([Out] float* pflDistanceFactor)</unmanaged>
<unmanaged-short>IDirectSound3DListener::GetDistanceFactor</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.GetDopplerFactor(System.Single@)">
<summary>
The GetDopplerFactor method retrieves the multiplier for the Doppler effect.
</summary>
<param name="flDopplerFactorRef"><dd> Address of a variable that receives the Doppler factor value. D3DVALUE is defined as float. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The Doppler factor has a range of DS3D_MINDOPPLERFACTOR (no Doppler effects) to DS3D_MAXDOPPLERFACTOR (defined as 10 times the Doppler effects found in the real world). The default value is DS3D_DEFAULTDOPPLERFACTOR (1.0).</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::GetDopplerFactor']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.getdopplerfactor</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::GetDopplerFactor([Out] float* pflDopplerFactor)</unmanaged>
<unmanaged-short>IDirectSound3DListener::GetDopplerFactor</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.GetOrientation(SharpDX.Mathematics.Interop.RawVector3@,SharpDX.Mathematics.Interop.RawVector3@)">
<summary>
The GetOrientation method retrieves the orientation of the listener's head.
</summary>
<param name="vOrientFrontRef"><dd> Address of a <see cref="T:SharpDX.Mathematics.Interop.RawVector3" /> structure that receives the listener's front orientation vector. </dd></param>
<param name="vOrientTopRef"><dd> Address of a <see cref="T:SharpDX.Mathematics.Interop.RawVector3" /> structure that receives the listener's top orientation vector. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The front vector points in the direction of the listener's nose, and the top vector points up from the top of the listener's head. By default, the front vector is (0,0,1.0) and the top vector is (0,1.0,0).</p> <p>The values returned are not necessarily the same as those set by using SetOrientation. DirectSound normalizes orientation vectors so that they are at right angles and have a magnitude of less than or equal to 1.0.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::GetOrientation']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.getorientation</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::GetOrientation([Out] D3DVECTOR* pvOrientFront,[Out] D3DVECTOR* pvOrientTop)</unmanaged>
<unmanaged-short>IDirectSound3DListener::GetOrientation</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.GetPosition(SharpDX.Mathematics.Interop.RawVector3@)">
<summary>
The GetPosition method retrieves the listener's position.
</summary>
<param name="vPositionRef"><dd> Address of a <see cref="T:SharpDX.Mathematics.Interop.RawVector3" /> structure that receives the listener's position vector. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>By default, measurement units are meters, but this can be changed by calling the SetDistanceFactor method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::GetPosition']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.getposition</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::GetPosition([Out] D3DVECTOR* pvPosition)</unmanaged>
<unmanaged-short>IDirectSound3DListener::GetPosition</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.GetRolloffFactor(System.Single@)">
<summary>
The GetRolloffFactor method retrieves the rolloff factor, which determines the rate of attenuation over distance.
</summary>
<param name="flRolloffFactorRef"><dd> Address of a variable that receives the rolloff factor. D3DVALUE is defined as float. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The rolloff factor has a range of DS3D_MINROLLOFFFACTOR (no rolloff) to DS3D_MAXROLLOFFFACTOR (defined as 10 times the rolloff found in the real world). The default value is DS3D_DEFAULTROLLOFFFACTOR (1.0). For more information, see Rolloff Factor.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::GetRolloffFactor']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.getrollofffactor</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::GetRolloffFactor([Out] float* pflRolloffFactor)</unmanaged>
<unmanaged-short>IDirectSound3DListener::GetRolloffFactor</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.GetVelocity(SharpDX.Mathematics.Interop.RawVector3@)">
<summary>
The GetVelocity method retrieves the listener's velocity.
</summary>
<param name="vVelocityRef"><dd> Address of a <see cref="T:SharpDX.Mathematics.Interop.RawVector3" /> structure that receives the listener's velocity. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>Velocity is used only for calculating Doppler effect. It does not change the listener's position. To move the listener, use the SetPosition method.</p> <p>The default velocity is (0,0,0).</p> <p>By default, measurement units are meters per second, but this can be changed by calling the SetDistanceFactor method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::GetVelocity']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.getvelocity</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::GetVelocity([Out] D3DVECTOR* pvVelocity)</unmanaged>
<unmanaged-short>IDirectSound3DListener::GetVelocity</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.SetAllParameters(SharpDX.DirectSound.Listener3DSettings,System.Int32)">
<summary>
The SetAllParameters method sets all 3D parameters of the sound environment and the listener.
</summary>
<param name="cListenerRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.Listener3DSettings" /> structure that contains information describing all 3D listener parameters. </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of the following: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::SetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.setallparameters</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::SetAllParameters([In] const DS3DLISTENER* pcListener,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DListener::SetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.SetDistanceFactor(System.Single,System.Int32)">
<summary>
The SetDistanceFactor method sets the distance factor, which is the number of meters in a vector unit.
</summary>
<param name="distanceFactor"><dd> Distance factor. D3DVALUE is defined as float. </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of the following: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The distance factor has a range of DS3D_MINDISTANCEFACTOR to DS3D_MAXDISTANCEFACTOR, defined in Dsound.h as FLT_MIN and FLT_MAX respectively. The default value is DS3D_DEFAULTDISTANCEFACTOR, or 1.0.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::SetDistanceFactor']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.setdistancefactor</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::SetDistanceFactor([In] float flDistanceFactor,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DListener::SetDistanceFactor</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.SetDopplerFactor(System.Single,System.Int32)">
<summary>
The SetDopplerFactor method sets the multiplier for the Doppler effect.
</summary>
<param name="dopplerFactor"><dd> Doppler factor. D3DVALUE is defined as float. </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of the following: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The Doppler factor has a range of DS3D_MINDOPPLERFACTOR (no Doppler effects) to DS3D_MAXDOPPLERFACTOR (defined as 10 times the Doppler effects found in the real world). The default value is DS3D_DEFAULTDOPPLERFACTOR (1.0).</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::SetDopplerFactor']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.setdopplerfactor</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::SetDopplerFactor([In] float flDopplerFactor,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DListener::SetDopplerFactor</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.SetOrientation(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Int32)">
<summary>
The SetOrientation method sets the orientation of the listener's head.
</summary>
<param name="xFront"><dd> Value that specifies the x coordinate of the front orientation vector. D3DVALUE is defined as float. </dd></param>
<param name="yFront"><dd> Value that specifies the y coordinate of the front orientation vector. D3DVALUE is defined as float. </dd></param>
<param name="zFront"><dd> Value that specifies the z coordinate of the front orientation vector. D3DVALUE is defined as float. </dd></param>
<param name="xTop"><dd> Value that specifies the x coordinates of the top orientation vector. </dd></param>
<param name="yTop"><dd> Value that specifies the y coordinates of the top orientation vector. </dd></param>
<param name="zTop"><dd> Value that specifies the z coordinates of the top orientation vector. </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of the following: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The front vector points in the direction of the listener's nose, and the top vector points up from the top of the listener's head. By default, the front vector is (0,0,1.0) and the top vector is (0,1.0,0).</p> <p>The top vector must be at right angles to the front vector. If necessary, DirectSound adjusts the top vector after setting the front vector.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::SetOrientation']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.setorientation</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::SetOrientation([In] float xFront,[In] float yFront,[In] float zFront,[In] float xTop,[In] float yTop,[In] float zTop,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DListener::SetOrientation</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.SetPosition(System.Single,System.Single,System.Single,System.Int32)">
<summary>
The SetPosition method sets the listener's position.
</summary>
<param name="x"><dd> Value that specifies the x coordinate of the listener's position vector. Note that DirectSound may adjust this value to prevent floating-point overflow. D3DVALUE is defined as float. </dd></param>
<param name="y"><dd> Value that specifies the y coordinate of the listener's position vector. Note that DirectSound may adjust this value to prevent floating-point overflow. D3DVALUE is defined as float. </dd></param>
<param name="z"><dd> Value that specifies the z coordinate of the listener's position vector. Note that DirectSound may adjust this value to prevent floating-point overflow. D3DVALUE is defined as float. </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of the following: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>By default, measurement units are meters, but this can be changed by calling the SetDistanceFactor method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::SetPosition']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.setposition</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::SetPosition([In] float x,[In] float y,[In] float z,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DListener::SetPosition</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.SetRolloffFactor(System.Single,System.Int32)">
<summary>
The SetRolloffFactor method sets the rolloff factor, which determines the rate of attenuation over distance.
</summary>
<param name="rolloffFactor"><dd> Rolloff factor. D3DVALUE is defined as float. </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of the following: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>The rolloff factor has a range of DS3D_MINROLLOFFFACTOR (no rolloff) to DS3D_MAXROLLOFFFACTOR (defined as 10 times the rolloff found in the real world). The default value is DS3D_DEFAULTROLLOFFFACTOR (1.0). For more information, see Rolloff Factor.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::SetRolloffFactor']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.setrollofffactor</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::SetRolloffFactor([In] float flRolloffFactor,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DListener::SetRolloffFactor</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.SetVelocity(System.Single,System.Single,System.Single,System.Int32)">
<summary>
The SetVelocity method sets the listener's velocity.
</summary>
<param name="x"><dd> Value that specifies the x coordinate of the listener's velocity vector. DirectSound may adjust this value to prevent floating-point overflow. D3DVALUE is defined as float. </dd></param>
<param name="y"><dd> Value that specifies the y coordinate of the listener's velocity vector. DirectSound may adjust this value to prevent floating-point overflow. D3DVALUE is defined as float. </dd></param>
<param name="z"><dd> Value that specifies the z coordinate of the listener's velocity vector. DirectSound may adjust this value to prevent floating-point overflow. D3DVALUE is defined as float. </dd></param>
<param name="apply"><dd> Value that specifies when the setting should be applied. This value must be one of the following: <table> <tr><td>Value</td><td>Description</td></tr> <tr><td>DS3D_DEFERRED</td><td>Settings are not applied until the application calls the CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.</td></tr> <tr><td>DS3D_IMMEDIATE</td><td>Settings are applied immediately, causing the system to recalculate the 3D coordinates for all 3D sound buffers.</td></tr> </table> </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<remarks>
<p>Velocity is used only for Doppler effects. It does not actually move the listener. To change the listener's position, use the SetPosition method. The default velocity is (0,0,0).</p> <p>By default, measurement units are meters per second, but this can be changed by calling the SetDistanceFactor method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::SetVelocity']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.setvelocity</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::SetVelocity([In] float x,[In] float y,[In] float z,[In] unsigned int dwApply)</unmanaged>
<unmanaged-short>IDirectSound3DListener::SetVelocity</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.CommitDeferredSettings">
<summary>
The CommitDeferredSettings method commits any deferred settings made since the last call to this method.
</summary>
<returns><p>If the method succeeds, the return value is DS_OK.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSound3DListener::CommitDeferredSettings']/*" />
<msdn-id>microsoft.directx_sdk.idirectsound3dlistener8.idirectsound3dlistener8.commitdeferredsettings</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::CommitDeferredSettings()</unmanaged>
<unmanaged-short>IDirectSound3DListener::CommitDeferredSettings</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundListener3D.DefaultDistanceFactor">
<summary>
Default distance factor. The default value is (1.0).
</summary>
</member>
<member name="F:SharpDX.DirectSound.SoundListener3D.DefaultDopplerFactor">
<summary>
Default Doppler factor. The default value is (1.0).
</summary>
</member>
<member name="F:SharpDX.DirectSound.SoundListener3D.DefaultRolloffFactor">
<summary>
Default rolloff factor. The default value is (1.0).
</summary>
</member>
<member name="F:SharpDX.DirectSound.SoundListener3D.MaxDistanceFactor">
<summary>
Maximum distance factor. The default value is (1.0).
</summary>
</member>
<member name="F:SharpDX.DirectSound.SoundListener3D.MaxDopplerFactor">
<summary>
Maximum Doppler factor. The default value is (1.0).
</summary>
</member>
<member name="F:SharpDX.DirectSound.SoundListener3D.MaxRolloffFactor">
<summary>
Maximum rolloff factor. The default value is (1.0).
</summary>
</member>
<member name="F:SharpDX.DirectSound.SoundListener3D.MinDistanceFactor">
<summary>
Minimum distance factor. The default value is (1.0).
</summary>
</member>
<member name="F:SharpDX.DirectSound.SoundListener3D.MinDopplerFactor">
<summary>
Minimum Doppler factor. The default value is (1.0).
</summary>
</member>
<member name="F:SharpDX.DirectSound.SoundListener3D.MinRolloffFactor">
<summary>
Minimum rolloff factor. The default value is (1.0).
</summary>
</member>
<member name="M:SharpDX.DirectSound.SoundListener3D.#ctor(SharpDX.DirectSound.SoundBuffer)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.SoundListener3D" /> class
with a previously created sound buffer.
</summary>
<param name="soundBuffer">The SlimDX::DirectSound::SoundBuffer object.</param>
</member>
<member name="P:SharpDX.DirectSound.SoundListener3D.Deferred">
<summary>
Determines if settings are set immediately or deferred.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundListener3D.DistanceFactor">
<summary>
Gets or sets the distance factor, which is the number of meters in a vector unit.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundListener3D.DopplerFactor">
<summary>
Gets or sets the multiplier for the Doppler effect.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundListener3D.FrontOrientation">
<summary>
Describes the listener's front orientation.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundListener3D.Position">
<summary>
Gets or sets the listener's position.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundListener3D.RolloffFactor">
<summary>
Gets or sets the rolloff factor, which determines the rate of attenuation over distance.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundListener3D.TopOrientation">
<summary>
Describes the listener's top orientation.
</summary>
</member>
<member name="P:SharpDX.DirectSound.SoundListener3D.Velocity">
<summary>
Gets or sets the listener's velocity.
</summary>
</member>
<member name="T:SharpDX.DirectSound.WavesReverb">
<summary>
<p>The IDirectSoundFXWavesReverb8 interface is used to set and retrieve effect parameters on a buffer that supports Waves reverberation.</p><p>This interface is obtained by calling GetObjectInPath on the buffer that supports the effect.</p><p>In addition to the methods inherited from <see cref="T:SharpDX.ComObject" />, the IDirectSoundFXWavesReverb8 interface exposes the following methods.</p>IDirectSoundFXWavesReverb8 Members<table> <tr><th>Method
</th><th>Description
</th></tr> <tr><td>IDirectSoundFXWavesReverb8::GetAllParameters </td><td>The GetAllParameters method retrieves the music reverberation parameters of a buffer.
</td></tr> <tr><td>IDirectSoundFXWavesReverb8::SetAllParameters </td><td>The SetAllParameters method sets the music reverberation parameters of a buffer.
</td></tr> </table><p>The Waves reverberation DMO is based on the Waves MaxxVerb technology, which is licenced to Microsoft.</p>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXWavesReverb']/*" />
<msdn-id>ee418241</msdn-id>
<unmanaged>IDirectSoundFXWavesReverb</unmanaged>
<unmanaged-short>IDirectSoundFXWavesReverb</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.WavesReverb.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.WavesReverb"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.DirectSound.WavesReverb.op_Explicit(System.IntPtr)~SharpDX.DirectSound.WavesReverb">
<summary>
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.DirectSound.WavesReverb"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
</summary>
<param name="nativePointer">The native pointer.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="P:SharpDX.DirectSound.WavesReverb.AllParameters">
<summary>
The GetAllParameters method retrieves the music reverberation parameters of a buffer.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXWavesReverb::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxwavesreverb8.idirectsoundfxwavesreverb8.getallparameters</msdn-id>
<unmanaged>GetAllParameters / SetAllParameters</unmanaged>
<unmanaged-short>GetAllParameters</unmanaged-short>
<unmanaged>HRESULT IDirectSoundFXWavesReverb::GetAllParameters([Out] DSFXWavesReverb* pDsFxWavesReverb)</unmanaged>
</member>
<member name="M:SharpDX.DirectSound.WavesReverb.SetAllParameters(SharpDX.DirectSound.WavesReverbSettings)">
<summary>
The SetAllParameters method sets the music reverberation parameters of a buffer.
</summary>
<param name="cDsFxWavesReverbRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.WavesReverbSettings" /> structure that specifies the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXWavesReverb::SetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxwavesreverb8.idirectsoundfxwavesreverb8.setallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXWavesReverb::SetAllParameters([In] const DSFXWavesReverb* pcDsFxWavesReverb)</unmanaged>
<unmanaged-short>IDirectSoundFXWavesReverb::SetAllParameters</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.WavesReverb.GetAllParameters(SharpDX.DirectSound.WavesReverbSettings@)">
<summary>
The GetAllParameters method retrieves the music reverberation parameters of a buffer.
</summary>
<param name="dsFxWavesReverbRef"><dd> Address of a <see cref="T:SharpDX.DirectSound.WavesReverbSettings" /> structure that receives the effect parameters. </dd></param>
<returns><p>If the method succeeds, the return value is DS_OK. If the method fails, the return value may be DSERR_INVALIDPARAM.</p></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IDirectSoundFXWavesReverb::GetAllParameters']/*" />
<msdn-id>microsoft.directx_sdk.idirectsoundfxwavesreverb8.idirectsoundfxwavesreverb8.getallparameters</msdn-id>
<unmanaged>HRESULT IDirectSoundFXWavesReverb::GetAllParameters([Out] DSFXWavesReverb* pDsFxWavesReverb)</unmanaged>
<unmanaged-short>IDirectSoundFXWavesReverb::GetAllParameters</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.WavesReverb.HighFrequencyRTRatioDefault">
<summary>
Default high-frequency reverb time ratio.
</summary>
</member>
<member name="F:SharpDX.DirectSound.WavesReverb.HighFrequencyRTRatioMax">
<summary>
Maximum high-frequency reverb time ratio.
</summary>
</member>
<member name="F:SharpDX.DirectSound.WavesReverb.HighFrequencyRTRatioMin">
<summary>
Minimum high-frequency reverb time ratio.
</summary>
</member>
<member name="F:SharpDX.DirectSound.WavesReverb.InGainDefault">
<summary>
Default input gain of signal, in decibels (dB).
</summary>
</member>
<member name="F:SharpDX.DirectSound.WavesReverb.InGainMax">
<summary>
Maximum input gain of signal, in decibels (dB).
</summary>
</member>
<member name="F:SharpDX.DirectSound.WavesReverb.InGainMin">
<summary>
Minimum input gain of signal, in decibels (dB).
</summary>
</member>
<member name="F:SharpDX.DirectSound.WavesReverb.ReverbMixDefault">
<summary>
Default reverb mix, in dB.
</summary>
</member>
<member name="F:SharpDX.DirectSound.WavesReverb.ReverbMixMax">
<summary>
Maximum reverb mix, in dB.
</summary>
</member>
<member name="F:SharpDX.DirectSound.WavesReverb.ReverbMixMin">
<summary>
Minimum reverb mix, in dB.
</summary>
</member>
<member name="F:SharpDX.DirectSound.WavesReverb.ReverbTimeDefault">
<summary>
Default reverb time, in milliseconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.WavesReverb.ReverbTimeMax">
<summary>
Maximum reverb time, in milliseconds.
</summary>
</member>
<member name="F:SharpDX.DirectSound.WavesReverb.ReverbTimeMin">
<summary>
Minimum reverb time, in milliseconds.
</summary>
</member>
<member name="T:SharpDX.DirectSound.AcousticEchoCancelSettings">
<summary>
The <see cref="T:SharpDX.DirectSound.AcousticEchoCancelSettings" /> structure contains parameters for acoustic echo cancellation in a capture buffer.
</summary>
<remarks>
<p>The dwMode member is ignored when this structure is passed to IDirectSoundCaptureFXAec8::SetAllParameters.</p> <table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFXAec']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscfxaec</msdn-id>
<unmanaged>DSCFXAec</unmanaged>
<unmanaged-short>DSCFXAec</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.AcousticEchoCancelSettings.Enable">
<summary>
<dd> Boolean value that specifies whether the effect is enabled. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFXAec::fEnable']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscfxaec</msdn-id>
<unmanaged>BOOL fEnable</unmanaged>
<unmanaged-short>BOOL fEnable</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.AcousticEchoCancelSettings.NoiseFill">
<summary>
<dd> Boolean value that specifies whether to enable background comfort noise, which makes the capture signal sound more natural by preventing periods of dead silence. By default, background comfort noise is not enabled. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFXAec::fNoiseFill']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscfxaec</msdn-id>
<unmanaged>BOOL fNoiseFill</unmanaged>
<unmanaged-short>BOOL fNoiseFill</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.AcousticEchoCancelSettings.Mode">
<summary>
<dd> Operation mode. This member contains one of the following values. <table> <tr><th>Value
</th><th>Description
</th></tr> <tr><td><see cref="F:SharpDX.DirectSound.AcousticEchoCancelMode.PassThrough" />
</td><td>The effect is passing capture and render data through without modifying it.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.AcousticEchoCancelMode.HalfDuplex" />
</td><td>The effect is running in half duplex mode. Not presently supported.
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.AcousticEchoCancelMode.FullDuplex" />
</td><td>The effect is running in full duplex mode.
</td></tr> </table> </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFXAec::dwMode']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscfxaec</msdn-id>
<unmanaged>DSCFX_AEC_MODE dwMode</unmanaged>
<unmanaged-short>DSCFX_AEC_MODE dwMode</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.BufferCapabilities">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS']/*" />
<unmanaged>DSBCAPS</unmanaged>
<unmanaged-short>DSBCAPS</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferCapabilities.Size">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS::dwSize']/*" />
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferCapabilities.Flags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS::dwFlags']/*" />
<unmanaged>DSBCAPS_FLAGS dwFlags</unmanaged>
<unmanaged-short>DSBCAPS_FLAGS dwFlags</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferCapabilities.BufferBytes">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS::dwBufferBytes']/*" />
<unmanaged>unsigned int dwBufferBytes</unmanaged>
<unmanaged-short>unsigned int dwBufferBytes</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferCapabilities.UnlockTransferRate">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS::dwUnlockTransferRate']/*" />
<unmanaged>unsigned int dwUnlockTransferRate</unmanaged>
<unmanaged-short>unsigned int dwUnlockTransferRate</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.BufferCapabilities.PlayCpuOverhead">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBCAPS::dwPlayCpuOverhead']/*" />
<unmanaged>unsigned int dwPlayCpuOverhead</unmanaged>
<unmanaged-short>unsigned int dwPlayCpuOverhead</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.BufferCapabilities.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.BufferCapabilities"/> class.
</summary>
</member>
<member name="T:SharpDX.DirectSound.ChorusSettings">
<summary>
The <see cref="T:SharpDX.DirectSound.ChorusSettings" /> structure contains parameters for a chorus effect.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXChorus']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxchorus</msdn-id>
<unmanaged>DSFXChorus</unmanaged>
<unmanaged-short>DSFXChorus</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.ChorusSettings.WetDryMix">
<summary>
<dd> Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from DSFXCHORUS_WETDRYMIX_MIN through DSFXCHORUS_WETDRYMIX_MAX (all wet). The default value is 50. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXChorus::fWetDryMix']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxchorus</msdn-id>
<unmanaged>float fWetDryMix</unmanaged>
<unmanaged-short>float fWetDryMix</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.ChorusSettings.Depth">
<summary>
<dd> Percentage by which the delay time is modulated by the low-frequency oscillator, in hundredths of a percentage point. Must be in the range from DSFXCHORUS_DEPTH_MIN through DSFXCHORUS_DEPTH_MAX. The default value is 10. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXChorus::fDepth']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxchorus</msdn-id>
<unmanaged>float fDepth</unmanaged>
<unmanaged-short>float fDepth</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.ChorusSettings.Feedback">
<summary>
<dd> Percentage of output signal to feed back into the effect's input, in the range from DSFXCHORUS_FEEDBACK_MIN to DSFXCHORUS_FEEDBACK_MAX. The default value is 25. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXChorus::fFeedback']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxchorus</msdn-id>
<unmanaged>float fFeedback</unmanaged>
<unmanaged-short>float fFeedback</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.ChorusSettings.Frequency">
<summary>
<dd> Frequency of the LFO, in the range from DSFXCHORUS_FREQUENCY_MIN to DSFXCHORUS_FREQUENCY_MAX. The default value is 1.1. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXChorus::fFrequency']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxchorus</msdn-id>
<unmanaged>float fFrequency</unmanaged>
<unmanaged-short>float fFrequency</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.ChorusSettings.Waveform">
<summary>
<dd> Waveform shape of the LFO. Defined values are DSFXCHORUS_WAVE_TRIANGLE and DSFXCHORUS_WAVE_SIN. By default, the waveform is a sine. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXChorus::lWaveform']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxchorus</msdn-id>
<unmanaged>int lWaveform</unmanaged>
<unmanaged-short>int lWaveform</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.ChorusSettings.Delay">
<summary>
<dd> Number of milliseconds the input is delayed before it is played back, in the range from DSFXCHORUS_DELAY_MIN to DSFXCHORUS_DELAY_MAX. The default value is 16 ms. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXChorus::fDelay']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxchorus</msdn-id>
<unmanaged>float fDelay</unmanaged>
<unmanaged-short>float fDelay</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.ChorusSettings.Phase">
<summary>
<dd> Phase differential between left and right LFOs, in the range from DSFXCHORUS_PHASE_MIN through DSFXCHORUS_PHASE_MAX. Possible values are defined as follows.
<table> <tr><th>Value
</th></tr> <tr><td>DSFXCHORUS_PHASE_NEG_180
</td></tr> <tr><td>DSFXCHORUS_PHASE_NEG_90
</td></tr> <tr><td>DSFXCHORUS_PHASE_ZERO
</td></tr> <tr><td>DSFXCHORUS_PHASE_90
</td></tr> <tr><td>DSFXCHORUS_PHASE_180
</td></tr> </table> <p>The default value is DSFXCHORUS_PHASE_90.</p> </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXChorus::lPhase']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxchorus</msdn-id>
<unmanaged>int lPhase</unmanaged>
<unmanaged-short>int lPhase</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.CompressorSettings">
<summary>
The <see cref="T:SharpDX.DirectSound.CompressorSettings" /> structure contains parameters for a compression effect.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXCompressor']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxcompressor</msdn-id>
<unmanaged>DSFXCompressor</unmanaged>
<unmanaged-short>DSFXCompressor</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CompressorSettings.Gain">
<summary>
<dd> Output gain of signal after compression, in the range from DSFXCOMPRESSOR_GAIN_MIN to DSFXCOMPRESSOR_GAIN_MAX. The default value is 0 dB. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXCompressor::fGain']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxcompressor</msdn-id>
<unmanaged>float fGain</unmanaged>
<unmanaged-short>float fGain</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CompressorSettings.Attack">
<summary>
<dd> Time before compression reaches its full value, in the range from DSFXCOMPRESSOR_ATTACK_MIN to DSFXCOMPRESSOR_ATTACK_MAX. The default value is 10 ms. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXCompressor::fAttack']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxcompressor</msdn-id>
<unmanaged>float fAttack</unmanaged>
<unmanaged-short>float fAttack</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CompressorSettings.Release">
<summary>
<dd> Speed at which compression is stopped after input drops below fThreshold, in the range from DSFXCOMPRESSOR_RELEASE_MIN to DSFXCOMPRESSOR_RELEASE_MAX. The default value is 200 ms. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXCompressor::fRelease']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxcompressor</msdn-id>
<unmanaged>float fRelease</unmanaged>
<unmanaged-short>float fRelease</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CompressorSettings.Threshold">
<summary>
<dd> Point at which compression begins, in decibels, in the range from DSFXCOMPRESSOR_THRESHOLD_MIN to DSFXCOMPRESSOR_THRESHOLD_MAX. The default value is -20 dB. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXCompressor::fThreshold']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxcompressor</msdn-id>
<unmanaged>float fThreshold</unmanaged>
<unmanaged-short>float fThreshold</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CompressorSettings.Ratio">
<summary>
<dd> Compression ratio, in the range from DSFXCOMPRESSOR_RATIO_MIN to DSFXCOMPRESSOR_RATIO_MAX. The default value is 3, which means 3:1 compression. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXCompressor::fRatio']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxcompressor</msdn-id>
<unmanaged>float fRatio</unmanaged>
<unmanaged-short>float fRatio</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.CompressorSettings.Predelay">
<summary>
<dd> Time after lThreshold is reached before attack phase is started, in milliseconds, in the range from DSFXCOMPRESSOR_PREDELAY_MIN to DSFXCOMPRESSOR_PREDELAY_MAX. The default value is 4 ms. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXCompressor::fPredelay']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxcompressor</msdn-id>
<unmanaged>float fPredelay</unmanaged>
<unmanaged-short>float fPredelay</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.DistortionSettings">
<summary>
The <see cref="T:SharpDX.DirectSound.DistortionSettings" /> structure contains parameters for a distortion effect.
</summary>
<remarks>
<p>The values in fPostEQBandwidth, fPostEQCenterFrequency, and fPreLowpassCutoff cannot exceed one-third of the frequency of the buffer. If an attempt is made to set a value greater than this, but within the range of accepted values, the parameter is set to the nearest supported value and S_FALSE is returned by IDirectSoundFXDistortion8::SetAllParameters.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXDistortion']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxdistortion</msdn-id>
<unmanaged>DSFXDistortion</unmanaged>
<unmanaged-short>DSFXDistortion</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.DistortionSettings.Gain">
<summary>
<dd> Amount of signal change after distortion, in the range from DSFXDISTORTION_GAIN_MIN through DSFXDISTORTION_GAIN_MAX. The default value is -18 dB. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXDistortion::fGain']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxdistortion</msdn-id>
<unmanaged>float fGain</unmanaged>
<unmanaged-short>float fGain</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.DistortionSettings.Edge">
<summary>
<dd> Percentage of distortion intensity, in the range in the range from DSFXDISTORTION_EDGE_MIN through DSFXDISTORTION_EDGE_MAX. The default value is 15 percent. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXDistortion::fEdge']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxdistortion</msdn-id>
<unmanaged>float fEdge</unmanaged>
<unmanaged-short>float fEdge</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.DistortionSettings.PostEQCenterFrequency">
<summary>
<dd> Center frequency of harmonic content addition, in the range from DSFXDISTORTION_POSTEQCENTERFREQUENCY_MIN through DSFXDISTORTION_POSTEQCENTERFREQUENCY_MAX. The default value is 2400 Hz. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXDistortion::fPostEQCenterFrequency']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxdistortion</msdn-id>
<unmanaged>float fPostEQCenterFrequency</unmanaged>
<unmanaged-short>float fPostEQCenterFrequency</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.DistortionSettings.PostEQBandwidth">
<summary>
<dd> Width of frequency band that determines range of harmonic content addition, in the range from DSFXDISTORTION_POSTEQBANDWIDTH_MIN through DSFXDISTORTION_POSTEQBANDWIDTH_MAX. The default value is 2400 Hz. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXDistortion::fPostEQBandwidth']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxdistortion</msdn-id>
<unmanaged>float fPostEQBandwidth</unmanaged>
<unmanaged-short>float fPostEQBandwidth</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.DistortionSettings.PreLowpassCutoff">
<summary>
<dd> Filter cutoff for high-frequency harmonics attenuation, in the range from DSFXDISTORTION_PRELOWPASSCUTOFF_MIN through DSFXDISTORTION_PRELOWPASSCUTOFF_MAX. The default value is 8000 Hz. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXDistortion::fPreLowpassCutoff']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxdistortion</msdn-id>
<unmanaged>float fPreLowpassCutoff</unmanaged>
<unmanaged-short>float fPreLowpassCutoff</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.EchoSettings">
<summary>
The <see cref="T:SharpDX.DirectSound.EchoSettings" /> structure contains parameters for an echo effect.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXEcho']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxecho</msdn-id>
<unmanaged>DSFXEcho</unmanaged>
<unmanaged-short>DSFXEcho</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.EchoSettings.WetDryMix">
<summary>
<dd> Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from DSFXECHO_WETDRYMIX_MIN through DSFXECHO_WETDRYMIX_MAX (all wet). The default value is 50. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXEcho::fWetDryMix']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxecho</msdn-id>
<unmanaged>float fWetDryMix</unmanaged>
<unmanaged-short>float fWetDryMix</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.EchoSettings.Feedback">
<summary>
<dd> Percentage of output fed back into input, in the range from DSFXECHO_FEEDBACK_MIN through DSFXECHO_FEEDBACK_MAX. The default value is 50. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXEcho::fFeedback']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxecho</msdn-id>
<unmanaged>float fFeedback</unmanaged>
<unmanaged-short>float fFeedback</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.EchoSettings.LeftDelay">
<summary>
<dd> Delay for left channel, in milliseconds, in the range from DSFXECHO_LEFTDELAY_MIN through DSFXECHO_LEFTDELAY_MAX. The default value is 500 ms. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXEcho::fLeftDelay']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxecho</msdn-id>
<unmanaged>float fLeftDelay</unmanaged>
<unmanaged-short>float fLeftDelay</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.EchoSettings.RightDelay">
<summary>
<dd> Delay for right channel, in milliseconds, in the range from DSFXECHO_RIGHTDELAY_MIN through DSFXECHO_RIGHTDELAY_MAX. The default value is 500 ms. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXEcho::fRightDelay']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxecho</msdn-id>
<unmanaged>float fRightDelay</unmanaged>
<unmanaged-short>float fRightDelay</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.EchoSettings.PanDelay">
<summary>
<dd> Value that specifies whether to swap left and right delays with each successive echo. The default value is zero, meaning no swap. Possible values are defined as DSFXECHO_PANDELAY_MIN (equivalent to <see cref="F:SharpDX.Result.False" />) and DSFXECHO_PANDELAY_MAX (equivalent to TRUE). </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXEcho::lPanDelay']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxecho</msdn-id>
<unmanaged>int lPanDelay</unmanaged>
<unmanaged-short>int lPanDelay</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.FlangerSettings">
<summary>
The <see cref="T:SharpDX.DirectSound.FlangerSettings" /> structure contains parameters for a flange effect.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXFlanger']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxflanger</msdn-id>
<unmanaged>DSFXFlanger</unmanaged>
<unmanaged-short>DSFXFlanger</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.FlangerSettings.WetDryMix">
<summary>
<dd> Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from DSFXFLANGER_WETDRYMIX_MIN through DSFXFLANGER_WETDRYMIX_MAX (all wet). The default value is 50. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXFlanger::fWetDryMix']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxflanger</msdn-id>
<unmanaged>float fWetDryMix</unmanaged>
<unmanaged-short>float fWetDryMix</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.FlangerSettings.Depth">
<summary>
<dd> Percentage by which the delay time is modulated by the low-frequency oscillator (LFO), in hundredths of a percentage point. Must be in the range from DSFXFLANGER_DEPTH_MIN through DSFXFLANGER_DEPTH_MAX. The default value is 100. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXFlanger::fDepth']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxflanger</msdn-id>
<unmanaged>float fDepth</unmanaged>
<unmanaged-short>float fDepth</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.FlangerSettings.Feedback">
<summary>
<dd> Percentage of output signal to feed back into the effect's input, in the range from DSFXFLANGER_FEEDBACK_MIN to DSFXFLANGER_FEEDBACK_MAX. The default value is -50. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXFlanger::fFeedback']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxflanger</msdn-id>
<unmanaged>float fFeedback</unmanaged>
<unmanaged-short>float fFeedback</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.FlangerSettings.Frequency">
<summary>
<dd> Frequency of the LFO, in the range from DSFXFLANGER_FREQUENCY_MIN to DSFXFLANGER_FREQUENCY_MAX. The default value is 0.25. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXFlanger::fFrequency']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxflanger</msdn-id>
<unmanaged>float fFrequency</unmanaged>
<unmanaged-short>float fFrequency</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.FlangerSettings.Waveform">
<summary>
<dd> Waveform shape of the LFO. By default, the waveform is a sine. Possible values are defined in the following table.
<table> <tr><th>Value
</th><th>Description
</th></tr> <tr><td>DSFXFLANGER_WAVE_TRIANGLE
</td><td>Triangle.
</td></tr> <tr><td>DSFXFLANGER_WAVE_SIN
</td><td>Sine.
</td></tr> </table> </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXFlanger::lWaveform']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxflanger</msdn-id>
<unmanaged>int lWaveform</unmanaged>
<unmanaged-short>int lWaveform</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.FlangerSettings.Delay">
<summary>
<dd> Number of milliseconds the input is delayed before it is played back, in the range from DSFXFLANGER_DELAY_MIN to DSFXFLANGER_DELAY_MAX. The default value is 2 ms. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXFlanger::fDelay']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxflanger</msdn-id>
<unmanaged>float fDelay</unmanaged>
<unmanaged-short>float fDelay</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.FlangerSettings.Phase">
<summary>
<dd> Phase differential between left and right LFOs, in the range from DSFXFLANGER_PHASE_MIN through DSFXFLANGER_PHASE_MAX. Possible values are defined in the following table.
<table> <tr><th>Value
</th></tr> <tr><td>DSFXFLANGER_PHASE_NEG_180
</td></tr> <tr><td>DSFXFLANGER_PHASE_NEG_90
</td></tr> <tr><td>DSFXFLANGER_PHASE_ZERO
</td></tr> <tr><td>DSFXFLANGER_PHASE_90
</td></tr> <tr><td>DSFXFLANGER_PHASE_180
</td></tr> </table> <p>The default value is DSFXFLANGER_PHASE_ZERO.</p> </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXFlanger::lPhase']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxflanger</msdn-id>
<unmanaged>int lPhase</unmanaged>
<unmanaged-short>int lPhase</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.GargleSettings">
<summary>
The <see cref="T:SharpDX.DirectSound.GargleSettings" /> structure contains parameters for an amplitude modulation effect.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXGargle']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxgargle</msdn-id>
<unmanaged>DSFXGargle</unmanaged>
<unmanaged-short>DSFXGargle</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.GargleSettings.RateHz">
<summary>
<dd> Rate of modulation, in Hertz. Must be in the range from DSFXGARGLE_RATEHZ_MIN through DSFXGARGLE_RATEHZ_MAX. The default value is 20. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXGargle::dwRateHz']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxgargle</msdn-id>
<unmanaged>unsigned int dwRateHz</unmanaged>
<unmanaged-short>unsigned int dwRateHz</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.GargleSettings.WaveShape">
<summary>
<dd> Shape of the modulation waveform. The following values are defined. <table> <tr><th>Value
</th><th>Description
</th></tr> <tr><td>DSFXGARGLE_WAVE_TRIANGLE
</td><td>Triangular waveform.
</td></tr> <tr><td>DSFXGARGLE_WAVE_SQUARE
</td><td>Square waveform.
</td></tr> </table> <p>The default value is DSFXGARGLE_WAVE_TRIANGLE.</p> </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXGargle::dwWaveShape']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxgargle</msdn-id>
<unmanaged>unsigned int dwWaveShape</unmanaged>
<unmanaged-short>unsigned int dwWaveShape</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.I3DL2ReverbSettings">
<summary>
The <see cref="T:SharpDX.DirectSound.I3DL2ReverbSettings" /> structure contains parameters for an I3DL2 (Interactive 3D Audio Level 2) reverberation effect.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXI3DL2Reverb']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxi3dl2reverb</msdn-id>
<unmanaged>DSFXI3DL2Reverb</unmanaged>
<unmanaged-short>DSFXI3DL2Reverb</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbSettings.Room">
<summary>
<dd> Attenuation of the room effect, in millibels (mB), in the range from DSFX_I3DL2REVERB_ROOM_MIN to DSFX_I3DL2REVERB_ROOM_MAX. The default value is DSFX_I3DL2REVERB_ROOM_DEFAULT, or -1000 mB. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXI3DL2Reverb::lRoom']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxi3dl2reverb</msdn-id>
<unmanaged>int lRoom</unmanaged>
<unmanaged-short>int lRoom</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbSettings.RoomHF">
<summary>
<dd> Attenuation of the room high-frequency effect, in mB, in the range from DSFX_I3DL2REVERB_ROOMHF_MIN to DSFX_I3DL2REVERB_ROOMHF_MAX. The default value is DSFX_I3DL2REVERB_ROOMHF_DEFAULT, or -100 mB. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXI3DL2Reverb::lRoomHF']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxi3dl2reverb</msdn-id>
<unmanaged>int lRoomHF</unmanaged>
<unmanaged-short>int lRoomHF</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbSettings.RoomRolloffFactor">
<summary>
<dd> Rolloff factor for the reflected signals, in the range from DSFX_I3DL2REVERB_ROOMROLLOFFFACTOR_MIN to DSFX_I3DL2REVERB_ROOMROLLOFFFACTOR_MAX. The default value is DSFX_I3DL2REVERB_ROOMROLLOFFFACTOR_DEFAULT, or 0.0. The rolloff factor for the direct path is controlled by the DirectSound listener. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXI3DL2Reverb::flRoomRolloffFactor']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxi3dl2reverb</msdn-id>
<unmanaged>float flRoomRolloffFactor</unmanaged>
<unmanaged-short>float flRoomRolloffFactor</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbSettings.DecayTime">
<summary>
<dd> Decay time, in seconds, in the range from DSFX_I3DL2REVERB_DECAYTIME_MIN to DSFX_I3DL2REVERB_DECAYTIME_MAX. The default value is DSFX_I3DL2REVERB_DECAYTIME_DEFAULT, or 1.49 second. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXI3DL2Reverb::flDecayTime']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxi3dl2reverb</msdn-id>
<unmanaged>float flDecayTime</unmanaged>
<unmanaged-short>float flDecayTime</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbSettings.DecayHFRatio">
<summary>
<dd> Ratio of the decay time at high frequencies to the decay time at low frequencies, in the range from DSFX_I3DL2REVERB_DECAYHFRATIO_MIN to DSFX_I3DL2REVERB_DECAYHFRATIO_MAX. The default value is DSFX_I3DL2REVERB_DECAYHFRATIO_DEFAULT, or 0.83. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXI3DL2Reverb::flDecayHFRatio']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxi3dl2reverb</msdn-id>
<unmanaged>float flDecayHFRatio</unmanaged>
<unmanaged-short>float flDecayHFRatio</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbSettings.Reflections">
<summary>
<dd> Attenuation of early reflections relative to lRoom, in mB, in the range from DSFX_I3DL2REVERB_REFLECTIONS_MIN to DSFX_I3DL2REVERB_REFLECTIONS_MAX. The default value is DSFX_I3DL2REVERB_REFLECTIONS_DEFAULT, or -2602 mB. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXI3DL2Reverb::lReflections']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxi3dl2reverb</msdn-id>
<unmanaged>int lReflections</unmanaged>
<unmanaged-short>int lReflections</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbSettings.ReflectionsDelay">
<summary>
<dd> Delay time of the first reflection relative to the direct path, in seconds, in the range from DSFX_I3DL2REVERB_REFLECTIONSDELAY_MIN to DSFX_I3DL2REVERB_REFLECTIONSDELAY_DEFAULT. The default value is 0.007 seconds. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXI3DL2Reverb::flReflectionsDelay']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxi3dl2reverb</msdn-id>
<unmanaged>float flReflectionsDelay</unmanaged>
<unmanaged-short>float flReflectionsDelay</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbSettings.Reverb">
<summary>
<dd> Attenuation of late reverberation relative to lRoom, in mB, in the range -from DSFX_I3DL2REVERB_REVERB_MIN to DSFX_I3DL2REVERB_REVERB_MAX. The default value is DSFX_I3DL2REVERB_REVERB_DEFAULT, or 200 mB. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXI3DL2Reverb::lReverb']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxi3dl2reverb</msdn-id>
<unmanaged>int lReverb</unmanaged>
<unmanaged-short>int lReverb</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbSettings.ReverbDelay">
<summary>
<dd> Time limit between the early reflections and the late reverberation relative to the time of the first reflection, in seconds, in the range from DSFX_I3DL2REVERB_REVERBDELAY_MIN to DSFX_I3DL2REVERB_REVERBDELAY_MAX. The default value is DSFX_I3DL2REVERB_REVERBDELAY_DEFAULT, or 0.011 seconds. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXI3DL2Reverb::flReverbDelay']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxi3dl2reverb</msdn-id>
<unmanaged>float flReverbDelay</unmanaged>
<unmanaged-short>float flReverbDelay</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbSettings.Diffusion">
<summary>
<dd> Echo density in the late reverberation decay, in percent, in the range from DSFX_I3DL2REVERB_DIFFUSION_MIN to DSFX_I3DL2REVERB_DIFFUSION_MAX. The default value is DSFX_I3DL2REVERB_DIFFUSION_DEFAULT, or 100.0 percent. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXI3DL2Reverb::flDiffusion']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxi3dl2reverb</msdn-id>
<unmanaged>float flDiffusion</unmanaged>
<unmanaged-short>float flDiffusion</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbSettings.Density">
<summary>
<dd> Modal density in the late reverberation decay, in percent, in the range from DSFX_I3DL2REVERB_DENSITY_MIN to DSFX_I3DL2REVERB_DENSITY_MAX. The default value is DSFX_I3DL2REVERB_DENSITY_DEFAULT, or 100.0 percent. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXI3DL2Reverb::flDensity']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxi3dl2reverb</msdn-id>
<unmanaged>float flDensity</unmanaged>
<unmanaged-short>float flDensity</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.I3DL2ReverbSettings.HFReference">
<summary>
<dd> Reference high frequency, in hertz, in the range from DSFX_I3DL2REVERB_HFREFERENCE_MIN to DSFX_I3DL2REVERB_HFREFERENCE_MAX. The default value is DSFX_I3DL2REVERB_HFREFERENCE_DEFAULT, or 5000.0 Hz. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXI3DL2Reverb::flHFReference']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxi3dl2reverb</msdn-id>
<unmanaged>float flHFReference</unmanaged>
<unmanaged-short>float flHFReference</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.Listener3DSettings">
<summary>
The <see cref="T:SharpDX.DirectSound.Listener3DSettings" /> structure describes the 3D world parameters and the position of the listener. This structure is used with theIDirectSound3DListener8::GetAllParametersandIDirectSound3DListener8::SetAllParametersmethods.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DLISTENER']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dlistener</msdn-id>
<unmanaged>DS3DLISTENER</unmanaged>
<unmanaged-short>DS3DLISTENER</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Listener3DSettings.Size">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DLISTENER::dwSize']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dlistener</msdn-id>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Listener3DSettings.Position">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DLISTENER::vPosition']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dlistener</msdn-id>
<unmanaged>D3DVECTOR vPosition</unmanaged>
<unmanaged-short>D3DVECTOR vPosition</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Listener3DSettings.Velocity">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DLISTENER::vVelocity']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dlistener</msdn-id>
<unmanaged>D3DVECTOR vVelocity</unmanaged>
<unmanaged-short>D3DVECTOR vVelocity</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Listener3DSettings.OrientFront">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DLISTENER::vOrientFront']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dlistener</msdn-id>
<unmanaged>D3DVECTOR vOrientFront</unmanaged>
<unmanaged-short>D3DVECTOR vOrientFront</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Listener3DSettings.OrientTop">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DLISTENER::vOrientTop']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dlistener</msdn-id>
<unmanaged>D3DVECTOR vOrientTop</unmanaged>
<unmanaged-short>D3DVECTOR vOrientTop</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Listener3DSettings.DistanceFactor">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DLISTENER::flDistanceFactor']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dlistener</msdn-id>
<unmanaged>float flDistanceFactor</unmanaged>
<unmanaged-short>float flDistanceFactor</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Listener3DSettings.RolloffFactor">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DLISTENER::flRolloffFactor']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dlistener</msdn-id>
<unmanaged>float flRolloffFactor</unmanaged>
<unmanaged-short>float flRolloffFactor</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.Listener3DSettings.DopplerFactor">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DS3DLISTENER::flDopplerFactor']/*" />
<msdn-id>microsoft.directx_sdk.reference.ds3dlistener</msdn-id>
<unmanaged>float flDopplerFactor</unmanaged>
<unmanaged-short>float flDopplerFactor</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.Listener3DSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.Listener3DSettings"/> class.
</summary>
</member>
<member name="T:SharpDX.DirectSound.NoiseSuppressSettings">
<summary>
The <see cref="T:SharpDX.DirectSound.NoiseSuppressSettings" /> structure contains parameters for noise suppression in a capture buffer.
</summary>
<remarks>
<table><tr><th>Windows </th></tr><tr><td><p>Important Note for Windows Vista</p> <p>Existing applications that access Windows XP Acoustic Echo Cancellation (AEC) features via the DirectSound API will no longer obtain AEC when running on Windows Vista. These applications will still run, but their calls to AEC-specific DirectSound API calls will have no effect on the captured audio.</p><p>To learn how to obtain AEC in Windows Vista, See the Windows Vista AEC topics in the Windows SDK.</p></td></tr></table>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFXNoiseSuppress']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscfxnoisesuppress</msdn-id>
<unmanaged>DSCFXNoiseSuppress</unmanaged>
<unmanaged-short>DSCFXNoiseSuppress</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.NoiseSuppressSettings.Enable">
<summary>
<dd> Boolean value that specifies whether the effect is enabled. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSCFXNoiseSuppress::fEnable']/*" />
<msdn-id>microsoft.directx_sdk.reference.dscfxnoisesuppress</msdn-id>
<unmanaged>BOOL fEnable</unmanaged>
<unmanaged-short>BOOL fEnable</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.NotificationPosition">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBPOSITIONNOTIFY']/*" />
<unmanaged>DSBPOSITIONNOTIFY</unmanaged>
<unmanaged-short>DSBPOSITIONNOTIFY</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.NotificationPosition.Offset">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBPOSITIONNOTIFY::dwOffset']/*" />
<unmanaged>unsigned int dwOffset</unmanaged>
<unmanaged-short>unsigned int dwOffset</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.NotificationPosition.EventNotifyHandlerPointer">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBPOSITIONNOTIFY::hEventNotify']/*" />
<unmanaged>void* hEventNotify</unmanaged>
<unmanaged-short>void hEventNotify</unmanaged-short>
</member>
<member name="P:SharpDX.DirectSound.NotificationPosition.WaitHandle">
<summary>
Gets or sets the wait handle.
</summary>
<value>The wait handle.</value>
</member>
<member name="T:SharpDX.DirectSound.ParametricEqualizerSettings">
<summary>
The <see cref="T:SharpDX.DirectSound.ParametricEqualizerSettings" /> structure contains parameters for a parametric equalizer effect.
</summary>
<remarks>
<p>The value in fCenter cannot exceed one-third of the sampling frequency of the buffer. If an attempt is made to set a value greater than this, but within the range of accepted values, the parameter is set to the nearest supported value and S_FALSE is returned by IDirectSoundFXParamEq8::SetAllParameters.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXParamEq']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxparameq</msdn-id>
<unmanaged>DSFXParamEq</unmanaged>
<unmanaged-short>DSFXParamEq</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.ParametricEqualizerSettings.Center">
<summary>
<dd> Center frequency, in hertz, in the range from DSFXPARAMEQ_CENTER_MIN to DSFXPARAMEQ_CENTER_MAX. The default value is 8000. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXParamEq::fCenter']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxparameq</msdn-id>
<unmanaged>float fCenter</unmanaged>
<unmanaged-short>float fCenter</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.ParametricEqualizerSettings.Bandwidth">
<summary>
<dd> Bandwidth, in semitones, in the range from DSFXPARAMEQ_BANDWIDTH_MIN to DSFXPARAMEQ_BANDWIDTH_MAX. The default value is 12. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXParamEq::fBandwidth']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxparameq</msdn-id>
<unmanaged>float fBandwidth</unmanaged>
<unmanaged-short>float fBandwidth</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.ParametricEqualizerSettings.Gain">
<summary>
<dd> Gain, in the range from DSFXPARAMEQ_GAIN_MIN to DSFXPARAMEQ_GAIN_MAX. The default value is 0. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXParamEq::fGain']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxparameq</msdn-id>
<unmanaged>float fGain</unmanaged>
<unmanaged-short>float fGain</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.SoundBufferDescription">
<summary>
The <see cref="T:SharpDX.DirectSound.SoundBufferDescription" /> structure describes the characteristics of a new buffer object. It is used by theIDirectSound8::CreateSoundBuffermethod and by theDirectSoundFullDuplexCreate8function.<p>An earlier version of this structure, DSBUFFERDESC1, is maintained in Dsound.h for compatibility with DirectX 7 and earlier.</p>
</summary>
<remarks>
<p>When creating a primary buffer, applications must set the dwBufferBytes member to zero. DirectSound will determine the best buffer size for the particular sound device in use. To determine the size of a created primary buffer, call IDirectSoundBuffer8::GetCaps.</p> <p>The DSBCAPS_CTRLDEFAULT flag is no longer supported. This flag was defined as <see cref="F:SharpDX.DirectSound.BufferFlags.ControlPan" /> | <see cref="F:SharpDX.DirectSound.BufferFlags.ControlVolume" /> | <see cref="F:SharpDX.DirectSound.BufferFlags.ControlFrequency" />. By specifying only the flags you need, you cut down on unnecessary resource usage.</p> <p>On VXD drivers, a sound buffer created with <see cref="F:SharpDX.DirectSound.BufferFlags.ControlPositionNotify" /> is always a software buffer, because the VXD driver model does not support notifications. With WDM drivers, a notification-enabled buffer can be in hardware, if hardware resources are available.</p> <p>The <see cref="F:SharpDX.DirectSound.BufferFlags.Hardware" /> and <see cref="F:SharpDX.DirectSound.BufferFlags.Software" /> flags are optional and mutually exclusive. <see cref="F:SharpDX.DirectSound.BufferFlags.Hardware" /> forces the buffer to reside in hardware, meaning that it will be mixed by the sound card. <see cref="F:SharpDX.DirectSound.BufferFlags.Software" /> forces the buffer to reside in software, where it is mixed by the CPU. These flags are also defined for the dwFlags member <see cref="T:SharpDX.DirectSound.BufferCapabilities" />.</p> <p>The 3D algorithms represent selection of the software emulation layer only: that is, the software algorithm that is used when no hardware is present for acceleration. In order to maximize hardware utilization, <see cref="F:SharpDX.DirectSound.DirectSound3DAlgorithmGuid.NoVirtualization3DAlgorithm" /> is treated as a special case. If no free 3D hardware voices are available, the buffer is then treated as a 2D buffer, but with 3D control. Specifically, when a sound buffer is created with <see cref="F:SharpDX.DirectSound.DirectSound3DAlgorithmGuid.NoVirtualization3DAlgorithm" />, or when the buffer is played if the buffer was created with DSBPLAY_LOCDEFER, the following procedure is followed:</p> <ol> <li><p>If a free hardware 3D voice is available, that 3D hardware voice is used.</p></li> <li><p>If no free hardware 3D voices are available and a 2D hardware voice is available, that 2D hardware voice will be used. This is possible because the <see cref="F:SharpDX.DirectSound.DirectSound3DAlgorithmGuid.NoVirtualization3DAlgorithm" /> algorithm is a simple stereo pan algorithm</p></li> <li><p>If no free 2D or 3D hardware voices are available, the voice will be played in software using the <see cref="F:SharpDX.DirectSound.DirectSound3DAlgorithmGuid.NoVirtualization3DAlgorithm" /> algorithm.</p></li> </ol> <p>If a speaker configuration other than <see cref="F:SharpDX.DirectSound.SpeakerConfiguration.Headphone" /> or <see cref="F:SharpDX.DirectSound.SpeakerConfiguration.Stereo" /> is in effect, the processing will be done as if for a two-speaker configuration.</p> <p>If a buffer is created using one of the HRTF algorithms, and the HRTF algorithm is not available on the system (for example, a non-WDM system), a success code, DS_NO_VIRTUALIZATION, is returned. The sound buffer created will use <see cref="F:SharpDX.DirectSound.DirectSound3DAlgorithmGuid.NoVirtualization3DAlgorithm" /> instead. For this reason, applications should use the SUCCEEDED or FAILED macros rather than checking explicitly for DS_OK when calling CreateSoundBuffer.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBUFFERDESC']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsbufferdesc</msdn-id>
<unmanaged>DSBUFFERDESC</unmanaged>
<unmanaged-short>DSBUFFERDESC</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundBufferDescription.Size">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBUFFERDESC::dwSize']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsbufferdesc</msdn-id>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundBufferDescription.Flags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBUFFERDESC::dwFlags']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsbufferdesc</msdn-id>
<unmanaged>DSBCAPS_FLAGS dwFlags</unmanaged>
<unmanaged-short>DSBCAPS_FLAGS dwFlags</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundBufferDescription.BufferBytes">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBUFFERDESC::dwBufferBytes']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsbufferdesc</msdn-id>
<unmanaged>unsigned int dwBufferBytes</unmanaged>
<unmanaged-short>unsigned int dwBufferBytes</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundBufferDescription.Reserved">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBUFFERDESC::dwReserved']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsbufferdesc</msdn-id>
<unmanaged>unsigned int dwReserved</unmanaged>
<unmanaged-short>unsigned int dwReserved</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundBufferDescription.pFormat">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBUFFERDESC::lpwfxFormat']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsbufferdesc</msdn-id>
<unmanaged>WAVEFORMATEX* lpwfxFormat</unmanaged>
<unmanaged-short>WAVEFORMATEX lpwfxFormat</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundBufferDescription.AlgorithmFor3D">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSBUFFERDESC::guid3DAlgorithm']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsbufferdesc</msdn-id>
<unmanaged>GUID guid3DAlgorithm</unmanaged>
<unmanaged-short>GUID guid3DAlgorithm</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBufferDescription.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.SoundBufferDescription"/> class.
</summary>
</member>
<member name="F:SharpDX.DirectSound.SoundBufferDescription.Format">
<summary>
WaveFormat of this sound buffer description
</summary>
</member>
<member name="T:SharpDX.DirectSound.SoundBufferEffectDescription">
<summary>
The <see cref="T:SharpDX.DirectSound.SoundBufferEffectDescription" /> structure describes an effect associated with a buffer.
</summary>
<remarks>
<p>Custom effects can be implemented as DMOs. Effect DMOs must implement the <see cref="!:SharpDX.MediaFoundation.IMediaObject" /> and <see cref="!:SharpDX.MediaFoundation.IMediaObjectInPlace" /> interfaces.</p> <p>If dwFlags is zero, the effect is placed in hardware if possible. If the hardware does not support the effect (always the case since DirectX 9.0), software is used. If the effect is not available at all, the call to SetFX fails.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSEFFECTDESC']/*" />
<msdn-id>microsoft.directx_sdk.reference.dseffectdesc</msdn-id>
<unmanaged>DSEFFECTDESC</unmanaged>
<unmanaged-short>DSEFFECTDESC</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundBufferEffectDescription.Size">
<summary>
<dd> Size of the structure, in bytes. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSEFFECTDESC::dwSize']/*" />
<msdn-id>microsoft.directx_sdk.reference.dseffectdesc</msdn-id>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundBufferEffectDescription.Flags">
<summary>
<dd> Flags. Can be zero or one of the following values. <table> <tr><th>Value
</th><th>Description
</th></tr> <tr><td>DSFX_LOCHARDWARE
</td><td>Effect must be in hardware. If the effect is not available in hardware, <see cref="M:SharpDX.DirectSound.SecondarySoundBuffer.SetEffect(System.Int32,SharpDX.DirectSound.SoundBufferEffectDescription[],SharpDX.DirectSound.SoundEffectResult[])" /> raises an error. Since DirectX 9.0, DirectX does not support hardware acceleration of effects, so this flag should not be used.
</td></tr> <tr><td>DSFX_LOCSOFTWARE
</td><td>Effect must be in software, even if the hardware supports acceleration of guidDSFXClass. If the effect is not available in software, SetFX raises an error. Since DirectX 9.0, all effects are in software regardless of whether this flag is set.
</td></tr> </table> </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSEFFECTDESC::dwFlags']/*" />
<msdn-id>microsoft.directx_sdk.reference.dseffectdesc</msdn-id>
<unmanaged>unsigned int dwFlags</unmanaged>
<unmanaged-short>unsigned int dwFlags</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundBufferEffectDescription.idDSFXClass">
<summary>
<dd> Class identifier of the effect. The following standard effect classes are defined. <table> <tr><th>Value
</th><th>Description
</th></tr> <tr><td><see cref="F:SharpDX.DirectSound.SoundEffectGuid.StandardChorus" />
</td><td>Chorus
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.SoundEffectGuid.StandardCompressor" />
</td><td>Compressor
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.SoundEffectGuid.StandardDistortion" />
</td><td>Distortion
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.SoundEffectGuid.StandardEcho" />
</td><td>Echo
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.SoundEffectGuid.StandardFlanger" />
</td><td>Flanger
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.SoundEffectGuid.StandardGargle" />
</td><td>Gargle
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.SoundEffectGuid.StandardI3DL2REVERB" />
</td><td>Interactive 3D Level 2 reverb
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.SoundEffectGuid.StandardParameq" />
</td><td>Parametric equalizer
</td></tr> <tr><td><see cref="F:SharpDX.DirectSound.SoundEffectGuid.WavesReverb" />
</td><td>Waves reverb
</td></tr> </table> </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSEFFECTDESC::guidDSFXClass']/*" />
<msdn-id>microsoft.directx_sdk.reference.dseffectdesc</msdn-id>
<unmanaged>GUID guidDSFXClass</unmanaged>
<unmanaged-short>GUID guidDSFXClass</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundBufferEffectDescription.Reserved1">
<summary>
<dd> Reserved for future use. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSEFFECTDESC::dwReserved1']/*" />
<msdn-id>microsoft.directx_sdk.reference.dseffectdesc</msdn-id>
<unmanaged>ULONG_PTR dwReserved1</unmanaged>
<unmanaged-short>ULONG_PTR dwReserved1</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.SoundBufferEffectDescription.Reserved2">
<summary>
<dd> Reserved for future use. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSEFFECTDESC::dwReserved2']/*" />
<msdn-id>microsoft.directx_sdk.reference.dseffectdesc</msdn-id>
<unmanaged>ULONG_PTR dwReserved2</unmanaged>
<unmanaged-short>ULONG_PTR dwReserved2</unmanaged-short>
</member>
<member name="M:SharpDX.DirectSound.SoundBufferEffectDescription.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.SoundBufferEffectDescription"/> class.
</summary>
</member>
<member name="T:SharpDX.DirectSound.WavesReverbSettings">
<summary>
The <see cref="T:SharpDX.DirectSound.WavesReverbSettings" /> structure contains parameters for a Waves reverberation effect.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXWavesReverb']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxwavesreverb</msdn-id>
<unmanaged>DSFXWavesReverb</unmanaged>
<unmanaged-short>DSFXWavesReverb</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.WavesReverbSettings.InGain">
<summary>
<dd> Input gain of signal, in decibels (dB), in the range from DSFX_WAVESREVERB_INGAIN_MIN through DSFX_WAVESREVERB_INGAIN_MAX. The default value is DSFX_WAVESREVERB_INGAIN_DEFAULT, or 0 dB. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXWavesReverb::fInGain']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxwavesreverb</msdn-id>
<unmanaged>float fInGain</unmanaged>
<unmanaged-short>float fInGain</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.WavesReverbSettings.ReverbMix">
<summary>
<dd> Reverb mix, in dB, in the range from DSFX_WAVESREVERB_REVERBMIX_MIN through DSFX_WAVESREVERB_REVERBMIX_MAX. The default value is DSFX_WAVESREVERB_REVERBMIX_DEFAULT, or 0 dB. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXWavesReverb::fReverbMix']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxwavesreverb</msdn-id>
<unmanaged>float fReverbMix</unmanaged>
<unmanaged-short>float fReverbMix</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.WavesReverbSettings.ReverbTime">
<summary>
<dd> Reverb time, in milliseconds, in the range from DSFX_WAVESREVERB_REVERBTIME_MIN through DSFX_WAVESREVERB_REVERBTIME_MAX. The default value is DSFX_WAVESREVERB_REVERBTIME_DEFAULT, or 1000. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXWavesReverb::fReverbTime']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxwavesreverb</msdn-id>
<unmanaged>float fReverbTime</unmanaged>
<unmanaged-short>float fReverbTime</unmanaged-short>
</member>
<member name="F:SharpDX.DirectSound.WavesReverbSettings.HighFreqRTRatio">
<summary>
<dd> High-frequency reverb time ratio, in the range from DSFX_WAVESREVERB_HIGHFREQRTRATIO_MIN through DSFX_WAVESREVERB_HIGHFREQRTRATIO_MAX. The default value is DSFX_WAVESREVERB_HIGHFREQRTRATIO_DEFAULT, or 0.001. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='DSFXWavesReverb::fHighFreqRTRatio']/*" />
<msdn-id>microsoft.directx_sdk.reference.dsfxwavesreverb</msdn-id>
<unmanaged>float fHighFreqRTRatio</unmanaged>
<unmanaged-short>float fHighFreqRTRatio</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.NamespaceDoc">
<summary>
The <see cref="N:SharpDX.DirectSound"/> namespace provides a managed DirectSound API.
</summary>
<msdn-id>ee416960</msdn-id>
<unmanaged>DirectSound</unmanaged>
<unmanaged-short>DirectSound</unmanaged-short>
</member>
<member name="T:SharpDX.DirectSound.PrimarySoundBuffer">
<summary>
A Primary DirectSound Buffer.
</summary>
</member>
<member name="M:SharpDX.DirectSound.PrimarySoundBuffer.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.PrimarySoundBuffer"/> class.
</summary>
<param name="basePtr">The base PTR.</param>
</member>
<member name="M:SharpDX.DirectSound.PrimarySoundBuffer.#ctor(SharpDX.DirectSound.DirectSound,SharpDX.DirectSound.SoundBufferDescription)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.DirectSound.PrimarySoundBuffer"/> class.
</summary>
<param name="dSound">an instance of the <see cref="T:SharpDX.DirectSound.DirectSound"/></param>
<param name="bufferDescription">The buffer description.</param>
</member>
</members>
</doc>
View Git Blame Copy Permalink