The <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DBUFFER']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DBUFFER::dwSize']/*"/>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DBUFFER::vPosition']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DBUFFER::vVelocity']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DBUFFER::dwInsideConeAngle']/*"/>
<unmanaged>unsigned int dwInsideConeAngle</unmanaged>
<unmanaged-short>unsigned int dwInsideConeAngle</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DBUFFER::dwOutsideConeAngle']/*"/>
<unmanaged>unsigned int dwOutsideConeAngle</unmanaged>
<unmanaged-short>unsigned int dwOutsideConeAngle</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DBUFFER::vConeOrientation']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DBUFFER::lConeOutsideVolume']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DBUFFER::flMinDistance']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DBUFFER::flMaxDistance']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DBUFFER::dwMode']/*"/>
<unmanaged>unsigned int dwMode</unmanaged>
<unmanaged-short>unsigned int dwMode</unmanaged-short>
</member>
<membername="T:SharpDX.DirectSound.Capabilities">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwSize']/*"/>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwFlags']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwMinSecondarySampleRate']/*"/>
<unmanaged>unsigned int dwMinSecondarySampleRate</unmanaged>
<unmanaged-short>unsigned int dwMinSecondarySampleRate</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwMaxSecondarySampleRate']/*"/>
<unmanaged>unsigned int dwMaxSecondarySampleRate</unmanaged>
<unmanaged-short>unsigned int dwMaxSecondarySampleRate</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwPrimaryBuffers']/*"/>
<unmanaged>unsigned int dwPrimaryBuffers</unmanaged>
<unmanaged-short>unsigned int dwPrimaryBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwMaxHwMixingAllBuffers']/*"/>
<unmanaged>unsigned int dwMaxHwMixingAllBuffers</unmanaged>
<unmanaged-short>unsigned int dwMaxHwMixingAllBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwMaxHwMixingStaticBuffers']/*"/>
<unmanaged>unsigned int dwMaxHwMixingStaticBuffers</unmanaged>
<unmanaged-short>unsigned int dwMaxHwMixingStaticBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwMaxHwMixingStreamingBuffers']/*"/>
<unmanaged>unsigned int dwMaxHwMixingStreamingBuffers</unmanaged>
<unmanaged-short>unsigned int dwMaxHwMixingStreamingBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwFreeHwMixingAllBuffers']/*"/>
<unmanaged>unsigned int dwFreeHwMixingAllBuffers</unmanaged>
<unmanaged-short>unsigned int dwFreeHwMixingAllBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwFreeHwMixingStaticBuffers']/*"/>
<unmanaged>unsigned int dwFreeHwMixingStaticBuffers</unmanaged>
<unmanaged-short>unsigned int dwFreeHwMixingStaticBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwFreeHwMixingStreamingBuffers']/*"/>
<unmanaged>unsigned int dwFreeHwMixingStreamingBuffers</unmanaged>
<unmanaged-short>unsigned int dwFreeHwMixingStreamingBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwMaxHw3DAllBuffers']/*"/>
<unmanaged>unsigned int dwMaxHw3DAllBuffers</unmanaged>
<unmanaged-short>unsigned int dwMaxHw3DAllBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwMaxHw3DStaticBuffers']/*"/>
<unmanaged>unsigned int dwMaxHw3DStaticBuffers</unmanaged>
<unmanaged-short>unsigned int dwMaxHw3DStaticBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwMaxHw3DStreamingBuffers']/*"/>
<unmanaged>unsigned int dwMaxHw3DStreamingBuffers</unmanaged>
<unmanaged-short>unsigned int dwMaxHw3DStreamingBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwFreeHw3DAllBuffers']/*"/>
<unmanaged>unsigned int dwFreeHw3DAllBuffers</unmanaged>
<unmanaged-short>unsigned int dwFreeHw3DAllBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwFreeHw3DStaticBuffers']/*"/>
<unmanaged>unsigned int dwFreeHw3DStaticBuffers</unmanaged>
<unmanaged-short>unsigned int dwFreeHw3DStaticBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwFreeHw3DStreamingBuffers']/*"/>
<unmanaged>unsigned int dwFreeHw3DStreamingBuffers</unmanaged>
<unmanaged-short>unsigned int dwFreeHw3DStreamingBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwTotalHwMemBytes']/*"/>
<unmanaged>unsigned int dwTotalHwMemBytes</unmanaged>
<unmanaged-short>unsigned int dwTotalHwMemBytes</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwFreeHwMemBytes']/*"/>
<unmanaged>unsigned int dwFreeHwMemBytes</unmanaged>
<unmanaged-short>unsigned int dwFreeHwMemBytes</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwMaxContigFreeHwMemBytes']/*"/>
<unmanaged>unsigned int dwMaxContigFreeHwMemBytes</unmanaged>
<unmanaged-short>unsigned int dwMaxContigFreeHwMemBytes</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwUnlockTransferRateHwBuffers']/*"/>
<unmanaged>unsigned int dwUnlockTransferRateHwBuffers</unmanaged>
<unmanaged-short>unsigned int dwUnlockTransferRateHwBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwPlayCpuOverheadSwBuffers']/*"/>
<unmanaged>unsigned int dwPlayCpuOverheadSwBuffers</unmanaged>
<unmanaged-short>unsigned int dwPlayCpuOverheadSwBuffers</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwReserved1']/*"/>
<unmanaged>unsigned int dwReserved1</unmanaged>
<unmanaged-short>unsigned int dwReserved1</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS::dwReserved2']/*"/>
<unmanaged>unsigned int dwReserved2</unmanaged>
<unmanaged-short>unsigned int dwReserved2</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureBuffer8']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureBuffer']/*"/>
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>
<paramname="offset">Offset, in bytes, from the start of the buffer to the point where the lock begins. </param>
<paramname="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>
<paramname="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>
<paramname="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>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.CaptureBufferBase"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
The GetCaps method retrieves the capabilities of the buffer.
</summary>
<paramname="dSCBCapsRef"><dd> Pointer to a <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureBuffer::GetCaps']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureBuffer::GetCurrentPosition']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureBuffer::GetFormat']/*"/>
The GetStatus method retrieves the status of the capture buffer.
</summary>
<paramname="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><seecref="F:SharpDX.DirectSound.CaptureBufferStatusFlags.Capturing"/></td><td>The buffer is capturing audio data.</td></tr><tr><td><seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureBuffer::GetStatus']/*"/>
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>
<paramname="offset"><dd> Offset, in bytes, from the start of the buffer to the point where the lock begins. </dd></param>
<paramname="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>
<paramname="dioPtr1Out"><dd> Address of a variable that receives a reference to the first locked part of the buffer. </dd></param>
<paramname="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>
<paramname="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>
<paramname="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>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureBuffer::Lock']/*"/>
<msdn-id>ee418179</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>
The Start method begins capturing data into the buffer. If the buffer is already capturing, the method has no effect.
</summary>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureBuffer::Start']/*"/>
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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureBuffer::Stop']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureBuffer::Unlock']/*"/>
<unmanaged>HRESULT IDirectSoundCaptureBuffer::Unlock([In, Buffer] void* pvAudioPtr1,[In] unsigned int dwAudioBytes1,[In, Buffer, Optional] void* pvAudioPtr2,[In] unsigned int dwAudioBytes2)</unmanaged>
The GetCaps method retrieves the capabilities of the buffer.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureBuffer::GetCaps']/*"/>
The GetStatus method retrieves the status of the capture buffer.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureBuffer::GetStatus']/*"/>
<paramname="capture">a reference to an instance of <seecref="T:SharpDX.DirectSound.DirectSoundCapture"/></param>
<paramname="description">a <seecref="T:SharpDX.DirectSound.CaptureBufferDescription"/> structure containing values for the capture buffer being created. </param>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.CaptureBuffer"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
The GetObjectInPath method retrieves an interface to an effect object associated with the buffer.
</summary>
<paramname="rguidObject"><dd> Value of type REFGUID that specifies the unique class identifier of the object being searched for, such as <seecref="F:SharpDX.DirectSound.CaptureEffectGuid.AcousticEchoCancellationCaptureEffect"/>. </dd></param>
<paramname="index"><dd> Index of the object within objects of that class in the path. See Remarks. </dd></param>
<paramname="rguidInterface"><dd> Unique identifier of the desired interface, such as IID_IDirectSoundCaptureFXAec8. </dd></param>
<paramname="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 <seecref="T:SharpDX.DirectSound.CaptureBufferDescription"/> structure passed to DirectSoundFullDuplexCreate8 or IDirectSoundCapture8::CreateCaptureBuffer.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureBuffer8::GetObjectInPath']/*"/>
The GetFXStatus method retrieves the status of capture effects.
</summary>
<paramname="effectsCount"><dd> Number of elements in the pdwFXStatus array. </dd></param>
<paramname="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 <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureBuffer8::GetFXStatus']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBCAPS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBCAPS::dwSize']/*"/>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBCAPS::dwFlags']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBCAPS::dwBufferBytes']/*"/>
<unmanaged>unsigned int dwBufferBytes</unmanaged>
<unmanaged-short>unsigned int dwBufferBytes</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBCAPS::dwReserved']/*"/>
<unmanaged>unsigned int dwReserved</unmanaged>
<unmanaged-short>unsigned int dwReserved</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBUFFERDESC']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBUFFERDESC::dwSize']/*"/>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBUFFERDESC::dwFlags']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBUFFERDESC::dwBufferBytes']/*"/>
<unmanaged>unsigned int dwBufferBytes</unmanaged>
<unmanaged-short>unsigned int dwBufferBytes</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBUFFERDESC::dwReserved']/*"/>
<unmanaged>unsigned int dwReserved</unmanaged>
<unmanaged-short>unsigned int dwReserved</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBUFFERDESC::lpwfxFormat']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBUFFERDESC::dwFXCount']/*"/>
<unmanaged>unsigned int dwFXCount</unmanaged>
<unmanaged-short>unsigned int dwFXCount</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBUFFERDESC::lpDSCFXDesc']/*"/>
The <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCCAPS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCCAPS::dwSize']/*"/>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCCAPS::dwFlags']/*"/>
<unmanaged>unsigned int dwFlags</unmanaged>
<unmanaged-short>unsigned int dwFlags</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCCAPS::dwFormats']/*"/>
<unmanaged>unsigned int dwFormats</unmanaged>
<unmanaged-short>unsigned int dwFormats</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCCAPS::dwChannels']/*"/>
<unmanaged>unsigned int dwChannels</unmanaged>
<unmanaged-short>unsigned int dwChannels</unmanaged-short>
The <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCEFFECTDESC']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCEFFECTDESC::dwSize']/*"/>
<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.
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCEFFECTDESC::dwFlags']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCEFFECTDESC::guidDSCFXClass']/*"/>
<dd> Value of type <seecref="T:System.Guid"/> that specifies the unique identifier of the preferred effect. The following standard identifiers are defined.
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCEFFECTDESC::guidDSCFXInstance']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCEFFECTDESC::dwReserved1']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCEFFECTDESC::dwReserved2']/*"/>
<unmanaged-short>unsigned int dwReserved2</unmanaged-short>
</member>
<membername="T:SharpDX.DirectSound.Chorus">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXChorus']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.Chorus"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXChorus::SetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXChorus::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXChorus::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXCompressor']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.Compressor"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXCompressor::SetAllParameters']/*"/>
The GetAllParameters method retrieves the compression parameters of a buffer.
</summary>
<paramname="dsFxCompressorRef"><dd> Address of a <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXCompressor::GetAllParameters']/*"/>
The GetAllParameters method retrieves the compression parameters of a buffer.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXCompressor::GetAllParameters']/*"/>
String that specifies the module name of the DirectSound driver corresponding to this device.
</summary>
</member>
<membername="T:SharpDX.DirectSound.DirectSound">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound8']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.DirectSoundBase"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
The CreateSoundBuffer method creates a sound buffer object to manage audio samples.
</summary>
<paramname="cDSBufferDescRef"><dd> Address of a <seecref="T:SharpDX.DirectSound.SoundBufferDescription"/> structure that describes the sound buffer to create. </dd></param>
<paramname="dSBufferOut"><dd> Address of a variable that receives the <seecref="T:SharpDX.DirectSound.SoundBuffer"/> interface of the new buffer object. Use QueryInterface to obtain <seecref="T:SharpDX.DirectSound.SecondarySoundBuffer"/>. <seecref="T:SharpDX.DirectSound.SecondarySoundBuffer"/> is not available for the primary buffer. </dd></param>
<paramname="unkOuterRef"><dd> Address of the controlling object's <seecref="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 <seecref="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 <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound::CreateSoundBuffer']/*"/>
The GetCaps method retrieves the capabilities of the hardware device that is represented by the device object.
</summary>
<paramname="dSCapsRef"><dd> Address of a <seecref="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 <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound::GetCaps']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound::DuplicateSoundBuffer']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound::SetCooperativeLevel']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound::Compact']/*"/>
The GetSpeakerConfig method retrieves the speaker configuration.
</summary>
<paramname="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) == <seecref="F:SharpDX.DirectSound.SpeakerConfiguration.Stereo"/>) { if (DSSPEAKER_GEOMETRY(dwSpeakerConfig) == <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound::GetSpeakerConfig']/*"/>
The<strong>SetSpeakerConfig</strong>method specifies the speaker configuration of the device.
</summary>
<paramname="speakerConfig"><dd> The speaker configuration. See the following 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 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>In Windows Vista and later versions of Windows, <strong>SetSpeakerConfig</strong> is a NOP. For Windows Vista and later versions, the speaker configuration is a system setting that should not be modified by an application. End users can set the speaker configuration through control panels.</p> Speaker Configurations <p>These tables contain the possible speaker configurations.</p><table><tr><th>Value
</td><td>The audio is played through a speaker arrangement of five surround speakers with a subwoofer. (<seecref="F:SharpDX.DirectSound.SpeakerConfiguration.FivePointOne"/> is still defined, but is obsolete as of Windows Vista. Use <seecref="F:SharpDX.DirectSound.SpeakerConfiguration.FivePointOneBack"/> instead.)
</td><td>The audio is played through a home theater speaker arrangement of five surround speakers with a subwoofer. This value applies to Windows Vista or later.
</td><td>The audio is played through a wide speaker arrangement of seven surround speakers with a subwoofer. (<seecref="F:SharpDX.DirectSound.SpeakerConfiguration.SevenPointOne"/> is still defined, but is obsolete as of Windows XP SP 2. Use <seecref="F:SharpDX.DirectSound.SpeakerConfiguration.SevenPointOneWide"/> instead.)
</td><td>The audio is played through a home theater speaker arrangement of seven surround speakers with a subwoofer. This value applies to Windows XP SP2 or later.
</td></tr></table><p><seecref="F:SharpDX.DirectSound.SpeakerConfiguration.Stereo"/> can be combined with one of the values shown in the following table.</p><table><tr><th>Value
</td><td>The speakers are directed over an arc of 180 degrees.
</td></tr></table><p>If a geometry value is to be used, it must be packed in a DWORD along with the <seecref="F:SharpDX.DirectSound.SpeakerConfiguration.Stereo"/> flag. This can be done by using the DSSPEAKER_COMBINED macro, as in the following C++ example:</p><pre> lpds->SetSpeakerConfig(DSSPEAKER_COMBINED( <seecref="F:SharpDX.DirectSound.SpeakerConfiguration.Stereo"/>, <seecref="F:SharpDX.DirectSound.SpeakerGeometry.Wide"/>)); </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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound::SetSpeakerConfig']/*"/>
<msdn-id>ee418050</msdn-id>
<unmanaged>HRESULT IDirectSound::SetSpeakerConfig([In] unsigned int dwSpeakerConfig)</unmanaged>
The GetCaps method retrieves the capabilities of the hardware device that is represented by the device object.
</summary>
<remarks>
<p>Information retrieved in the <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound::GetCaps']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.DirectSound"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
The VerifyCertification method ascertains whether the device driver is certified for DirectX.
</summary>
<paramname="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 <seecref="F:SharpDX.DirectSound.CapabilitiesFlags.EmulatedDriver"/> flag in the dwFlags member of <seecref="T:SharpDX.DirectSound.Capabilities"/>.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound8::VerifyCertification']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCapture']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.DirectSoundCapture"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
The CreateCaptureBuffer method creates a buffer for capturing waveform audio.
</summary>
<paramname="cDSCBufferDescRef"><dd> Pointer to a <seecref="T:SharpDX.DirectSound.CaptureBufferDescription"/> structure containing values for the capture buffer being created. </dd></param>
<paramname="dSCBufferOut"><dd> Address of a variable that receives an <seecref="T:SharpDX.DirectSound.CaptureBufferBase"/> interface reference. Use QueryInterface to obtain <seecref="T:SharpDX.DirectSound.CaptureBuffer"/>. See Remarks. </dd></param>
<paramname="unkOuterRef"><dd> Address of the controlling object's <seecref="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 <seecref="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, <seecref="T:SharpDX.DirectSound.CaptureBuffer"/> is supported. If IDirectSoundCapture8 was obtained from the earlier DirectSoundCaptureCreate function, only <seecref="T:SharpDX.DirectSound.CaptureBufferBase"/> is supported.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCapture::CreateCaptureBuffer']/*"/>
The GetCaps method retrieves the capabilities of the capture device.
</summary>
<paramname="dSCCapsRef"><dd> Pointer to a <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCapture::GetCaps']/*"/>
The GetCaps method retrieves the capabilities of the capture device.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCapture::GetCaps']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXDistortion']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.Distortion"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
The SetAllParameters method sets the distortion parameters of a buffer.
</summary>
<paramname="cDsFxDistortionRef"><dd> Address of a <seecref="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 <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXDistortion::SetAllParameters']/*"/>
The GetAllParameters method retrieves the distortion parameters of a buffer.
</summary>
<paramname="dsFxDistortionRef"><dd> Address of a <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXDistortion::GetAllParameters']/*"/>
The GetAllParameters method retrieves the distortion parameters of a buffer.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXDistortion::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXEcho']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.Echo"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
The SetAllParameters method sets the echo parameters of a buffer.
</summary>
<paramname="cDsFxEchoRef"><dd> Address of a <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXEcho::SetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXEcho::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXEcho::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.SoundBuffer3D"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
The GetAllParameters method retrieves the 3D properties of the sound buffer.
</summary>
<paramname="ds3dBufferRef"><dd> Address of a <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::GetAllParameters']/*"/>
The GetConeAngles method retrieves the inside and outside angles of the sound projection cone.
</summary>
<paramname="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>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::GetConeAngles']/*"/>
The GetConeOrientation method retrieves the orientation of the sound projection cone.
</summary>
<paramname="vOrientationRef"><dd> Address of a <seecref="T:SharpDX.Vector3"/> 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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::GetConeOrientation']/*"/>
The GetConeOutsideVolume method retrieves the volume of the sound outside the outside angle of the sound projection cone.
</summary>
<paramname="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 DSBVOLUME_MAX (no attenuation) and DSBVOLUME_MIN (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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::GetConeOutsideVolume']/*"/>
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>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::GetMaxDistance']/*"/>
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>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::GetMinDistance']/*"/>
The GetMode method retrieves the operation mode for 3D sound processing.
</summary>
<paramname="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><seecref="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><seecref="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><seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::GetMode']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::GetPosition']/*"/>
The GetVelocity method retrieves the velocity of the sound source.
</summary>
<paramname="vVelocityRef"><dd> Address of a <seecref="T:SharpDX.Vector3"/> 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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::GetVelocity']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::SetAllParameters']/*"/>
<unmanaged>HRESULT IDirectSound3DBuffer::SetAllParameters([In] const DS3DBUFFER* pcDs3dBuffer,[In] unsigned int dwApply)</unmanaged>
The SetConeAngles method sets the inside and outside angles of the sound projection cone.
</summary>
<paramname="insideConeAngle"><dd> Inside cone angle, in degrees. This is the angle within which the sound is at its normal volume. </dd></param>
<paramname="outsideConeAngle"><dd> Outside cone angle, in degrees. This is the angle outside of which the sound is at its outside volume. </dd></param>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::SetConeAngles']/*"/>
<msdn-id>ee417984</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::SetConeAngles([In] unsigned int dwInsideConeAngle,[In] unsigned int dwOutsideConeAngle,[In] unsigned int dwApply)</unmanaged>
The SetConeOrientation method sets the orientation of the sound projection cone.
</summary>
<paramname="x"><dd> Value that specifies the x coordinate of the sound cone orientation vector. D3DVALUE is defined as float. </dd></param>
<paramname="y"><dd> Value that specifies the y coordinate of the sound cone orientation vector. D3DVALUE is defined as float. </dd></param>
<paramname="z"><dd> Value that specifies the z coordinate of the sound cone orientation vector. D3DVALUE is defined as float. </dd></param>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::SetConeOrientation']/*"/>
The SetConeOutsideVolume method sets the volume of the sound outside the outside angle of the sound projection cone.
</summary>
<paramname="coneOutsideVolume"><dd> Cone outside volume, in hundredths of a decibel. </dd></param>
<paramname="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 DSBVOLUME_MAX (no attenuation) and DSBVOLUME_MIN (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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::SetConeOutsideVolume']/*"/>
<msdn-id>ee417987</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::SetConeOutsideVolume([In] int lConeOutsideVolume,[In] unsigned int dwApply)</unmanaged>
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>
<paramname="maxDistance"><dd> Maximum distance, in meters by default. D3DVALUE is defined as float. </dd></param>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::SetMaxDistance']/*"/>
<msdn-id>ee417989</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::SetMaxDistance([In] float flMaxDistance,[In] unsigned int dwApply)</unmanaged>
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>
<paramname="minDistance"><dd> Minimum distance, in meters by default. D3DVALUE is defined as float. </dd></param>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::SetMinDistance']/*"/>
<msdn-id>ee417991</msdn-id>
<unmanaged>HRESULT IDirectSound3DBuffer::SetMinDistance([In] float flMinDistance,[In] unsigned int dwApply)</unmanaged>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::SetMode']/*"/>
<unmanaged>HRESULT IDirectSound3DBuffer::SetMode([In] unsigned int dwMode,[In] unsigned int dwApply)</unmanaged>
The SetPosition method sets the position of the sound source.
</summary>
<paramname="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>
<paramname="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>
<paramname="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>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::SetPosition']/*"/>
The SetVelocity method sets the velocity of the sound source.
</summary>
<paramname="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>
<paramname="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>
<paramname="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>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DBuffer::SetVelocity']/*"/>
The <seecref="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 <seecref="!:SharpDX.MediaFoundation.IMediaObject"/> and <seecref="!: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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSEFFECTDESC']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSEFFECTDESC::dwSize']/*"/>
<msdn-id>ee416828</msdn-id>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
<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, <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSEFFECTDESC::dwFlags']/*"/>
<msdn-id>ee416828</msdn-id>
<unmanaged>unsigned int dwFlags</unmanaged>
<unmanaged-short>unsigned int dwFlags</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSEFFECTDESC::guidDSFXClass']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSEFFECTDESC::dwReserved1']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSEFFECTDESC::dwReserved2']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXFlanger']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.Flanger"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXFlanger::SetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXFlanger::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXFlanger::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFullDuplex']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.FullDuplex"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXGargle']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.Gargle"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXGargle::SetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXGargle::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXGargle::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFX_AEC_MODE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFX_AEC_MODE_PASS_THROUGH']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFX_AEC_MODE_HALF_DUPLEX']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFX_AEC_MODE_FULL_DUPLEX']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFX_AEC_STATUS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFX_AEC_STATUS_HISTORY_UNINITIALIZED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFX_AEC_STATUS_HISTORY_CONTINUOUSLY_CONVERGED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFX_AEC_STATUS_HISTORY_PREVIOUSLY_DIVERGED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFX_AEC_STATUS_CURRENTLY_CONVERGED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_FLAGS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_PRIMARYBUFFER']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_STATIC']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_LOCHARDWARE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_LOCSOFTWARE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_CTRL3D']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_CTRLFREQUENCY']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_CTRLPAN']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_CTRLVOLUME']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_CTRLPOSITIONNOTIFY']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_CTRLFX']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_STICKYFOCUS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_GLOBALFOCUS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_GETCURRENTPOSITION2']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_MUTE3DATMAXDISTANCE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_LOCDEFER']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS_TRUEPLAYPOSITION']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='']/*"/>
<unmanaged>None</unmanaged>
<unmanaged-short>None</unmanaged-short>
</member>
<membername="T:SharpDX.DirectSound.BufferStatus">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBSTATUS_FLAGS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBSTATUS_PLAYING']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBSTATUS_BUFFERLOST']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBSTATUS_LOOPING']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBSTATUS_LOCHARDWARE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBSTATUS_LOCSOFTWARE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBSTATUS_TERMINATED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS_FLAGS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS_PRIMARYMONO']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS_PRIMARYSTEREO']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS_PRIMARY8BIT']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS_PRIMARY16BIT']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS_CONTINUOUSRATE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS_EMULDRIVER']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS_CERTIFIED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS_SECONDARYMONO']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS_SECONDARYSTEREO']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS_SECONDARY8BIT']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCAPS_SECONDARY16BIT']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBCAPS_FLAGS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBCAPS_WAVEMAPPED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBCAPS_CTRLFX']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBSTATUS_FLAGS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBSTATUS_CAPTURING']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCBSTATUS_LOOPING']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCCAPS_FLAGS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCCAPS_EMULDRIVER']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCCAPS_CERTIFIED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCCAPS_MULTIPLECAPTURE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFX_ENUM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFX_LOCHARDWARE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFX_LOCSOFTWARE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSCL_ENUM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSCL_NORMAL']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSCL_PRIORITY']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSCL_EXCLUSIVE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSCL_WRITEPRIMARY']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSOUND_ENUM_1']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_DEFAULT']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_GENERIC']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_PADDEDCELL']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_ROOM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_BATHROOM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_LIVINGROOM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_STONEROOM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_AUDITORIUM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_CONCERTHALL']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_CAVE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_ARENA']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_HANGAR']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_CARPETEDHALLWAY']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_HALLWAY']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_STONECORRIDOR']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_ALLEY']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_FOREST']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_CITY']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_MOUNTAINS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_QUARRY']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_PLAIN']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_PARKINGLOT']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_SEWERPIPE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_UNDERWATER']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_SMALLROOM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_MEDIUMROOM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_LARGEROOM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_MEDIUMHALL']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_LARGEHALL']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_ENVIRONMENT_PRESET_PLATE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSOUND_ENUM_2']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_SINGLEWINDOW']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_DOUBLEWINDOW']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_THINDOOR']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_THICKDOOR']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_WOODWALL']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_BRICKWALL']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_STONEWALL']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFX_I3DL2_MATERIAL_PRESET_CURTAIN']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBLOCK_ENUM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBLOCK_FROMWRITECURSOR']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBLOCK_ENTIREBUFFER']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='']/*"/>
<unmanaged>None</unmanaged>
<unmanaged-short>None</unmanaged-short>
</member>
<membername="T:SharpDX.DirectSound.Mode3D">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DMODE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DMODE_NORMAL']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DMODE_HEADRELATIVE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DMODE_DISABLE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBPLAY_FLAGS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBPLAY_LOOPING']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBPLAY_LOCHARDWARE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBPLAY_LOCSOFTWARE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBPLAY_TERMINATEBY_TIME']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBPLAY_TERMINATEBY_DISTANCE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBPLAY_TERMINATEBY_PRIORITY']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSOUND_ENUM_0']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXR_PRESENT']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXR_LOCHARDWARE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXR_LOCSOFTWARE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXR_UNALLOCATED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXR_FAILED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXR_UNKNOWN']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXR_SENDLOOP']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_ENUM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_DIRECTOUT']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_HEADPHONE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_MONO']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_QUAD']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_STEREO']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_SURROUND']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_5POINT1']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_7POINT1']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_7POINT1_SURROUND']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_5POINT1_SURROUND']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_7POINT1_WIDE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_5POINT1_BACK']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_GEOMETRY_ENUM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_GEOMETRY_MIN']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_GEOMETRY_NARROW']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_GEOMETRY_WIDE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSSPEAKER_GEOMETRY_MAX']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='SharpDX.DirectSound.CaptureEffectGuid']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='SharpDX.DirectSound.DirectSound3DAlgorithmGuid']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='SharpDX.DirectSound.DSound']/*"/>
The GetDeviceID function retrieves the unique device identifier of the default playback and capture devices selected by the user in Control Panel.
</summary>
<paramname="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>
<paramname="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 <seecref="T:System.Guid"/>.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='GetDeviceID']/*"/>
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.
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DirectSoundCaptureCreate8']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DirectSoundEnumerateA']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DirectSoundEnumerateW']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DirectSoundCaptureCreate']/*"/>
<p>The <strong>DirectSoundFullDuplexCreate</strong> function is documented under a different name. For complete documentation of this function, see DirectSoundFullDuplexCreate8. </p>
<returns><p>If this function succeeds, it returns <strong><seecref="F:SharpDX.Result.Ok"/></strong>. Otherwise, it returns an <strong><seecref="T:SharpDX.Result"/></strong> error code.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DirectSoundFullDuplexCreate']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DirectSoundCreate8']/*"/>
The DirectSoundCaptureEnumerate function enumerates the DirectSoundCapture objects installed in the system.
</summary>
<paramname="dSEnumCallbackRef"><dd> Address of the DSEnumCallback function that will be called for each DirectSoundCapture object installed in the system. </dd></param>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DirectSoundCaptureEnumerateA']/*"/>
The DirectSoundCaptureEnumerate function enumerates the DirectSoundCapture objects installed in the system.
</summary>
<paramname="dSEnumCallbackRef"><dd> Address of the DSEnumCallback function that will be called for each DirectSoundCapture object installed in the system. </dd></param>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DirectSoundCaptureEnumerateW']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DirectSoundCreate']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='SharpDX.DirectSound.SoundEffectGuid']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureFXAec']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.AcousticEchoCancel"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureFXAec::SetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureFXAec::GetAllParameters']/*"/>
The IDirectSoundCaptureFXAec8::GetStatus method retrieves the status of the effect.
</summary>
<paramname="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><seecref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryUninitialized"/></td><td>0x0</td></tr><tr><td><seecref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryContinuouslyConverged"/></td><td>0x1</td></tr><tr><td><seecref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryPreviouslyDiverged"/></td><td>0x2</td></tr><tr><td><seecref="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 (<seecref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryUninitialized"/>). When the AEC algorithm has converged, the convergence history is switched to the <seecref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryContinuouslyConverged"/> state. If the AEC algorithm ever loses convergence, the convergence history is then transitioned to the <seecref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryPreviouslyDiverged"/> state. A transition from <seecref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryUninitialized"/> to <seecref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryPreviouslyDiverged"/> is also possible. The convergence history remains in the <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureFXAec::GetStatus']/*"/>
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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureFXAec::Reset']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureFXAec::GetAllParameters']/*"/>
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 (<seecref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryUninitialized"/>). When the AEC algorithm has converged, the convergence history is switched to the <seecref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryContinuouslyConverged"/> state. If the AEC algorithm ever loses convergence, the convergence history is then transitioned to the <seecref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryPreviouslyDiverged"/> state. A transition from <seecref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryUninitialized"/> to <seecref="F:SharpDX.DirectSound.AcousticEchoCancelStatus.HistoryPreviouslyDiverged"/> is also possible. The convergence history remains in the <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureFXAec::GetStatus']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.I3DL2Reverb"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::SetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::SetPreset']/*"/>
<unmanaged>HRESULT IDirectSoundFXI3DL2Reverb::SetPreset([In] unsigned int dwPreset)</unmanaged>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::GetPreset']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::SetQuality']/*"/>
<unmanaged>HRESULT IDirectSoundFXI3DL2Reverb::SetQuality([In] int lQuality)</unmanaged>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::GetQuality']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::GetPreset']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXI3DL2Reverb::GetQuality']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureFXNoiseSuppress']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.NoiseSuppress"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureFXNoiseSuppress::SetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureFXNoiseSuppress::GetAllParameters']/*"/>
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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureFXNoiseSuppress::Reset']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundCaptureFXNoiseSuppress::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXParamEq']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.ParametricEqualizer"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
The SetAllParameters method sets the parametric equalizer parameters of a buffer.
</summary>
<paramname="cDsFxParamEqRef"><dd> Address of a <seecref="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 <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXParamEq::SetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXParamEq::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXParamEq::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer8']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.SoundBuffer"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::GetCaps']/*"/>
The GetCurrentPosition method retrieves the position of the play and write cursors in the sound buffer.
</summary>
<paramname="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>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::GetCurrentPosition']/*"/>
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>
<paramname="wfxFormatRef"><dd> Address of a <seecref="T:SharpDX.Multimedia.WaveFormat"/> or <seecref="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>
<paramname="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>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::GetFormat']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::GetVolume']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::GetPan']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::GetFrequency']/*"/>
The GetStatus method retrieves the status of the sound buffer.
</summary>
<paramname="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><seecref="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><seecref="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 <seecref="F:SharpDX.DirectSound.BufferStatus.Playing"/>.</td></tr><tr><td><seecref="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><seecref="F:SharpDX.DirectSound.BufferStatus.Software"/></td><td>The buffer is playing in software. Set only for buffers created with the <seecref="F:SharpDX.DirectSound.BufferFlags.Defer"/> flag.</td></tr><tr><td><seecref="F:SharpDX.DirectSound.BufferStatus.Hardware"/></td><td>The buffer is playing in hardware. Set only for buffers created with the <seecref="F:SharpDX.DirectSound.BufferFlags.Defer"/> flag.</td></tr><tr><td><seecref="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 <seecref="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><seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::GetStatus']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::Initialize']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::Lock']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::Play']/*"/>
<unmanaged>HRESULT IDirectSoundBuffer::Play([In] unsigned int dwReserved1,[In] unsigned int dwPriority,[In] DSBPLAY_FLAGS dwFlags)</unmanaged>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::SetCurrentPosition']/*"/>
<unmanaged>HRESULT IDirectSoundBuffer::SetCurrentPosition([In] unsigned int dwNewPosition)</unmanaged>
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>
<paramname="cfxFormatRef"><dd> Address of a <seecref="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 <seecref="F:SharpDX.DirectSound.CooperativeLevel.Normal"/> cooperative level.</p><p>If the application is using DirectSound at the <seecref="F:SharpDX.DirectSound.CooperativeLevel.WritePrimary"/> cooperative level, and the format is not supported, the method fails.</p><p>If the cooperative level is <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::SetFormat']/*"/>
The SetVolume method sets the attenuation of the sound.
</summary>
<paramname="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 DSBVOLUME_MAX (no attenuation) and DSBVOLUME_MIN (silence). These values are defined in Dsound.h as 0 and ?10,000 respectively. The value DSBVOLUME_MAX represents the original, unadjusted volume of the stream. The value DSBVOLUME_MIN 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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::SetVolume']/*"/>
<msdn-id>ee418150</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::SetVolume([In] int lVolume)</unmanaged>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::SetPan']/*"/>
<unmanaged>HRESULT IDirectSoundBuffer::SetPan([In] int lPan)</unmanaged>
The SetFrequency method sets the frequency at which the audio samples are played.
</summary>
<paramname="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 <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::SetFrequency']/*"/>
<msdn-id>ee418143</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::SetFrequency([In] unsigned int dwFrequency)</unmanaged>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::Stop']/*"/>
<paramname="vAudioPtr1Ref"><dd> Address of the value retrieved in the ppvAudioPtr1 parameter of the Lock method. </dd></param>
<paramname="audioBytes1"><dd> Number of bytes written to the portion of the buffer at pvAudioPtr1. See Remarks. </dd></param>
<paramname="vAudioPtr2Ref"><dd> Address of the value retrieved in the ppvAudioPtr2 parameter of the IDirectSoundBuffer8::Lock method. </dd></param>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::Unlock']/*"/>
<msdn-id>ee418153</msdn-id>
<unmanaged>HRESULT IDirectSoundBuffer::Unlock([In, Buffer] void* pvAudioPtr1,[In] unsigned int dwAudioBytes1,[In, Buffer, Optional] void* pvAudioPtr2,[In] unsigned int dwAudioBytes2)</unmanaged>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::Restore']/*"/>
The Lock method readies all or part of the buffer for a data write and returns pointers to which data can be written.
</summary>
<paramname="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>
<paramname="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>
<paramname="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>
<paramname="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>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::GetCaps']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::GetVolume']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::GetPan']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::GetFrequency']/*"/>
The GetStatus method retrieves the status of the sound buffer.
</summary>
<remarks>
<p><seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::GetStatus']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::SetCurrentPosition']/*"/>
<!-- Failed to insert some or all of included XML --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer::SetFormat']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.SecondarySoundBuffer"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
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>
<paramname="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>
<paramname="dSFXDescRef"><dd> Address of an array of <seecref="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>
<paramname="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><seecref="F:SharpDX.DirectSound.SoundEffectResult.LocatedInHardware"/></td><td>Effect is instantiated in hardware.</td></tr><tr><td><seecref="F:SharpDX.DirectSound.SoundEffectResult.LocatedInSoftware"/></td><td>Effect is instantiated in software.</td></tr><tr><td><seecref="F:SharpDX.DirectSound.SoundEffectResult.Unallocated"/></td><td>Effect has not yet been assigned to hardware or software. This value is returned if the buffer was created with the <seecref="F:SharpDX.DirectSound.BufferFlags.Defer"/> flag in <seecref="T:SharpDX.DirectSound.SoundBufferDescription"/>.</td></tr><tr><td><seecref="F:SharpDX.DirectSound.SoundEffectResult.Failed"/></td><td>No effect was created because resources weren't available.</td></tr><tr><td><seecref="F:SharpDX.DirectSound.SoundEffectResult.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><seecref="F:SharpDX.DirectSound.SoundEffectResult.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 <seecref="!:SharpDX.MediaFoundation.IMediaObject.SetInputType"/> and <seecref="!: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 <seecref="F:SharpDX.DirectSound.SoundEffectResult.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 <seecref="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 <seecref="F:SharpDX.DirectSound.SoundEffectResult.Present"/> or <seecref="F:SharpDX.DirectSound.SoundEffectResult.Unknown"/> to ascertain which effect caused the error. If the method returns DSERR_INVALIDPARAM, check the result codes for <seecref="F:SharpDX.DirectSound.SoundEffectResult.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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer8::SetFX']/*"/>
The AcquireResources method allocates resources for a buffer that was created with the <seecref="F:SharpDX.DirectSound.BufferFlags.Defer"/> flag in theDSBUFFERDESCstructure.
<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 <seecref="F:SharpDX.DirectSound.BufferFlags.Defer"/> are not allocated resources until Play is called. <seecref="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 <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer8::AcquireResources']/*"/>
The GetObjectInPath method retrieves an interface for an effect object associated with the buffer.
</summary>
<paramname="rguidObject"><dd> Unique class identifier of the object being searched for, such as <seecref="F:SharpDX.DirectSound.SoundEffectGuid.StandardEcho"/>. Set this parameter to <seecref="F:SharpDX.DirectSound.DSound.AllObjects"/> to search for objects of any class. </dd></param>
<paramname="index"><dd> Index of the object within objects of that class in the path. See Remarks. </dd></param>
<paramname="rguidInterface"><dd> Unique identifier of the desired interface. See Remarks. </dd></param>
<paramname="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>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></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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundBuffer8::GetObjectInPath']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundNotify']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.SoundBufferNotifier"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundNotify::SetNotificationPositions']/*"/>
<unmanaged>HRESULT IDirectSoundNotify::SetNotificationPositions([In] unsigned int dwPositionNotifies,[In, Buffer] const DSBPOSITIONNOTIFY* pcPositionNotifies)</unmanaged>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.SoundListener3D"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::GetDistanceFactor']/*"/>
The GetDopplerFactor method retrieves the multiplier for the Doppler effect.
</summary>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::GetDopplerFactor']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::GetOrientation']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::GetPosition']/*"/>
The GetRolloffFactor method retrieves the rolloff factor, which determines the rate of attenuation over distance.
</summary>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::GetRolloffFactor']/*"/>
The GetVelocity method retrieves the listener's velocity.
</summary>
<paramname="vVelocityRef"><dd> Address of a <seecref="T:SharpDX.Vector3"/> 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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::GetVelocity']/*"/>
The SetAllParameters method sets all 3D parameters of the sound environment and the listener.
</summary>
<paramname="cListenerRef"><dd> Address of a <seecref="T:SharpDX.DirectSound.Listener3DSettings"/> structure that contains information describing all 3D listener parameters. </dd></param>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::SetAllParameters']/*"/>
<msdn-id>ee418020</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::SetAllParameters([In] const DS3DLISTENER* pcListener,[In] unsigned int dwApply)</unmanaged>
The SetDistanceFactor method sets the distance factor, which is the number of meters in a vector unit.
</summary>
<paramname="distanceFactor"><dd> Distance factor. D3DVALUE is defined as float. </dd></param>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::SetDistanceFactor']/*"/>
<msdn-id>ee418022</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::SetDistanceFactor([In] float flDistanceFactor,[In] unsigned int dwApply)</unmanaged>
The SetDopplerFactor method sets the multiplier for the Doppler effect.
</summary>
<paramname="dopplerFactor"><dd> Doppler factor. D3DVALUE is defined as float. </dd></param>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::SetDopplerFactor']/*"/>
<msdn-id>ee418024</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::SetDopplerFactor([In] float flDopplerFactor,[In] unsigned int dwApply)</unmanaged>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::SetOrientation']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::SetPosition']/*"/>
The SetRolloffFactor method sets the rolloff factor, which determines the rate of attenuation over distance.
</summary>
<paramname="rolloffFactor"><dd> Rolloff factor. D3DVALUE is defined as float. </dd></param>
<paramname="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::SetRolloffFactor']/*"/>
<msdn-id>ee418030</msdn-id>
<unmanaged>HRESULT IDirectSound3DListener::SetRolloffFactor([In] float flRolloffFactor,[In] unsigned int dwApply)</unmanaged>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::SetVelocity']/*"/>
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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSound3DListener::CommitDeferredSettings']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXWavesReverb']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.DirectSound.WavesReverb"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXWavesReverb::SetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXWavesReverb::GetAllParameters']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IDirectSoundFXWavesReverb::GetAllParameters']/*"/>
The <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFXAec']/*"/>
<dd> Boolean value that specifies whether the effect is enabled. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFXAec::fEnable']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFXAec::fNoiseFill']/*"/>
</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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFXAec::dwMode']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS::dwSize']/*"/>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS::dwFlags']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS::dwBufferBytes']/*"/>
<unmanaged>unsigned int dwBufferBytes</unmanaged>
<unmanaged-short>unsigned int dwBufferBytes</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS::dwUnlockTransferRate']/*"/>
<unmanaged>unsigned int dwUnlockTransferRate</unmanaged>
<unmanaged-short>unsigned int dwUnlockTransferRate</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBCAPS::dwPlayCpuOverhead']/*"/>
<unmanaged>unsigned int dwPlayCpuOverhead</unmanaged>
<unmanaged-short>unsigned int dwPlayCpuOverhead</unmanaged-short>
The <seecref="T:SharpDX.DirectSound.ChorusSettings"/> structure contains parameters for a chorus effect.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXChorus']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXChorus::fWetDryMix']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXChorus::fDepth']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXChorus::fFeedback']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXChorus::fFrequency']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXChorus::lWaveform']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXChorus::fDelay']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXChorus::lPhase']/*"/>
The <seecref="T:SharpDX.DirectSound.CompressorSettings"/> structure contains parameters for a compression effect.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXCompressor']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXCompressor::fGain']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXCompressor::fAttack']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXCompressor::fRelease']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXCompressor::fThreshold']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXCompressor::fRatio']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXCompressor::fPredelay']/*"/>
The <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXDistortion']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXDistortion::fGain']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXDistortion::fEdge']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXDistortion::fPostEQCenterFrequency']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXDistortion::fPostEQBandwidth']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXDistortion::fPreLowpassCutoff']/*"/>
The <seecref="T:SharpDX.DirectSound.EchoSettings"/> structure contains parameters for an echo effect.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXEcho']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXEcho::fWetDryMix']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXEcho::fFeedback']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXEcho::fLeftDelay']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXEcho::fRightDelay']/*"/>
<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 <seecref="F:SharpDX.Result.False"/>) and DSFXECHO_PANDELAY_MAX (equivalent to TRUE). </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXEcho::lPanDelay']/*"/>
The <seecref="T:SharpDX.DirectSound.FlangerSettings"/> structure contains parameters for a flange effect.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXFlanger']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXFlanger::fWetDryMix']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXFlanger::fDepth']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXFlanger::fFeedback']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXFlanger::fFrequency']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXFlanger::lWaveform']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXFlanger::fDelay']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXFlanger::lPhase']/*"/>
The <seecref="T:SharpDX.DirectSound.GargleSettings"/> structure contains parameters for an amplitude modulation effect.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXGargle']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXGargle::dwRateHz']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXGargle::dwWaveShape']/*"/>
The <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXI3DL2Reverb']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXI3DL2Reverb::lRoom']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXI3DL2Reverb::lRoomHF']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXI3DL2Reverb::flRoomRolloffFactor']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXI3DL2Reverb::flDecayTime']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXI3DL2Reverb::flDecayHFRatio']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXI3DL2Reverb::lReflections']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXI3DL2Reverb::flReflectionsDelay']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXI3DL2Reverb::lReverb']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXI3DL2Reverb::flReverbDelay']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXI3DL2Reverb::flDiffusion']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXI3DL2Reverb::flDensity']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXI3DL2Reverb::flHFReference']/*"/>
The <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DLISTENER']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DLISTENER::dwSize']/*"/>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DLISTENER::vPosition']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DLISTENER::vVelocity']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DLISTENER::vOrientFront']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DLISTENER::vOrientTop']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DLISTENER::flDistanceFactor']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DLISTENER::flRolloffFactor']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DS3DLISTENER::flDopplerFactor']/*"/>
The <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFXNoiseSuppress']/*"/>
<dd> Boolean value that specifies whether the effect is enabled. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSCFXNoiseSuppress::fEnable']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBPOSITIONNOTIFY']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBPOSITIONNOTIFY::dwOffset']/*"/>
<unmanaged>unsigned int dwOffset</unmanaged>
<unmanaged-short>unsigned int dwOffset</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBPOSITIONNOTIFY::hEventNotify']/*"/>
The <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXParamEq']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXParamEq::fCenter']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXParamEq::fBandwidth']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXParamEq::fGain']/*"/>
The <seecref="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 <seecref="F:SharpDX.DirectSound.BufferFlags.ControlPan"/> | <seecref="F:SharpDX.DirectSound.BufferFlags.ControlVolume"/> | <seecref="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 <seecref="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 <seecref="F:SharpDX.DirectSound.BufferFlags.Hardware"/> and <seecref="F:SharpDX.DirectSound.BufferFlags.Software"/> flags are optional and mutually exclusive. <seecref="F:SharpDX.DirectSound.BufferFlags.Hardware"/> forces the buffer to reside in hardware, meaning that it will be mixed by the sound card. <seecref="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 <seecref="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, <seecref="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 <seecref="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 <seecref="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 <seecref="F:SharpDX.DirectSound.DirectSound3DAlgorithmGuid.NoVirtualization3DAlgorithm"/> algorithm.</p></li></ol><p>If a speaker configuration other than <seecref="F:SharpDX.DirectSound.SpeakerConfiguration.Headphone"/> or <seecref="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 <seecref="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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBUFFERDESC']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBUFFERDESC::dwSize']/*"/>
<unmanaged>unsigned int dwSize</unmanaged>
<unmanaged-short>unsigned int dwSize</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBUFFERDESC::dwFlags']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBUFFERDESC::dwBufferBytes']/*"/>
<unmanaged>unsigned int dwBufferBytes</unmanaged>
<unmanaged-short>unsigned int dwBufferBytes</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBUFFERDESC::dwReserved']/*"/>
<unmanaged>unsigned int dwReserved</unmanaged>
<unmanaged-short>unsigned int dwReserved</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBUFFERDESC::lpwfxFormat']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSBUFFERDESC::guid3DAlgorithm']/*"/>
The <seecref="T:SharpDX.DirectSound.WavesReverbSettings"/> structure contains parameters for a Waves reverberation effect.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXWavesReverb']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXWavesReverb::fInGain']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXWavesReverb::fReverbMix']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXWavesReverb::fReverbTime']/*"/>
<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 --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='DSFXWavesReverb::fHighFreqRTRatio']/*"/>
