backup/anx.framework
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
anx.framework/lib/SharpDX-Win8/Bin/SharpDX.XAudio2.xml

2877 lines
258 KiB
XML
Raw Normal View History

added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<?xml version="1.0"?>
<doc>
<assembly>
<name>SharpDX.XAudio2</name>
</assembly>
<members>
<member name="T:SharpDX.XAudio2.EffectDescriptor">
<summary>
XAPO
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_EFFECT_DESCRIPTOR']/*"/>
<unmanaged>XAUDIO2_EFFECT_DESCRIPTOR</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.EffectDescriptor.#ctor(SharpDX.XAPO.AudioProcessor)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.EffectDescriptor"/> class with a Stereo Effect.
</summary>
<param name="effect">The effect.</param>
</member>
<member name="M:SharpDX.XAudio2.EffectDescriptor.#ctor(SharpDX.XAPO.AudioProcessor,System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.EffectDescriptor"/> class.
</summary>
<param name="effect">The effect.</param>
<param name="outputChannelCount">The output channel count.</param>
</member>
<member name="F:SharpDX.XAudio2.EffectDescriptor.EffectPointer">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_EFFECT_DESCRIPTOR::pEffect']/*"/>
<unmanaged>IUnknown* pEffect</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.EffectDescriptor.OutputChannelCount">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_EFFECT_DESCRIPTOR::OutputChannels']/*"/>
<unmanaged>unsigned int OutputChannels</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.EffectDescriptor.Effect">
<summary>
Gets or sets the AudioProcessor. The AudioProcessor cannot be set more than one.
</summary>
<value>The effect.</value>
</member>
<member name="P:SharpDX.XAudio2.EffectDescriptor.InitialState">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_EFFECT_DESCRIPTOR::InitialState']/*"/>
<unmanaged>BOOL InitialState</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.AudioBuffer">
<summary>
IXAudio2SourceVoice::SubmitSourceBuffer
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_BUFFER']/*"/>
<unmanaged>XAUDIO2_BUFFER</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.AudioBuffer.LoopInfinite">
<summary>Constant LoopInfinite.</summary>
<unmanaged>XAUDIO2_LOOP_INFINITE</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.AudioBuffer.Flags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_BUFFER::Flags']/*"/>
<unmanaged>XAUDIO2_BUFFER_FLAGS Flags</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.AudioBuffer.AudioBytes">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_BUFFER::AudioBytes']/*"/>
<unmanaged>unsigned int AudioBytes</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.AudioBuffer.AudioDataPointer">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_BUFFER::pAudioData']/*"/>
<unmanaged>const unsigned char* pAudioData</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.AudioBuffer.PlayBegin">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_BUFFER::PlayBegin']/*"/>
<unmanaged>unsigned int PlayBegin</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.AudioBuffer.PlayLength">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_BUFFER::PlayLength']/*"/>
<unmanaged>unsigned int PlayLength</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.AudioBuffer.LoopBegin">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_BUFFER::LoopBegin']/*"/>
<unmanaged>unsigned int LoopBegin</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.AudioBuffer.LoopLength">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_BUFFER::LoopLength']/*"/>
<unmanaged>unsigned int LoopLength</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.AudioBuffer.LoopCount">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_BUFFER::LoopCount']/*"/>
<unmanaged>unsigned int LoopCount</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.AudioBuffer.Context">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_BUFFER::pContext']/*"/>
<unmanaged>void* pContext</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.AudioBuffer.Stream">
<summary>
Gets or sets the datastream associated to this audio buffer
</summary>
<value>The stream.</value>
</member>
<member name="T:SharpDX.XAudio2.EngineCallback">
<summary>
The IXAudio2EngineCallback interface contains methods that notify the client when certain events happen in the <see cref="T:SharpDX.XAudio2.XAudio2"/> engine. This interface should be implemented by the XAudio2 client. XAudio2 calls these methods via an interface pointer provided by the client, using either the {{XAudio2Create}} or <see cref="!:SharpDX.XAudio2.XAudio2.Initialize"/> method. Methods in this interface return void, rather than an HRESULT.
</summary>
<unmanaged>IXAudio2EngineCallback</unmanaged>
<summary>
IXAudio2
</summary>
<!-- Failed to insert some or all of included XML --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2EngineCallback']/*"/>
<unmanaged>IXAudio2EngineCallback</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.EngineCallback.OnProcessingPassStart">
<summary>
Called by XAudio2 just before an audio processing pass begins.
</summary>
<unmanaged>void IXAudio2EngineCallback::OnProcessingPassStart()</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.EngineCallback.OnProcessingPassEnd">
<summary>
Called by XAudio2 just after an audio processing pass ends.
</summary>
<unmanaged>void IXAudio2EngineCallback::OnProcessingPassEnd()</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.EngineCallback.OnCriticalError(SharpDX.Result)">
<summary>
Called if a critical system error occurs that requires XAudio2 to be closed down and restarted.
</summary>
<param name="error"> Error code returned by XAudio2. </param>
<unmanaged>void IXAudio2EngineCallback::OnCriticalError([None] HRESULT Error)</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.EngineShadow">
<summary>
Internal EngineCallback Callback Impl
</summary>
</member>
<member name="M:SharpDX.XAudio2.EngineShadow.ToIntPtr(SharpDX.XAudio2.EngineCallback)">
<summary>
Return a pointer to the unamanged version of this callback.
</summary>
<param name="callback">The callback.</param>
<returns>A pointer to a shadow c++ callback</returns>
</member>
<member name="T:SharpDX.XAudio2.EngineShadow.EngineVtbl.OnProcessingPassEndDelegate">
<summary>
Called by XAudio2 just after an audio processing pass ends.
</summary>
<unmanaged>void IXAudio2EngineCallback::OnProcessingPassEnd()</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.EngineShadow.EngineVtbl.OnCriticalErrorDelegate">
<summary>
Called if a critical system error occurs that requires XAudio2 to be closed down and restarted.
</summary>
<param name="thisObject">This pointer</param>
<param name="error"> Error code returned by XAudio2. </param>
<unmanaged>void IXAudio2EngineCallback::OnCriticalError([None] HRESULT Error)</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.ErrorEventArgs">
<summary>
EventArgs used by <see cref="E:SharpDX.XAudio2.XAudio2.CriticalError"/>.
</summary>
</member>
<member name="M:SharpDX.XAudio2.ErrorEventArgs.#ctor(SharpDX.Result)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.ErrorEventArgs"/> class.
</summary>
<param name="errorCode">The error code.</param>
</member>
<member name="P:SharpDX.XAudio2.ErrorEventArgs.ErrorCode">
<summary>
Gets or sets the error code.
</summary>
<value>The error code.</value>
</member>
<member name="T:SharpDX.XAudio2.Fx.XAudio2FxContants">
<summary>
XAudio2FxContants Functions.
</summary>
</member>
<member name="F:SharpDX.XAudio2.Fx.XAudio2FxContants.CLSID_AudioReverb">
<summary>Constant None.</summary>
</member>
<member name="F:SharpDX.XAudio2.Fx.XAudio2FxContants.CLSID_AudioReverb_Debug">
<summary>Constant None.</summary>
</member>
<member name="F:SharpDX.XAudio2.Fx.XAudio2FxContants.CLSID_AudioVolumeMeter">
<summary>Constant None.</summary>
</member>
<member name="F:SharpDX.XAudio2.Fx.XAudio2FxContants.CLSID_AudioVolumeMeter_Debug">
<summary>Constant None.</summary>
</member>
<member name="T:SharpDX.XAudio2.BufferFlags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_BUFFER_FLAGS']/*"/>
<unmanaged>XAUDIO2_BUFFER_FLAGS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.BufferFlags.EndOfStream">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_END_OF_STREAM']/*"/>
<unmanaged>XAUDIO2_END_OF_STREAM</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.BufferFlags.None">
<summary>
None.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='']/*"/>
<unmanaged>None</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.FilterType">
<summary>
<code>
typedef enum <see cref="T:SharpDX.XAudio2.FilterType"/>
{ LowPassFilter, BandPassFilter, HighPassFilter, NotchFilter
} <see cref="T:SharpDX.XAudio2.FilterType"/>;
</code>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_FILTER_TYPE']/*"/>
<unmanaged>XAUDIO2_FILTER_TYPE</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.FilterType.LowPassFilter">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='LowPassFilter']/*"/>
<unmanaged>LowPassFilter</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.FilterType.BandPassFilter">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='BandPassFilter']/*"/>
<unmanaged>BandPassFilter</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.FilterType.HighPassFilter">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='HighPassFilter']/*"/>
<unmanaged>HighPassFilter</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.FilterType.NotchFilter">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='NotchFilter']/*"/>
<unmanaged>NotchFilter</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.LogType">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_LOG_TYPE']/*"/>
<unmanaged>XAUDIO2_LOG_TYPE</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.LogType.Errors">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_LOG_ERRORS']/*"/>
<unmanaged>XAUDIO2_LOG_ERRORS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.LogType.Warnings">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_LOG_WARNINGS']/*"/>
<unmanaged>XAUDIO2_LOG_WARNINGS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.LogType.Information">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_LOG_INFO']/*"/>
<unmanaged>XAUDIO2_LOG_INFO</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.LogType.Detail">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_LOG_DETAIL']/*"/>
<unmanaged>XAUDIO2_LOG_DETAIL</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.LogType.ApiCalls">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_LOG_API_CALLS']/*"/>
<unmanaged>XAUDIO2_LOG_API_CALLS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.LogType.FunctionCalls">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_LOG_FUNC_CALLS']/*"/>
<unmanaged>XAUDIO2_LOG_FUNC_CALLS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.LogType.Timing">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_LOG_TIMING']/*"/>
<unmanaged>XAUDIO2_LOG_TIMING</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.LogType.Locks">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_LOG_LOCKS']/*"/>
<unmanaged>XAUDIO2_LOG_LOCKS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.LogType.Memory">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_LOG_MEMORY']/*"/>
<unmanaged>XAUDIO2_LOG_MEMORY</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.LogType.Streaming">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_LOG_STREAMING']/*"/>
<unmanaged>XAUDIO2_LOG_STREAMING</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.PlayFlags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PLAY_FLAGS']/*"/>
<unmanaged>XAUDIO2_PLAY_FLAGS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PlayFlags.Tails">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PLAY_TAILS']/*"/>
<unmanaged>XAUDIO2_PLAY_TAILS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PlayFlags.None">
<summary>
None.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='']/*"/>
<unmanaged>None</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.ProcessorSpecifier">
<summary>
<code>
typedef enum <see cref="T:SharpDX.XAudio2.ProcessorSpecifier"/>
{ Processor1 = 0x00000001, Processor2 = 0x00000002, Processor3 = 0x00000004, Processor4 = 0x00000008, Processor5 = 0x00000010, Processor6 = 0x00000020, Processor7 = 0x00000040, Processor8 = 0x00000080, Processor9 = 0x00000100, Processor10 = 0x00000200, Processor11 = 0x00000400, Processor12 = 0x00000800, Processor13 = 0x00001000, Processor14 = 0x00002000, Processor15 = 0x00004000, Processor16 = 0x00008000, Processor17 = 0x00010000, Processor18 = 0x00020000, Processor19 = 0x00040000, Processor20 = 0x00080000, Processor21 = 0x00100000, Processor22 = 0x00200000, Processor23 = 0x00400000, Processor24 = 0x00800000, Processor25 = 0x01000000, Processor26 = 0x02000000, Processor27 = 0x04000000, Processor28 = 0x08000000, Processor29 = 0x10000000, Processor30 = 0x20000000, Processor31 = 0x40000000, Processor32 = 0x80000000, <see cref="F:SharpDX.XAudio2.ProcessorSpecifier.AnyProcessor"/> = 0xffffffff, <see cref="F:SharpDX.XAudio2.ProcessorSpecifier.DefaultProcessor"/> = <see cref="F:SharpDX.XAudio2.ProcessorSpecifier.AnyProcessor"/>
} <see cref="T:SharpDX.XAudio2.ProcessorSpecifier"/>, XAUDIO2_PROCESSOR;
</code>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_WINDOWS_PROCESSOR_SPECIFIER']/*"/>
<unmanaged>XAUDIO2_WINDOWS_PROCESSOR_SPECIFIER</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor1">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor1']/*"/>
<unmanaged>Processor1</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor2">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor2']/*"/>
<unmanaged>Processor2</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor3">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor3']/*"/>
<unmanaged>Processor3</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor4">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor4']/*"/>
<unmanaged>Processor4</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor5">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor5']/*"/>
<unmanaged>Processor5</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor6">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor6']/*"/>
<unmanaged>Processor6</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor7">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor7']/*"/>
<unmanaged>Processor7</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor8">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor8']/*"/>
<unmanaged>Processor8</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor9">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor9']/*"/>
<unmanaged>Processor9</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor10">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor10']/*"/>
<unmanaged>Processor10</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor11">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor11']/*"/>
<unmanaged>Processor11</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor12">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor12']/*"/>
<unmanaged>Processor12</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor13">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor13']/*"/>
<unmanaged>Processor13</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor14">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor14']/*"/>
<unmanaged>Processor14</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor15">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor15']/*"/>
<unmanaged>Processor15</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor16">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor16']/*"/>
<unmanaged>Processor16</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor17">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor17']/*"/>
<unmanaged>Processor17</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor18">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor18']/*"/>
<unmanaged>Processor18</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor19">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor19']/*"/>
<unmanaged>Processor19</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor20">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor20']/*"/>
<unmanaged>Processor20</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor21">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor21']/*"/>
<unmanaged>Processor21</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor22">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor22']/*"/>
<unmanaged>Processor22</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor23">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor23']/*"/>
<unmanaged>Processor23</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor24">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor24']/*"/>
<unmanaged>Processor24</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor25">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor25']/*"/>
<unmanaged>Processor25</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor26">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor26']/*"/>
<unmanaged>Processor26</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor27">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor27']/*"/>
<unmanaged>Processor27</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor28">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor28']/*"/>
<unmanaged>Processor28</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor29">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor29']/*"/>
<unmanaged>Processor29</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor30">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor30']/*"/>
<unmanaged>Processor30</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor31">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor31']/*"/>
<unmanaged>Processor31</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.Processor32">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='Processor32']/*"/>
<unmanaged>Processor32</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.AnyProcessor">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_ANY_PROCESSOR']/*"/>
<unmanaged>XAUDIO2_ANY_PROCESSOR</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.ProcessorSpecifier.DefaultProcessor">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_DEFAULT_PROCESSOR']/*"/>
<unmanaged>XAUDIO2_DEFAULT_PROCESSOR</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.VoiceFlags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_FLAGS']/*"/>
<unmanaged>XAUDIO2_VOICE_FLAGS</unmanaged>
</member>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<member name="F:SharpDX.XAudio2.VoiceFlags.NoPitch">
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_NOPITCH']/*"/>
<unmanaged>XAUDIO2_VOICE_NOPITCH</unmanaged>
</member>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<member name="F:SharpDX.XAudio2.VoiceFlags.NoSampleRateConversion">
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_NOSRC']/*"/>
<unmanaged>XAUDIO2_VOICE_NOSRC</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.VoiceFlags.Music">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_MUSIC']/*"/>
<unmanaged>XAUDIO2_VOICE_MUSIC</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.VoiceFlags.Nosamplesplayed">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_NOSAMPLESPLAYED']/*"/>
<unmanaged>XAUDIO2_VOICE_NOSAMPLESPLAYED</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.VoiceFlags.None">
<summary>
None.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='']/*"/>
<unmanaged>None</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.VoiceSendFlags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_SEND_FLAGS']/*"/>
<unmanaged>XAUDIO2_VOICE_SEND_FLAGS</unmanaged>
</member>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<member name="F:SharpDX.XAudio2.VoiceSendFlags.UseFilter">
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_USEFILTER']/*"/>
<unmanaged>XAUDIO2_VOICE_USEFILTER</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.VoiceSendFlags.None">
<summary>
None.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='']/*"/>
<unmanaged>None</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.XAudio2Flags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_FLAGS']/*"/>
<unmanaged>XAUDIO2_FLAGS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2Flags.None">
<summary>
None.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='']/*"/>
<unmanaged>None</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.XAudio2Functions">
<summary>
Functions
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.XAudio2.XAudio2Functions']/*"/>
</member>
<member name="M:SharpDX.XAudio2.XAudio2Functions.XAudio2Create(SharpDX.XAudio2.XAudio2,System.Int32,System.Int32)">
<summary>
IXAudio2
</summary>
<param name="xAudio2Out">No documentation.</param>
<param name="flags">No documentation.</param>
<param name="xAudio2Processor">No documentation.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAudio2Create']/*"/>
<unmanaged>HRESULT XAudio2Create([Out, Fast] IXAudio2** ppXAudio2,[In] unsigned int Flags,[In] unsigned int XAudio2Processor)</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.Fx.ReverbI3DL2Parameters">
<summary>
ReverbConvertI3DL2ToNative
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_I3DL2_PARAMETERS']/*"/>
<unmanaged>XAUDIO2FX_REVERB_I3DL2_PARAMETERS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbI3DL2Parameters.WetDryMix">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_I3DL2_PARAMETERS::WetDryMix']/*"/>
<unmanaged>float WetDryMix</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbI3DL2Parameters.Room">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_I3DL2_PARAMETERS::Room']/*"/>
<unmanaged>int Room</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbI3DL2Parameters.RoomHF">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_I3DL2_PARAMETERS::RoomHF']/*"/>
<unmanaged>int RoomHF</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbI3DL2Parameters.RoomRolloffFactor">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_I3DL2_PARAMETERS::RoomRolloffFactor']/*"/>
<unmanaged>float RoomRolloffFactor</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbI3DL2Parameters.DecayTime">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_I3DL2_PARAMETERS::DecayTime']/*"/>
<unmanaged>float DecayTime</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbI3DL2Parameters.DecayHFRatio">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_I3DL2_PARAMETERS::DecayHFRatio']/*"/>
<unmanaged>float DecayHFRatio</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbI3DL2Parameters.Reflections">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_I3DL2_PARAMETERS::Reflections']/*"/>
<unmanaged>int Reflections</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbI3DL2Parameters.ReflectionsDelay">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_I3DL2_PARAMETERS::ReflectionsDelay']/*"/>
<unmanaged>float ReflectionsDelay</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbI3DL2Parameters.Reverb">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_I3DL2_PARAMETERS::Reverb']/*"/>
<unmanaged>int Reverb</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbI3DL2Parameters.ReverbDelay">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_I3DL2_PARAMETERS::ReverbDelay']/*"/>
<unmanaged>float ReverbDelay</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbI3DL2Parameters.Diffusion">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_I3DL2_PARAMETERS::Diffusion']/*"/>
<unmanaged>float Diffusion</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbI3DL2Parameters.Density">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_I3DL2_PARAMETERS::Density']/*"/>
<unmanaged>float Density</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbI3DL2Parameters.HFReference">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_I3DL2_PARAMETERS::HFReference']/*"/>
<unmanaged>float HFReference</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.Fx.ReverbParameters">
<summary>
<code>
typedef struct <see cref="T:SharpDX.XAudio2.Fx.ReverbParameters"/> { float WetDryMix; UINT32 ReflectionsDelay; BYTE ReverbDelay; BYTE RearDelay; BYTE PositionLeft; BYTE PositionRight; BYTE PositionMatrixLeft; BYTE PositionMatrixRight; BYTE EarlyDiffusion; BYTE LateDiffusion; BYTE LowEQGain; BYTE LowEQCutoff; BYTE HighEQGain; BYTE HighEQCutoff; float RoomFilterFreq; float RoomFilterMain; float RoomFilterHF; float ReflectionsGain; float ReverbGain; float DecayTime; float Density; float RoomSize; <see cref="T:System.Boolean"/> DisableLateField;
} <see cref="T:SharpDX.XAudio2.Fx.ReverbParameters"/>;
</code>
Members<list>
<item><term>WetDryMix</term><description> Percentage of the output that will be reverb. Allowable values are from 0 to 100. </description></item>
<item><term>ReflectionsDelay</term><description> The delay time of the first reflection relative to the direct path. Permitted range is from 0 to 300 milliseconds. Note All parameters related to sampling rate or time are relative to a 48kHz sampling rate and must be scaled for use with other sampling rates. See remarks section below for additional information. </description></item>
<item><term>ReverbDelay</term><description> Delay of reverb relative to the first reflection. Permitted range is from 0 to 85 milliseconds. Note All parameters related to sampling rate or time are relative to a 48kHz sampling rate and must be scaled for use with other sampling rates. See remarks section below for additional information. </description></item>
<item><term>RearDelay</term><description> Delay for the left rear output and right rear output. Permitted range is from 0 to 5 milliseconds. Note All parameters related to sampling rate or time are relative to a 48kHz sampling rate and must be scaled for use with other sampling rates. See remarks section below for additional information. </description></item>
<item><term>PositionLeft</term><description> Position of the left input within the simulated space relative to the listener. With PositionLeft set to the minimum value, the left input is placed close to the listener. In this position, early reflections are dominant, and the reverb decay is set back in the sound field and reduced in amplitude. With PositionLeft set to the maximum value, the left input is placed at a maximum distance from the listener within the simulated room. PositionLeft does not affect the reverb decay time (liveness of the room), only the apparent position of the source relative to the listener. Permitted range is from 0 to 30 (no units). </description></item>
<item><term>PositionRight</term><description> Same as PositionLeft, but affecting only the right input. Permitted range is from 0 to 30 (no units). Note PositionRight is ignored in mono-in/mono-out mode. </description></item>
<item><term>PositionMatrixLeft</term><description> Gives a greater or lesser impression of distance from the source to the listener. Permitted range is from 0 to 30 (no units). </description></item>
<item><term>PositionMatrixRight</term><description> Gives a greater or lesser impression of distance from the source to the listener. Permitted range is from 0 to 30 (no units). Note PositionMatrixRight is ignored in mono-in/mono-out mode. </description></item>
<item><term>EarlyDiffusion</term><description> Controls the character of the individual wall reflections. Set to minimum value to simulate a hard flat surface and to maximum value to simulate a diffuse surface. Permitted range is from 0 to 15 (no units). </description></item>
<item><term>LateDiffusion</term><description> Controls the character of the individual wall reverberations. Set to minimum value to simulate a hard flat surface and to maximum value to simulate a diffuse surface. Permitted range is from 0 to 15 (no units). </description></item>
<item><term>LowEQGain</term><description> Adjusts the decay time of low frequencies relative to the decay time at 1 kHz. The values correspond to dB of gain as follows: Value0123456789101112 Gain (dB)-8-7-6-5-4-3-2-10+1+2+3+4 <para>Note that a LowEQGain value of 8 results in the decay time of low frequencies being equal to the decay time at 1 kHz. Permitted range is from 0 to 12 (no units).</para>
</description></item>
<item><term>LowEQCutoff</term><description> Sets the corner frequency of the low pass filter that is controlled by the LowEQGain parameter. The values correspond to frequency in Hz as follows: Value0123456789 Frequency (Hz)50100150200250300350400450500 <para>Permitted range is from 0 to 9 (no units).</para>
</description></item>
<item><term>HighEQGain</term><description> Adjusts the decay time of high frequencies relative to the decay time at 1 kHz. When set to zero, high frequencies decay at the same rate as 1 kHz. When set to maximum value, high frequencies decay at a much faster rate than 1 kHz. Value012345678 Gain (dB)-8-7-6-5-4-3-2-10 <para>Permitted range is from 0 to 8 (no units).</para>
</description></item>
<item><term>HighEQCutoff</term><description> Sets the corner frequency of the high pass filter that is controlled by the HighEQGain parameter. The values correspond to frequency in kHz as follows: Value01234567891011121314 Frequency (kHz)11.522.533.544.555.566.577.58 <para>Permitted range is from 0 to 14 (no units).</para>
</description></item>
<item><term>RoomFilterFreq</term><description> Sets the corner frequency of the low pass filter for the room effect. Permitted range is from 20 to 20,000 Hz. Note All parameters related to sampling rate or time are relative to a 48kHz sampling rate and must be scaled for use with other sampling rates. See remarks section below for additional information. </description></item>
<item><term>RoomFilterMain</term><description> Sets the pass band intensity level of the low-pass filter for both the early reflections and the late field reverberation. Permitted range is from -100 to 0 dB. </description></item>
<item><term>RoomFilterHF</term><description> Sets the intensity of the low-pass filter for both the early reflections and the late field reverberation at the corner frequency (RoomFilterFreq). Permitted range is from -100 to 0 dB. </description></item>
<item><term>ReflectionsGain</term><description> Adjusts the intensity of the early reflections. Permitted range is from -100 to 20 dB. </description></item>
<item><term>ReverbGain</term><description> Adjusts the intensity of the reverberations. Permitted range is from -100 to 20 dB. </description></item>
<item><term>DecayTime</term><description> Reverberation decay time at 1 kHz. This is the time that a full scale input signal decays by 60 dB. Permitted range is from 0.1 to infinity seconds. </description></item>
<item><term>Density</term><description> Controls the modal density in the late field reverberation. For colorless spaces, Density should be set to the maximum value (100). As Density is decreased, the sound becomes hollow (comb filtered). This is an effect that can be useful if you are trying to model a silo. Permitted range as a percentage is from 0 to 100. </description></item>
<item><term>RoomSize</term><description> The apparent size of the acoustic space. Permitted range is from 1 to 100 feet. </description></item>
<item><term>DisableLateField</term><description> If set to TRUE, disables late field reflection calculations. Disabling late field reflection calculations results in a significant CPU time savings. </description></item>
</list>
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS']/*"/>
<unmanaged>XAUDIO2FX_REVERB_PARAMETERS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.WetDryMix">
<summary>
Percentage of the output that will be reverb. Allowable values are from 0 to 100.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::WetDryMix']/*"/>
<unmanaged>float WetDryMix</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.ReflectionsDelay">
<summary>
The delay time of the first reflection relative to the direct path. Permitted range is from 0 to 300 milliseconds. Note All parameters related to sampling rate or time are relative to a 48kHz sampling rate and must be scaled for use with other sampling rates. See remarks section below for additional information.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::ReflectionsDelay']/*"/>
<unmanaged>unsigned int ReflectionsDelay</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.ReverbDelay">
<summary>
Delay of reverb relative to the first reflection. Permitted range is from 0 to 85 milliseconds. Note All parameters related to sampling rate or time are relative to a 48kHz sampling rate and must be scaled for use with other sampling rates. See remarks section below for additional information.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::ReverbDelay']/*"/>
<unmanaged>unsigned char ReverbDelay</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.RearDelay">
<summary>
Delay for the left rear output and right rear output. Permitted range is from 0 to 5 milliseconds. Note All parameters related to sampling rate or time are relative to a 48kHz sampling rate and must be scaled for use with other sampling rates. See remarks section below for additional information.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::RearDelay']/*"/>
<unmanaged>unsigned char RearDelay</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.PositionLeft">
<summary>
Position of the left input within the simulated space relative to the listener. With PositionLeft set to the minimum value, the left input is placed close to the listener. In this position, early reflections are dominant, and the reverb decay is set back in the sound field and reduced in amplitude. With PositionLeft set to the maximum value, the left input is placed at a maximum distance from the listener within the simulated room. PositionLeft does not affect the reverb decay time (liveness of the room), only the apparent position of the source relative to the listener. Permitted range is from 0 to 30 (no units).
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::PositionLeft']/*"/>
<unmanaged>unsigned char PositionLeft</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.PositionRight">
<summary>
Same as PositionLeft, but affecting only the right input. Permitted range is from 0 to 30 (no units). Note PositionRight is ignored in mono-in/mono-out mode.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::PositionRight']/*"/>
<unmanaged>unsigned char PositionRight</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.PositionMatrixLeft">
<summary>
Gives a greater or lesser impression of distance from the source to the listener. Permitted range is from 0 to 30 (no units).
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::PositionMatrixLeft']/*"/>
<unmanaged>unsigned char PositionMatrixLeft</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.PositionMatrixRight">
<summary>
Gives a greater or lesser impression of distance from the source to the listener. Permitted range is from 0 to 30 (no units). Note PositionMatrixRight is ignored in mono-in/mono-out mode.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::PositionMatrixRight']/*"/>
<unmanaged>unsigned char PositionMatrixRight</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.EarlyDiffusion">
<summary>
Controls the character of the individual wall reflections. Set to minimum value to simulate a hard flat surface and to maximum value to simulate a diffuse surface. Permitted range is from 0 to 15 (no units).
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::EarlyDiffusion']/*"/>
<unmanaged>unsigned char EarlyDiffusion</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.LateDiffusion">
<summary>
Controls the character of the individual wall reverberations. Set to minimum value to simulate a hard flat surface and to maximum value to simulate a diffuse surface. Permitted range is from 0 to 15 (no units).
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::LateDiffusion']/*"/>
<unmanaged>unsigned char LateDiffusion</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.LowEQGain">
<summary>
Adjusts the decay time of low frequencies relative to the decay time at 1 kHz. The values correspond to dB of gain as follows: Value0123456789101112 Gain (dB)-8-7-6-5-4-3-2-10+1+2+3+4 <para>Note that a LowEQGain value of 8 results in the decay time of low frequencies being equal to the decay time at 1 kHz. Permitted range is from 0 to 12 (no units).</para>
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::LowEQGain']/*"/>
<unmanaged>unsigned char LowEQGain</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.LowEQCutoff">
<summary>
Sets the corner frequency of the low pass filter that is controlled by the LowEQGain parameter. The values correspond to frequency in Hz as follows: Value0123456789 Frequency (Hz)50100150200250300350400450500 <para>Permitted range is from 0 to 9 (no units).</para>
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::LowEQCutoff']/*"/>
<unmanaged>unsigned char LowEQCutoff</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.HighEQGain">
<summary>
Adjusts the decay time of high frequencies relative to the decay time at 1 kHz. When set to zero, high frequencies decay at the same rate as 1 kHz. When set to maximum value, high frequencies decay at a much faster rate than 1 kHz. Value012345678 Gain (dB)-8-7-6-5-4-3-2-10 <para>Permitted range is from 0 to 8 (no units).</para>
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::HighEQGain']/*"/>
<unmanaged>unsigned char HighEQGain</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.HighEQCutoff">
<summary>
Sets the corner frequency of the high pass filter that is controlled by the HighEQGain parameter. The values correspond to frequency in kHz as follows: Value01234567891011121314 Frequency (kHz)11.522.533.544.555.566.577.58 <para>Permitted range is from 0 to 14 (no units).</para>
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::HighEQCutoff']/*"/>
<unmanaged>unsigned char HighEQCutoff</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.RoomFilterFreq">
<summary>
Sets the corner frequency of the low pass filter for the room effect. Permitted range is from 20 to 20,000 Hz. Note All parameters related to sampling rate or time are relative to a 48kHz sampling rate and must be scaled for use with other sampling rates. See remarks section below for additional information.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::RoomFilterFreq']/*"/>
<unmanaged>float RoomFilterFreq</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.RoomFilterMain">
<summary>
Sets the pass band intensity level of the low-pass filter for both the early reflections and the late field reverberation. Permitted range is from -100 to 0 dB.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::RoomFilterMain']/*"/>
<unmanaged>float RoomFilterMain</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.RoomFilterHF">
<summary>
Sets the intensity of the low-pass filter for both the early reflections and the late field reverberation at the corner frequency (RoomFilterFreq). Permitted range is from -100 to 0 dB.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::RoomFilterHF']/*"/>
<unmanaged>float RoomFilterHF</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.ReflectionsGain">
<summary>
Adjusts the intensity of the early reflections. Permitted range is from -100 to 20 dB.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::ReflectionsGain']/*"/>
<unmanaged>float ReflectionsGain</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.ReverbGain">
<summary>
Adjusts the intensity of the reverberations. Permitted range is from -100 to 20 dB.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::ReverbGain']/*"/>
<unmanaged>float ReverbGain</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.DecayTime">
<summary>
Reverberation decay time at 1 kHz. This is the time that a full scale input signal decays by 60 dB. Permitted range is from 0.1 to infinity seconds.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::DecayTime']/*"/>
<unmanaged>float DecayTime</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.Density">
<summary>
Controls the modal density in the late field reverberation. For colorless spaces, Density should be set to the maximum value (100). As Density is decreased, the sound becomes hollow (comb filtered). This is an effect that can be useful if you are trying to model a silo. Permitted range as a percentage is from 0 to 100.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::Density']/*"/>
<unmanaged>float Density</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.ReverbParameters.RoomSize">
<summary>
The apparent size of the acoustic space. Permitted range is from 1 to 100 feet.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::RoomSize']/*"/>
<unmanaged>float RoomSize</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.Fx.ReverbParameters.DisableLateField">
<summary>
If set to TRUE, disables late field reflection calculations. Disabling late field reflection calculations results in a significant CPU time savings.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_REVERB_PARAMETERS::DisableLateField']/*"/>
<unmanaged>BOOL DisableLateField</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.Fx.VolumemeterLevels">
<summary>
<code>
typedef struct <see cref="T:SharpDX.XAudio2.Fx.VolumemeterLevels"/> { float *pPeakLevels; float *pRMSLevels; UINT32 ChannelCount;
} <see cref="T:SharpDX.XAudio2.Fx.VolumemeterLevels"/>;
</code>
Members<list>
<item><term>pPeakLevels</term><description> Array that will be filled with the maximum absolute level for each channel during a processing pass. The array must be at least ChannelCount ? sizeof(float) bytes. pPeakLevels may be <c>null</c> if pRMSLevels is not <c>null</c>. </description></item>
<item><term>pRMSLevels</term><description> Array that will be filled with root mean square level for each channel during a processing pass. The array must be at least ChannelCount ? sizeof(float) bytes. pRMSLevels may be <c>null</c> if pPeakLevels is not <c>null</c>. </description></item>
<item><term>ChannelCount</term><description> Number of channels being processed. </description></item>
</list>
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_VOLUMEMETER_LEVELS']/*"/>
<unmanaged>XAUDIO2FX_VOLUMEMETER_LEVELS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.VolumemeterLevels.PeakLevelPointer">
<summary>
Array that will be filled with the maximum absolute level for each channel during a processing pass. The array must be at least ChannelCount ? sizeof(float) bytes. pPeakLevels may be <c>null</c> if pRMSLevels is not <c>null</c>.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_VOLUMEMETER_LEVELS::pPeakLevels']/*"/>
<unmanaged>float* pPeakLevels</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.VolumemeterLevels.RmsLevelsPointer">
<summary>
Array that will be filled with root mean square level for each channel during a processing pass. The array must be at least ChannelCount ? sizeof(float) bytes. pRMSLevels may be <c>null</c> if pPeakLevels is not <c>null</c>.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_VOLUMEMETER_LEVELS::pRMSLevels']/*"/>
<unmanaged>float* pRMSLevels</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.Fx.VolumemeterLevels.ChannelCount">
<summary>
Number of channels being processed.
</summary>
<!-- No matching elements were found for the following include tag --><include file="..\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2FX_VOLUMEMETER_LEVELS::ChannelCount']/*"/>
<unmanaged>unsigned int ChannelCount</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.MasteringVoice">
<summary>
IXAudio2MasteringVoice inherits directly from <see cref="T:SharpDX.XAudio2.Voice"/>, but does not implement methods specific to mastering voices. The interface type exists solely because some of the base class methods are implemented differently for mastering voices. Having a separate type for these voices helps client code to distinguish the different voice types and to benefit from C++ type safety.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2MasteringVoice']/*"/>
<unmanaged>IXAudio2MasteringVoice</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.Voice">
<summary>
<code>
<see cref="T:SharpDX.Result"/> SetOutputMatrix( <see cref="T:SharpDX.XAudio2.Voice"/> *
</code>
Parameters<list>
<item><term>pDestinationVoice</term><description>[in] Pointer to a destination <see cref="T:SharpDX.XAudio2.Voice"/> for which to set volume levels. Note If the voice sends to a single target voice then specifying <c>null</c> will cause SetOutputMatrix to operate on that target voice. </description></item>
<item><term>SourceChannels</term><description>[in] Confirms the output channel count of the voice. This is the number of channels that are produced by the last effect in the chain. </description></item>
<item><term>DestinationChannels</term><description>[in] Confirms the input channel count of the destination voice. </description></item>
<item><term>pLevelMatrix</term><description>[in] Array of [SourceChannels ? DestinationChannels] volume levels sent to the destination voice. The level sent from source channel S to destination channel D is specified in the form pLevelMatrix[SourceChannels ? D + S]. <para>For example, when rendering two-channel stereo input into 5.1 output that is weighted toward the front channels?but is absent from the center and low-frequency channels?the matrix might have the values shown in the following table.</para>
OutputLeft Input [Array Index]Right Input [Array Index] Left1.0 [0]0.0 [1] Right0.0 [2]1.0 [3] Front Center0.0 [4]0.0 [5] LFE0.0 [6]0.0 [7] Rear Left0.8 [8]0.0 [9] Rear Right0.0 [10]0.8 [11] <para>Note that the left and right input are fully mapped to the output left and right channels; 80 percent of the left and right input is mapped to the rear left and right channels.</para>
<para>See Remarks for more information on volume levels.</para>
</description></item>
<item><term>OperationSet</term><description>[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information. </description></item>
</list>
Return Value <para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.</para>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice']/*"/>
<unmanaged>IXAudio2Voice</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.Voice"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.XAudio2.Voice.GetVoiceDetails(SharpDX.XAudio2.VoiceDetails@)">
<summary>
<code>
void GetVoiceDetails( <see cref="T:SharpDX.XAudio2.VoiceDetails"/> *
</code>
Parameters<list>
<item><term>pVoiceDetails</term><description>[in, out] <see cref="T:SharpDX.XAudio2.VoiceDetails"/> structure containing information about the voice. </description></item>
</list>
Return ValueNone.
</summary>
<param name="voiceDetailsRef">[in, out] <see cref="T:SharpDX.XAudio2.VoiceDetails"/> structure containing information about the voice.</param>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::GetVoiceDetails']/*"/>
<unmanaged>void IXAudio2Voice::GetVoiceDetails([Out] XAUDIO2_VOICE_DETAILS* pVoiceDetails)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetOutputVoices(System.Nullable{SharpDX.XAudio2.VoiceSendDescriptors})">
<summary>
<code>
<see cref="T:SharpDX.Result"/> SetOutputVoices( const <see cref="T:SharpDX.XAudio2.VoiceSendDescriptors"/> *
</code>
Parameters<list>
<item><term>pSendList</term><description>[in] Array of <see cref="T:SharpDX.XAudio2.VoiceSendDescriptors"/> structure references to destination voices. If pSendList is <c>null</c>, the voice will send its output to the current mastering voice. To set the voice to not send its output anywhere set the OutputCount member of <see cref="T:SharpDX.XAudio2.VoiceSendDescriptors"/> to 0. All of the voices in a send list must have the same input sample rate, see XAudio2 Sample Rate Conversions for additional information. </description></item>
</list>
Return Value <para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.</para>
</summary>
<param name="sendListRef">[in] Array of <see cref="T:SharpDX.XAudio2.VoiceSendDescriptors"/> structure references to destination voices. If pSendList is <c>null</c>, the voice will send its output to the current mastering voice. To set the voice to not send its output anywhere set the OutputCount member of <see cref="T:SharpDX.XAudio2.VoiceSendDescriptors"/> to 0. All of the voices in a send list must have the same input sample rate, see XAudio2 Sample Rate Conversions for additional information.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::SetOutputVoices']/*"/>
<unmanaged>HRESULT IXAudio2Voice::SetOutputVoices([In, Optional] const XAUDIO2_VOICE_SENDS* pSendList)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetEffectChain(System.Nullable{SharpDX.XAudio2.EffectChain})">
<summary>
<code>
<see cref="T:SharpDX.Result"/> SetEffectChain( const <see cref="T:SharpDX.XAudio2.EffectChain"/> *
</code>
Parameters<list>
<item><term>pEffectChain</term><description>[in, optional] Pointer to an <see cref="T:SharpDX.XAudio2.EffectChain"/> structure that describes the new effect chain to use. If <c>null</c> is passed, the current effect chain is removed. Note If pEffectChain is non-<c>null</c>, the <see cref="T:SharpDX.XAudio2.EffectChain"/> structure that it points to must specify at least one effect. </description></item>
</list>
Return Value <para> Returns <see cref="F:SharpDX.Result.Ok"/> if successful; otherwise, an error code. </para>
<para> See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.</para>
</summary>
<param name="effectChainRef">[in, optional] Pointer to an <see cref="T:SharpDX.XAudio2.EffectChain"/> structure that describes the new effect chain to use. If <c>null</c> is passed, the current effect chain is removed. Note If pEffectChain is non-<c>null</c>, the <see cref="T:SharpDX.XAudio2.EffectChain"/> structure that it points to must specify at least one effect.</param>
<returns><para> Returns <see cref="F:SharpDX.Result.Ok"/> if successful; otherwise, an error code. </para> <para> See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::SetEffectChain']/*"/>
<unmanaged>HRESULT IXAudio2Voice::SetEffectChain([In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.EnableEffect(System.Int32,System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> EnableEffect( UINT32
</code>
Parameters<list>
<item><term>EffectIndex</term><description>[in] Zero-based index of an effect in the effect chain of the voice. </description></item>
<item><term>OperationSet</term><description>[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information. </description></item>
</list>
Return Value <para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful; otherwise, an error code. See XAudio2 Error Codes for descriptions of error codes.</para>
</summary>
<param name="effectIndex">[in] Zero-based index of an effect in the effect chain of the voice.</param>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful; otherwise, an error code. See XAudio2 Error Codes for descriptions of error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::EnableEffect']/*"/>
<unmanaged>HRESULT IXAudio2Voice::EnableEffect([In] unsigned int EffectIndex,[In] unsigned int OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.DisableEffect(System.Int32,System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> DisableEffect( UINT32
</code>
Parameters<list>
<item><term>EffectIndex</term><description>[in] Zero-based index of an effect in the effect chain of the voice. </description></item>
<item><term>OperationSet</term><description>[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information. </description></item>
</list>
Return Value <para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful; otherwise, an error code. See XAudio2 Error Codes for descriptions of valid error codes.</para>
</summary>
<param name="effectIndex">[in] Zero-based index of an effect in the effect chain of the voice.</param>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful; otherwise, an error code. See XAudio2 Error Codes for descriptions of valid error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::DisableEffect']/*"/>
<unmanaged>HRESULT IXAudio2Voice::DisableEffect([In] unsigned int EffectIndex,[In] unsigned int OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.IsEffectEnabled(System.Int32)">
<summary>
<code>
void GetEffectState( UINT32
</code>
Parameters<list>
<item><term>EffectIndex</term><description>[in] Zero-based index of an effect in the effect chain of the voice. </description></item>
<item><term>pEnabled</term><description>[out] Returns TRUE If the effect is enabled. If the effect is disabled, returns <see cref="F:SharpDX.Result.False"/>. </description></item>
</list>
Return ValueNone.
</summary>
<param name="effectIndex">[in] Zero-based index of an effect in the effect chain of the voice.</param>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::GetEffectState']/*"/>
<unmanaged>void IXAudio2Voice::GetEffectState([In] unsigned int EffectIndex,[Out] BOOL* pEnabled)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetEffectParameters(System.Int32,System.IntPtr,System.Int32,System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> SetEffectParameters( UINT32
</code>
Parameters<list>
<item><term>EffectIndex</term><description>[in] Zero-based index of an effect within the voice's effect chain. </description></item>
<item><term>pParameters</term><description>[in] Returns the current values of the effect-specific parameters. </description></item>
<item><term>ParametersByteSize</term><description>[in] Size of the pParameters array in bytes. </description></item>
<item><term>OperationSet</term><description>[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information. </description></item>
</list>
Return Value <para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful; otherwise, an error code. See XAudio2 Error Codes for descriptions of error codes.</para>
<para>Fails with E_NOTIMPL if the effect does not support a generic parameter control interface.</para>
</summary>
<param name="effectIndex">[in] Zero-based index of an effect within the voice's effect chain.</param>
<param name="parametersRef">[in] Returns the current values of the effect-specific parameters.</param>
<param name="parametersByteSize">[in] Size of the pParameters array in bytes.</param>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful; otherwise, an error code. See XAudio2 Error Codes for descriptions of error codes.</para> <para>Fails with E_NOTIMPL if the effect does not support a generic parameter control interface.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::SetEffectParameters']/*"/>
<unmanaged>HRESULT IXAudio2Voice::SetEffectParameters([In] unsigned int EffectIndex,[In, Buffer] const void* pParameters,[In] unsigned int ParametersByteSize,[In] unsigned int OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.GetEffectParameters(System.Int32,System.IntPtr,System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> GetEffectParameters( UINT32
</code>
Parameters<list>
<item><term>EffectIndex</term><description>[in] Zero-based index of an effect within the voice's effect chain. </description></item>
<item><term>pParameters</term><description>[out] Returns the current values of the effect-specific parameters. </description></item>
<item><term>ParametersByteSize</term><description>[out] Size, in bytes, of the pParameters array. </description></item>
</list>
Return Value <para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.</para>
<para>Fails with E_NOTIMPL if the effect does not support a generic parameter control interface.</para>
</summary>
<param name="effectIndex">[in] Zero-based index of an effect within the voice's effect chain.</param>
<param name="parametersRef">[out] Returns the current values of the effect-specific parameters.</param>
<param name="parametersByteSize">[out] Size, in bytes, of the pParameters array.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.</para> <para>Fails with E_NOTIMPL if the effect does not support a generic parameter control interface.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::GetEffectParameters']/*"/>
<unmanaged>HRESULT IXAudio2Voice::GetEffectParameters([In] unsigned int EffectIndex,[Out, Buffer] void* pParameters,[In] unsigned int ParametersByteSize)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetFilterParameters(SharpDX.XAudio2.FilterParameters,System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> SetFilterParameters( const <see cref="T:SharpDX.XAudio2.FilterParameters"/> *
</code>
Parameters<list>
<item><term>pParameters</term><description>[in] Pointer to an <see cref="T:SharpDX.XAudio2.FilterParameters"/> structure containing the filter information. </description></item>
<item><term>OperationSet</term><description>[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information. </description></item>
</list>
Return Value <para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes. </para>
</summary>
<param name="parametersRef">[in] Pointer to an <see cref="T:SharpDX.XAudio2.FilterParameters"/> structure containing the filter information.</param>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes. </para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::SetFilterParameters']/*"/>
<unmanaged>HRESULT IXAudio2Voice::SetFilterParameters([In] const XAUDIO2_FILTER_PARAMETERS* pParameters,[In] unsigned int OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.GetFilterParameters(SharpDX.XAudio2.FilterParameters@)">
<summary>
<code>
void GetFilterParameters( <see cref="T:SharpDX.XAudio2.FilterParameters"/> *
</code>
Parameters<list>
<item><term>pParameters</term><description>[out] Pointer to an <see cref="T:SharpDX.XAudio2.FilterParameters"/> structure containing the filter information. </description></item>
</list>
Return ValueNone.
</summary>
<param name="parametersRef">[out] Pointer to an <see cref="T:SharpDX.XAudio2.FilterParameters"/> structure containing the filter information.</param>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::GetFilterParameters']/*"/>
<unmanaged>void IXAudio2Voice::GetFilterParameters([Out] XAUDIO2_FILTER_PARAMETERS* pParameters)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetOutputFilterParameters(SharpDX.XAudio2.Voice,SharpDX.XAudio2.FilterParameters,System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> SetOutputFilterParameters( <see cref="T:SharpDX.XAudio2.Voice"/> *
</code>
Parameters<list>
<item><term>pDestinationVoice</term><description>[in] <see cref="T:SharpDX.XAudio2.Voice"/> reference to the destination voice of the send whose filter parameters will be set. </description></item>
<item><term>pParameters</term><description>[in] Pointer to an <see cref="T:SharpDX.XAudio2.FilterParameters"/> structure containing the filter information. </description></item>
<item><term>OperationSet</term><description>[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information. </description></item>
</list>
Return Value <para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.</para>
</summary>
<param name="destinationVoiceRef">[in] <see cref="T:SharpDX.XAudio2.Voice"/> reference to the destination voice of the send whose filter parameters will be set.</param>
<param name="parametersRef">[in] Pointer to an <see cref="T:SharpDX.XAudio2.FilterParameters"/> structure containing the filter information.</param>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::SetOutputFilterParameters']/*"/>
<unmanaged>HRESULT IXAudio2Voice::SetOutputFilterParameters([In, Optional] IXAudio2Voice* pDestinationVoice,[In] const XAUDIO2_FILTER_PARAMETERS* pParameters,[In] unsigned int OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.GetOutputFilterParameters(SharpDX.XAudio2.Voice,SharpDX.XAudio2.FilterParameters@)">
<summary>
<code>
void GetOutputFilterParameters( <see cref="T:SharpDX.XAudio2.Voice"/> *
</code>
Parameters<list>
<item><term>pDestinationVoice</term><description>[in] <see cref="T:SharpDX.XAudio2.Voice"/> reference to the destination voice of the send whose filter parameters will be read. </description></item>
<item><term>pParameters</term><description>[out] Pointer to an <see cref="T:SharpDX.XAudio2.FilterParameters"/> structure containing the filter information. </description></item>
</list>
Return ValueNone.
</summary>
<param name="destinationVoiceRef">[in] <see cref="T:SharpDX.XAudio2.Voice"/> reference to the destination voice of the send whose filter parameters will be read.</param>
<param name="parametersRef">[out] Pointer to an <see cref="T:SharpDX.XAudio2.FilterParameters"/> structure containing the filter information.</param>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::GetOutputFilterParameters']/*"/>
<unmanaged>void IXAudio2Voice::GetOutputFilterParameters([In, Optional] IXAudio2Voice* pDestinationVoice,[Out] XAUDIO2_FILTER_PARAMETERS* pParameters)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetVolume(System.Single,System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> SetVolume( float
</code>
Parameters<list>
<item><term>Volume</term><description>[in] Overall volume level to use. See Remarks for more information on volume levels. </description></item>
<item><term>OperationSet</term><description>[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information. </description></item>
</list>
Return Value <para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.</para>
</summary>
<param name="volume">[in] Overall volume level to use. See Remarks for more information on volume levels.</param>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::SetVolume']/*"/>
<unmanaged>HRESULT IXAudio2Voice::SetVolume([In] float Volume,[In] unsigned int OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.GetVolume(System.Single@)">
<summary>
<code>
void GetVolume( float *
</code>
Parameters<list>
<item><term>pVolume</term><description>[out] Returns the current overall volume level of the voice. See Remarks for more information on volume levels. </description></item>
</list>
Return ValueNone.
</summary>
<param name="volumeRef">[out] Returns the current overall volume level of the voice. See Remarks for more information on volume levels.</param>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::GetVolume']/*"/>
<unmanaged>void IXAudio2Voice::GetVolume([Out] float* pVolume)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetChannelVolumes(System.Int32,System.Single[],System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> SetChannelVolumes( UINT32
</code>
Parameters<list>
<item><term>Channels</term><description>[in] Number of channels in the voice. </description></item>
<item><term>pVolumes</term><description>[in] Array containing the new volumes of each channel in the voice. The array must have Channels elements. See Remarks for more information on volume levels. </description></item>
<item><term>OperationSet</term><description>[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information. </description></item>
</list>
Return Value<para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes. </para>
</summary>
<param name="channels">[in] Number of channels in the voice.</param>
<param name="volumesRef">[in] Array containing the new volumes of each channel in the voice. The array must have Channels elements. See Remarks for more information on volume levels.</param>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes. </para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::SetChannelVolumes']/*"/>
<unmanaged>HRESULT IXAudio2Voice::SetChannelVolumes([In] unsigned int Channels,[In, Buffer] const float* pVolumes,[In] unsigned int OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.GetChannelVolumes(System.Int32,System.Single[])">
<summary>
<code>
void GetChannelVolumes( UINT32
</code>
Parameters<list>
<item><term>Channels</term><description>[in] Confirms the channel count of the voice. </description></item>
<item><term>pVolumes</term><description>[out] Returns the current volume level of each channel in the voice. The array must have at least Channels elements. See Remarks for more information on volume levels. </description></item>
</list>
Return ValueNone.
</summary>
<param name="channels">[in] Confirms the channel count of the voice.</param>
<param name="volumesRef">[out] Returns the current volume level of each channel in the voice. The array must have at least Channels elements. See Remarks for more information on volume levels.</param>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::GetChannelVolumes']/*"/>
<unmanaged>void IXAudio2Voice::GetChannelVolumes([In] unsigned int Channels,[Out, Buffer] float* pVolumes)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetOutputMatrix(SharpDX.XAudio2.Voice,System.Int32,System.Int32,System.Single[],System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> SetOutputMatrix( <see cref="T:SharpDX.XAudio2.Voice"/> *
</code>
Parameters<list>
<item><term>pDestinationVoice</term><description>[in] Pointer to a destination <see cref="T:SharpDX.XAudio2.Voice"/> for which to set volume levels. Note If the voice sends to a single target voice then specifying <c>null</c> will cause SetOutputMatrix to operate on that target voice. </description></item>
<item><term>SourceChannels</term><description>[in] Confirms the output channel count of the voice. This is the number of channels that are produced by the last effect in the chain. </description></item>
<item><term>DestinationChannels</term><description>[in] Confirms the input channel count of the destination voice. </description></item>
<item><term>pLevelMatrix</term><description>[in] Array of [SourceChannels ? DestinationChannels] volume levels sent to the destination voice. The level sent from source channel S to destination channel D is specified in the form pLevelMatrix[SourceChannels ? D + S]. <para>For example, when rendering two-channel stereo input into 5.1 output that is weighted toward the front channels?but is absent from the center and low-frequency channels?the matrix might have the values shown in the following table.</para>
OutputLeft Input [Array Index]Right Input [Array Index] Left1.0 [0]0.0 [1] Right0.0 [2]1.0 [3] Front Center0.0 [4]0.0 [5] LFE0.0 [6]0.0 [7] Rear Left0.8 [8]0.0 [9] Rear Right0.0 [10]0.8 [11] <para>Note that the left and right input are fully mapped to the output left and right channels; 80 percent of the left and right input is mapped to the rear left and right channels.</para>
<para>See Remarks for more information on volume levels.</para>
</description></item>
<item><term>OperationSet</term><description>[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information. </description></item>
</list>
Return Value <para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.</para>
</summary>
<param name="destinationVoiceRef">[in] Pointer to a destination <see cref="T:SharpDX.XAudio2.Voice"/> for which to set volume levels. Note If the voice sends to a single target voice then specifying <c>null</c> will cause SetOutputMatrix to operate on that target voice.</param>
<param name="sourceChannels">[in] Confirms the output channel count of the voice. This is the number of channels that are produced by the last effect in the chain.</param>
<param name="destinationChannels">[in] Confirms the input channel count of the destination voice.</param>
<param name="levelMatrixRef">[in] Array of [SourceChannels ? DestinationChannels] volume levels sent to the destination voice. The level sent from source channel S to destination channel D is specified in the form pLevelMatrix[SourceChannels ? D + S]. <para>For example, when rendering two-channel stereo input into 5.1 output that is weighted toward the front channels?but is absent from the center and low-frequency channels?the matrix might have the values shown in the following table.</para> OutputLeft Input [Array Index]Right Input [Array Index] Left1.0 [0]0.0 [1] Right0.0 [2]1.0 [3] Front Center0.0 [4]0.0 [5] LFE0.0 [6]0.0 [7] Rear Left0.8 [8]0.0 [9] Rear Right0.0 [10]0.8 [11] <para>Note that the left and right input are fully mapped to the output left and right channels; 80 percent of the left and right input is mapped to the rear left and right channels.</para> <para>See Remarks for more information on volume levels.</para></param>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::SetOutputMatrix']/*"/>
<unmanaged>HRESULT IXAudio2Voice::SetOutputMatrix([In, Optional] IXAudio2Voice* pDestinationVoice,[In] unsigned int SourceChannels,[In] unsigned int DestinationChannels,[In, Buffer] const float* pLevelMatrix,[In] unsigned int OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.GetOutputMatrix(SharpDX.XAudio2.Voice,System.Int32,System.Int32,System.Single[])">
<summary>
<code>
void GetOutputMatrix( <see cref="T:SharpDX.XAudio2.Voice"/> *
</code>
Parameters<list>
<item><term>pDestinationVoice</term><description>[in] Pointer specifying the destination <see cref="T:SharpDX.XAudio2.Voice"/> to retrieve the output matrix for. Note If the voice sends to a single target voice then specifying <c>null</c> will cause GetOutputMatrix to operate on that target voice. </description></item>
<item><term>SourceChannels</term><description>[in] Confirms the output channel count of the voice. This is the number of channels that are produced by the last effect in the chain. </description></item>
<item><term>DestinationChannels</term><description>[in] Confirms the input channel count of the destination voice. </description></item>
<item><term>pLevelMatrix</term><description>[out] Array of [SourceChannels * DestinationChannels] volume levels sent to the destination voice. The level sent from source channel S to destination channel D is returned in the form pLevelMatrix[DestinationChannels ? S + D]. See Remarks for more information on volume levels. </description></item>
</list>
Return ValueNone.
</summary>
<param name="destinationVoiceRef">[in] Pointer specifying the destination <see cref="T:SharpDX.XAudio2.Voice"/> to retrieve the output matrix for. Note If the voice sends to a single target voice then specifying <c>null</c> will cause GetOutputMatrix to operate on that target voice.</param>
<param name="sourceChannels">[in] Confirms the output channel count of the voice. This is the number of channels that are produced by the last effect in the chain.</param>
<param name="destinationChannels">[in] Confirms the input channel count of the destination voice.</param>
<param name="levelMatrixRef">[out] Array of [SourceChannels * DestinationChannels] volume levels sent to the destination voice. The level sent from source channel S to destination channel D is returned in the form pLevelMatrix[DestinationChannels ? S + D]. See Remarks for more information on volume levels.</param>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::GetOutputMatrix']/*"/>
<unmanaged>void IXAudio2Voice::GetOutputMatrix([In, Optional] IXAudio2Voice* pDestinationVoice,[In] unsigned int SourceChannels,[In] unsigned int DestinationChannels,[Out, Buffer] float* pLevelMatrix)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.DestroyVoice">
<summary>
<code>
void DestroyVoice()
</code>
Return ValueNone.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::DestroyVoice']/*"/>
<unmanaged>void IXAudio2Voice::DestroyVoice()</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.EnableEffect(System.Int32)">
<summary>
Enables the effect at a given position in the effect chain of the voice.
</summary>
<param name="effectIndex">[in] Zero-based index of an effect in the effect chain of the voice. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2Voice::EnableEffect([None] UINT32 EffectIndex,[None] UINT32 OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.DisableEffect(System.Int32)">
<summary>
Disables the effect at a given position in the effect chain of the voice.
</summary>
<param name="effectIndex">[in] Zero-based index of an effect in the effect chain of the voice. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2Voice::DisableEffect([None] UINT32 EffectIndex,[None] UINT32 OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.GetEffectParameters``1(System.Int32)">
<summary>
Sets parameters for a given effect in the voice's effect chain.
</summary>
<param name="effectIndex">[in] Zero-based index of an effect within the voice's effect chain. </param>
<returns>Returns the current values of the effect-specific parameters.</returns>
<unmanaged>HRESULT IXAudio2Voice::SetEffectParameters([None] UINT32 EffectIndex,[In, Buffer] const void* pParameters,[None] UINT32 ParametersByteSize,[None] UINT32 OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.GetEffectParameters(System.Int32,System.Byte[])">
<summary>
Returns the current effect-specific parameters of a given effect in the voice's effect chain.
</summary>
<param name="effectIndex">[in] Zero-based index of an effect within the voice's effect chain. </param>
<param name="effectParameters">[out] Returns the current values of the effect-specific parameters. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2Voice::GetEffectParameters([None] UINT32 EffectIndex,[Out, Buffer] void* pParameters,[None] UINT32 ParametersByteSize)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetEffectParameters(System.Int32,System.Byte[])">
<summary>
Sets parameters for a given effect in the voice's effect chain.
</summary>
<param name="effectIndex">[in] Zero-based index of an effect within the voice's effect chain. </param>
<param name="effectParameter">[in] Returns the current values of the effect-specific parameters. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2Voice::SetEffectParameters([None] UINT32 EffectIndex,[In, Buffer] const void* pParameters,[None] UINT32 ParametersByteSize,[None] UINT32 OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetEffectParameters(System.Int32,System.Byte[],System.Int32)">
<summary>
Sets parameters for a given effect in the voice's effect chain.
</summary>
<param name="effectIndex">[in] Zero-based index of an effect within the voice's effect chain. </param>
<param name="effectParameter">[in] Returns the current values of the effect-specific parameters. </param>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the {{XAudio2 Operation Sets}} overview for more information. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2Voice::SetEffectParameters([None] UINT32 EffectIndex,[In, Buffer] const void* pParameters,[None] UINT32 ParametersByteSize,[None] UINT32 OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetEffectParameters``1(System.Int32,``0)">
<summary>
Sets parameters for a given effect in the voice's effect chain.
</summary>
<param name="effectIndex">[in] Zero-based index of an effect within the voice's effect chain. </param>
<param name="effectParameter">[in] Returns the current values of the effect-specific parameters. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2Voice::SetEffectParameters([None] UINT32 EffectIndex,[In, Buffer] const void* pParameters,[None] UINT32 ParametersByteSize,[None] UINT32 OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetEffectParameters``1(System.Int32,``0,System.Int32)">
<summary>
Sets parameters for a given effect in the voice's effect chain.
</summary>
<param name="effectIndex">[in] Zero-based index of an effect within the voice's effect chain. </param>
<param name="effectParameter">[in] Returns the current values of the effect-specific parameters. </param>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the {{XAudio2 Operation Sets}} overview for more information. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2Voice::SetEffectParameters([None] UINT32 EffectIndex,[In, Buffer] const void* pParameters,[None] UINT32 ParametersByteSize,[None] UINT32 OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetEffectChain(SharpDX.XAudio2.EffectDescriptor[])">
<summary>
Replaces the effect chain of the voice.
</summary>
<param name="effectDescriptors">[in, optional] an array of <see cref="T:SharpDX.XAudio2.EffectDescriptor"/> structure that describes the new effect chain to use. If NULL is passed, the current effect chain is removed. If array is non null, its length must be at least of 1. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2Voice::SetEffectChain([In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetOutputVoices(SharpDX.XAudio2.VoiceSendDescriptor[])">
<summary>
Designates a new set of submix or mastering voices to receive the output of the voice.
</summary>
<param name="outputVoices">[in] Array of <see cref="T:SharpDX.XAudio2.VoiceSendDescriptor"/> structure pointers to destination voices. If outputVoices is NULL, the voice will send its output to the current mastering voice. To set the voice to not send its output anywhere set an array of lenvth 0. All of the voices in a send list must have the same input sample rate, see {{XAudio2 Sample Rate Conversions}} for additional information. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2Voice::SetOutputVoices([In, Optional] const XAUDIO2_VOICE_SENDS* pSendList)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetOutputMatrix(System.Int32,System.Int32,System.Single[])">
<summary>
Sets the volume level of each channel of the final output for the voice. These channels are mapped to the input channels of a specified destination voice.
</summary>
<param name="sourceChannels">[in] Confirms the output channel count of the voice. This is the number of channels that are produced by the last effect in the chain. </param>
<param name="destinationChannels">[in] Confirms the input channel count of the destination voice. </param>
<param name="levelMatrixRef">[in] Array of [SourceChannels ? DestinationChannels] volume levels sent to the destination voice. The level sent from source channel S to destination channel D is specified in the form pLevelMatrix[SourceChannels ? D + S]. For example, when rendering two-channel stereo input into 5.1 output that is weighted toward the front channels?but is absent from the center and low-frequency channels?the matrix might have the values shown in the following table. OutputLeft InputRight Input Left1.00.0 Right0.01.0 Front Center0.00.0 LFE0.00.0 Rear Left0.80.0 Rear Right0.00.8 Note that the left and right input are fully mapped to the output left and right channels; 80 percent of the left and right input is mapped to the rear left and right channels. See Remarks for more information on volume levels. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2Voice::SetOutputMatrix([In, Optional] IXAudio2Voice* pDestinationVoice,[None] UINT32 SourceChannels,[None] UINT32 DestinationChannels,[In, Buffer] const float* pLevelMatrix,[None] UINT32 OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetOutputMatrix(SharpDX.XAudio2.Voice,System.Int32,System.Int32,System.Single[])">
<summary>
Sets the volume level of each channel of the final output for the voice. These channels are mapped to the input channels of a specified destination voice.
</summary>
<param name="destinationVoiceRef">[in] Pointer to a destination <see cref="T:SharpDX.XAudio2.Voice"/> for which to set volume levels. Note If the voice sends to a single target voice then specifying NULL will cause SetOutputMatrix to operate on that target voice. </param>
<param name="sourceChannels">[in] Confirms the output channel count of the voice. This is the number of channels that are produced by the last effect in the chain. </param>
<param name="destinationChannels">[in] Confirms the input channel count of the destination voice. </param>
<param name="levelMatrixRef">[in] Array of [SourceChannels ? DestinationChannels] volume levels sent to the destination voice. The level sent from source channel S to destination channel D is specified in the form pLevelMatrix[SourceChannels ? D + S]. For example, when rendering two-channel stereo input into 5.1 output that is weighted toward the front channels?but is absent from the center and low-frequency channels?the matrix might have the values shown in the following table. OutputLeft InputRight Input Left1.00.0 Right0.01.0 Front Center0.00.0 LFE0.00.0 Rear Left0.80.0 Rear Right0.00.8 Note that the left and right input are fully mapped to the output left and right channels; 80 percent of the left and right input is mapped to the rear left and right channels. See Remarks for more information on volume levels. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2Voice::SetOutputMatrix([In, Optional] IXAudio2Voice* pDestinationVoice,[None] UINT32 SourceChannels,[None] UINT32 DestinationChannels,[In, Buffer] const float* pLevelMatrix,[None] UINT32 OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.Voice.SetOutputMatrix(System.Int32,System.Int32,System.Single[],System.Int32)">
<summary>
Sets the volume level of each channel of the final output for the voice. These channels are mapped to the input channels of a specified destination voice.
</summary>
<param name="sourceChannels">[in] Confirms the output channel count of the voice. This is the number of channels that are produced by the last effect in the chain. </param>
<param name="destinationChannels">[in] Confirms the input channel count of the destination voice. </param>
<param name="levelMatrixRef">[in] Array of [SourceChannels ? DestinationChannels] volume levels sent to the destination voice. The level sent from source channel S to destination channel D is specified in the form pLevelMatrix[SourceChannels ? D + S]. For example, when rendering two-channel stereo input into 5.1 output that is weighted toward the front channels?but is absent from the center and low-frequency channels?the matrix might have the values shown in the following table. OutputLeft InputRight Input Left1.00.0 Right0.01.0 Front Center0.00.0 LFE0.00.0 Rear Left0.80.0 Rear Right0.00.8 Note that the left and right input are fully mapped to the output left and right channels; 80 percent of the left and right input is mapped to the rear left and right channels. See Remarks for more information on volume levels. </param>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the {{XAudio2 Operation Sets}} overview for more information. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2Voice::SetOutputMatrix([In, Optional] IXAudio2Voice* pDestinationVoice,[None] UINT32 SourceChannels,[None] UINT32 DestinationChannels,[In, Buffer] const float* pLevelMatrix,[None] UINT32 OperationSet)</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.Voice.VoiceDetails">
<summary>
<code>
void GetVoiceDetails( <see cref="T:SharpDX.XAudio2.VoiceDetails"/> *
</code>
Parameters<list>
<item><term>pVoiceDetails</term><description>[in, out] <see cref="T:SharpDX.XAudio2.VoiceDetails"/> structure containing information about the voice. </description></item>
</list>
Return ValueNone.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::GetVoiceDetails']/*"/>
<unmanaged>GetVoiceDetails</unmanaged>
<unmanaged>void IXAudio2Voice::GetVoiceDetails([Out] XAUDIO2_VOICE_DETAILS* pVoiceDetails)</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.Voice.OutputVoices">
<summary>
<code>
<see cref="T:SharpDX.Result"/> SetOutputVoices( const <see cref="T:SharpDX.XAudio2.VoiceSendDescriptors"/> *
</code>
Parameters<list>
<item><term>pSendList</term><description>[in] Array of <see cref="T:SharpDX.XAudio2.VoiceSendDescriptors"/> structure references to destination voices. If pSendList is <c>null</c>, the voice will send its output to the current mastering voice. To set the voice to not send its output anywhere set the OutputCount member of <see cref="T:SharpDX.XAudio2.VoiceSendDescriptors"/> to 0. All of the voices in a send list must have the same input sample rate, see XAudio2 Sample Rate Conversions for additional information. </description></item>
</list>
Return Value <para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.</para>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::SetOutputVoices']/*"/>
<unmanaged>SetOutputVoices</unmanaged>
<unmanaged>HRESULT IXAudio2Voice::SetOutputVoices([In, Optional] const XAUDIO2_VOICE_SENDS* pSendList)</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.Voice.FilterParameters">
<summary>
<code>
void GetFilterParameters( <see cref="T:SharpDX.XAudio2.FilterParameters"/> *
</code>
Parameters<list>
<item><term>pParameters</term><description>[out] Pointer to an <see cref="T:SharpDX.XAudio2.FilterParameters"/> structure containing the filter information. </description></item>
</list>
Return ValueNone.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::GetFilterParameters']/*"/>
<unmanaged>GetFilterParameters</unmanaged>
<unmanaged>void IXAudio2Voice::GetFilterParameters([Out] XAUDIO2_FILTER_PARAMETERS* pParameters)</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.Voice.Volume">
<summary>
<code>
void GetVolume( float *
</code>
Parameters<list>
<item><term>pVolume</term><description>[out] Returns the current overall volume level of the voice. See Remarks for more information on volume levels. </description></item>
</list>
Return ValueNone.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2Voice::GetVolume']/*"/>
<unmanaged>GetVolume</unmanaged>
<unmanaged>void IXAudio2Voice::GetVolume([Out] float* pVolume)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.MasteringVoice.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.MasteringVoice"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.XAudio2.MasteringVoice.GetChannelMask(System.Int32@)">
<summary>
No documentation.
</summary>
<param name="channelmaskRef">No documentation.</param>
<returns>No documentation.</returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2MasteringVoice::GetChannelMask']/*"/>
<unmanaged>HRESULT IXAudio2MasteringVoice::GetChannelMask([Out] unsigned int* pChannelmask)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.MasteringVoice.#ctor(SharpDX.XAudio2.XAudio2,System.Int32,System.Int32,System.String)">
<summary>
Creates and configures a mastering voice.
</summary>
<param name="device">an instance of <see cref="T:SharpDX.XAudio2.XAudio2"/></param>
<param name="inputChannels">[in] Number of channels the mastering voice expects in its input audio. InputChannels must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. InputChannels can be set to XAUDIO2_DEFAULT_CHANNELS, with the default being determined by the current platform. Windows Attempts to detect the system speaker configuration setup. Xbox 360 Defaults to 5.1 surround. </param>
<param name="inputSampleRate">[in] Sample rate of the input audio data of the mastering voice. This rate must be a multiple of XAUDIO2_QUANTUM_DENOMINATOR. InputSampleRate must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. InputSampleRate can be set to XAUDIO2_DEFAULT_SAMPLERATE, with the default being determined by the current platform. Windows Windows XP defaults to 44100. Windows Vista and Windows 7 default to the setting specified in the Sound Control Panel. The default for this setting is 44100 (or 48000 if required by the driver). Xbox 360 Defaults to 48000. </param>
<param name="deviceIndex">[in] Index of the output device that will be sent input by the mastering voice. Specifying the default value of 0 causes XAudio2 to select the global default audio device. </param>
<unmanaged>HRESULT IXAudio2::CreateMasteringVoice([Out] IXAudio2MasteringVoice** ppMasteringVoice,[None] UINT32 InputChannels,[None] UINT32 InputSampleRate,[None] UINT32 Flags,[None] UINT32 DeviceIndex,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.MasteringVoice.ChannelMask">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2MasteringVoice::GetChannelMask']/*"/>
<unmanaged>GetChannelMask</unmanaged>
<unmanaged>HRESULT IXAudio2MasteringVoice::GetChannelMask([Out] unsigned int* pChannelmask)</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.SourceVoice">
<summary>
IXAudio2SourceVoice inherits directly from <see cref="T:SharpDX.XAudio2.Voice"/>. It implements its own methods.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SourceVoice']/*"/>
<unmanaged>IXAudio2SourceVoice</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.SourceVoice"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.Start(System.Int32,System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> Start( UINT32
</code>
Parameters<list>
<item><term>Flags</term><description>[in] Flags that control how the voice is started. Must be 0. </description></item>
<item><term>OperationSet</term><description>[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information. </description></item>
</list>
Return Value<para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes. </para>
</summary>
<param name="flags">[in] Flags that control how the voice is started. Must be 0.</param>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes. </para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SourceVoice::Start']/*"/>
<unmanaged>HRESULT IXAudio2SourceVoice::Start([In] unsigned int Flags,[In] unsigned int OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.Stop(SharpDX.XAudio2.PlayFlags,System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> Stop( UINT32
</code>
Parameters<list>
<item><term>Flags</term><description>[in] Flags that control how the voice is stopped. Can be 0 or the following: ValueDescriptionXAUDIO2_PLAY_TAILSContinue emitting effect output after the voice is stopped.? </description></item>
<item><term>OperationSet</term><description>[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information. </description></item>
</list>
Return Value<para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes. </para>
</summary>
<param name="flags">[in] Flags that control how the voice is stopped. Can be 0 or the following: ValueDescriptionXAUDIO2_PLAY_TAILSContinue emitting effect output after the voice is stopped.?</param>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes. </para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SourceVoice::Stop']/*"/>
<unmanaged>HRESULT IXAudio2SourceVoice::Stop([In] XAUDIO2_PLAY_FLAGS Flags,[In] unsigned int OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.SubmitSourceBuffer(SharpDX.XAudio2.AudioBuffer,System.IntPtr)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> SubmitSourceBuffer( const <see cref="T:SharpDX.XAudio2.AudioBuffer"/> *
</code>
Parameters<list>
<item><term>pBuffer</term><description>[in] Pointer to an <see cref="T:SharpDX.XAudio2.AudioBuffer"/> structure to queue. </description></item>
<item><term>pBufferWMA</term><description>[in] Pointer to an additional <see cref="T:SharpDX.XAudio2.BufferWma"/> structure used when submitting WMA data. </description></item>
</list>
Return Value<para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes. </para>
</summary>
<param name="bufferRef">[in] Pointer to an <see cref="T:SharpDX.XAudio2.AudioBuffer"/> structure to queue.</param>
<param name="bufferWMARef">[in] Pointer to an additional <see cref="T:SharpDX.XAudio2.BufferWma"/> structure used when submitting WMA data.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes. </para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SourceVoice::SubmitSourceBuffer']/*"/>
<unmanaged>HRESULT IXAudio2SourceVoice::SubmitSourceBuffer([In] const XAUDIO2_BUFFER* pBuffer,[In] const void* pBufferWMA)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.FlushSourceBuffers">
<summary>
<code>
<see cref="T:SharpDX.Result"/> FlushSourceBuffers()
</code>
Return ValueReturns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.
</summary>
<returns>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SourceVoice::FlushSourceBuffers']/*"/>
<unmanaged>HRESULT IXAudio2SourceVoice::FlushSourceBuffers()</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.Discontinuity">
<summary>
<code>
<see cref="T:SharpDX.Result"/> Discontinuity()
</code>
Return ValueReturns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.
</summary>
<returns>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SourceVoice::Discontinuity']/*"/>
<unmanaged>HRESULT IXAudio2SourceVoice::Discontinuity()</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.ExitLoop(System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> ExitLoop( UINT32
</code>
Parameters<list>
<item><term>OperationSet</term><description>[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information. </description></item>
</list>
Return Value<para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes. </para>
</summary>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes. </para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SourceVoice::ExitLoop']/*"/>
<unmanaged>HRESULT IXAudio2SourceVoice::ExitLoop([In] unsigned int OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.GetState(System.Int32)">
<summary>
Returns the voice's current cursor position data.
</summary>
<param name="flags">No documentation.</param>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SourceVoice::GetState']/*"/>
<unmanaged>void IXAudio2SourceVoice::GetState([Out] XAUDIO2_VOICE_STATE* pVoiceState,[In] unsigned int Flags)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.SetFrequencyRatio(System.Single,System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> SetFrequencyRatio( float
</code>
Parameters<list>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<item><term>Ratio</term><description>[in] Frequency adjustment ratio. This value must be between <see cref="F:SharpDX.XAudio2.XAudio2.MinimumFrequencyRatio"/> and the MaxFrequencyRatio parameter specified when the voice was created (see <see cref="M:SharpDX.XAudio2.XAudio2.CreateSourceVoice_(SharpDX.XAudio2.SourceVoice,System.IntPtr,SharpDX.XAudio2.VoiceFlags,System.Single,System.IntPtr,System.Nullable{SharpDX.XAudio2.VoiceSendDescriptors},System.Nullable{SharpDX.XAudio2.EffectChain})"/>). <see cref="F:SharpDX.XAudio2.XAudio2.MinimumFrequencyRatio"/> currently is 0.0005, which allows pitch to be lowered by up to 11 octaves. </description></item>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<item><term>OperationSet</term><description>[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information. </description></item>
</list>
Return Value<para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes. </para>
</summary>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<param name="ratio">[in] Frequency adjustment ratio. This value must be between <see cref="F:SharpDX.XAudio2.XAudio2.MinimumFrequencyRatio"/> and the MaxFrequencyRatio parameter specified when the voice was created (see <see cref="M:SharpDX.XAudio2.XAudio2.CreateSourceVoice_(SharpDX.XAudio2.SourceVoice,System.IntPtr,SharpDX.XAudio2.VoiceFlags,System.Single,System.IntPtr,System.Nullable{SharpDX.XAudio2.VoiceSendDescriptors},System.Nullable{SharpDX.XAudio2.EffectChain})"/>). <see cref="F:SharpDX.XAudio2.XAudio2.MinimumFrequencyRatio"/> currently is 0.0005, which allows pitch to be lowered by up to 11 octaves.</param>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes. </para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SourceVoice::SetFrequencyRatio']/*"/>
<unmanaged>HRESULT IXAudio2SourceVoice::SetFrequencyRatio([In] float Ratio,[In] unsigned int OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.GetFrequencyRatio(System.Single@)">
<summary>
<code>
void GetFrequencyRatio( float *
</code>
Parameters<list>
<item><term>pRatio</term><description>[out] Returns the current frequency adjustment ratio if successful. </description></item>
</list>
Return ValueNone.
</summary>
<param name="ratioRef">[out] Returns the current frequency adjustment ratio if successful.</param>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SourceVoice::GetFrequencyRatio']/*"/>
<unmanaged>void IXAudio2SourceVoice::GetFrequencyRatio([Out] float* pRatio)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.SetSourceSampleRate(System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> SetSourceSampleRate( UINT32
</code>
Parameters<list>
<item><term>NewSourceSampleRate</term><description>[in] The new sample rate the voice should process submitted data at. Valid sample rates are 1kHz to 200kHz. </description></item>
</list>
Return Value <para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.</para>
</summary>
<param name="newSourceSampleRate">[in] The new sample rate the voice should process submitted data at. Valid sample rates are 1kHz to 200kHz.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SourceVoice::SetSourceSampleRate']/*"/>
<unmanaged>HRESULT IXAudio2SourceVoice::SetSourceSampleRate([In] unsigned int NewSourceSampleRate)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.#ctor(SharpDX.XAudio2.XAudio2,SharpDX.Multimedia.WaveFormat)">
<summary>
Creates and configures a source voice.
</summary>
<param name="device">an instance of <see cref="T:SharpDX.XAudio2.XAudio2"/></param>
<param name="sourceFormat">[in] Pointer to a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure. This structure contains the expected format for all audio buffers submitted to the source voice. XAudio2 supports voice types of PCM, xWMA, ADPCM (Windows only), and XMA (Xbox 360 only). XAudio2 supports the following PCM formats. 8-bit (unsigned) integer PCM 16-bit integer PCM (Optimal format for XAudio2) 20-bit integer PCM (either in 24 or 32 bit containers) 24-bit integer PCM (either in 24 or 32 bit containers) 32-bit integer PCM 32-bit float PCM (Preferred format after 16-bit integer) The number of channels in a source voice must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. The sample rate of a source voice must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. Note Data formats such as XMA, {{ADPCM}}, and {{xWMA}} that require more information than provided by <see cref="T:SharpDX.Multimedia.WaveFormat"/> have a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure as the first member in their format structure. When creating a source voice with one of those formats cast the format's structure as a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure and use it as the value for pSourceFormat. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2::CreateSourceVoice([Out] IXAudio2SourceVoice** ppSourceVoice,[In] const WAVEFORMATEX* pSourceFormat,[None] UINT32 Flags,[None] float MaxFrequencyRatio,[In, Optional] IXAudio2VoiceCallback* pCallback,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.#ctor(SharpDX.XAudio2.XAudio2,SharpDX.Multimedia.WaveFormat,System.Boolean)">
<summary>
Creates and configures a source voice.
</summary>
<param name="device">an instance of <see cref="T:SharpDX.XAudio2.XAudio2"/></param>
<param name="sourceFormat">[in] Pointer to a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure. This structure contains the expected format for all audio buffers submitted to the source voice. XAudio2 supports voice types of PCM, xWMA, ADPCM (Windows only), and XMA (Xbox 360 only). XAudio2 supports the following PCM formats. 8-bit (unsigned) integer PCM 16-bit integer PCM (Optimal format for XAudio2) 20-bit integer PCM (either in 24 or 32 bit containers) 24-bit integer PCM (either in 24 or 32 bit containers) 32-bit integer PCM 32-bit float PCM (Preferred format after 16-bit integer) The number of channels in a source voice must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. The sample rate of a source voice must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. Note Data formats such as XMA, {{ADPCM}}, and {{xWMA}} that require more information than provided by <see cref="T:SharpDX.Multimedia.WaveFormat"/> have a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure as the first member in their format structure. When creating a source voice with one of those formats cast the format's structure as a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure and use it as the value for pSourceFormat. </param>
<param name="enableCallbackEvents">True to enable delegate callbacks on this instance. Default is false</param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2::CreateSourceVoice([Out] IXAudio2SourceVoice** ppSourceVoice,[In] const WAVEFORMATEX* pSourceFormat,[None] UINT32 Flags,[None] float MaxFrequencyRatio,[In, Optional] IXAudio2VoiceCallback* pCallback,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.#ctor(SharpDX.XAudio2.XAudio2,SharpDX.Multimedia.WaveFormat,SharpDX.XAudio2.VoiceFlags)">
<summary>
Creates and configures a source voice.
</summary>
<param name="device">an instance of <see cref="T:SharpDX.XAudio2.XAudio2"/></param>
<param name="sourceFormat">[in] Pointer to a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure. This structure contains the expected format for all audio buffers submitted to the source voice. XAudio2 supports voice types of PCM, xWMA, ADPCM (Windows only), and XMA (Xbox 360 only). XAudio2 supports the following PCM formats. 8-bit (unsigned) integer PCM 16-bit integer PCM (Optimal format for XAudio2) 20-bit integer PCM (either in 24 or 32 bit containers) 24-bit integer PCM (either in 24 or 32 bit containers) 32-bit integer PCM 32-bit float PCM (Preferred format after 16-bit integer) The number of channels in a source voice must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. The sample rate of a source voice must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. Note Data formats such as XMA, {{ADPCM}}, and {{xWMA}} that require more information than provided by <see cref="T:SharpDX.Multimedia.WaveFormat"/> have a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure as the first member in their format structure. When creating a source voice with one of those formats cast the format's structure as a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure and use it as the value for pSourceFormat. </param>
<param name="flags">[in] Flags that specify the behavior of the source voice. A flag can be 0 or a combination of one or more of the following: ValueDescriptionXAUDIO2_VOICE_NOPITCHNo pitch control is available on the voice.?XAUDIO2_VOICE_NOSRCNo sample rate conversion is available on the voice, the voice's outputs must have the same sample rate.Note The XAUDIO2_VOICE_NOSRC flag causes the voice to behave as though the XAUDIO2_VOICE_NOPITCH flag also is specified. ?XAUDIO2_VOICE_USEFILTERThe filter effect should be available on this voice.?XAUDIO2_VOICE_MUSICThe voice is used to play background music. The system automatically can replace the voice with music selected by the user.? </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2::CreateSourceVoice([Out] IXAudio2SourceVoice** ppSourceVoice,[In] const WAVEFORMATEX* pSourceFormat,[None] UINT32 Flags,[None] float MaxFrequencyRatio,[In, Optional] IXAudio2VoiceCallback* pCallback,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.#ctor(SharpDX.XAudio2.XAudio2,SharpDX.Multimedia.WaveFormat,SharpDX.XAudio2.VoiceFlags,System.Boolean)">
<summary>
Creates and configures a source voice.
</summary>
<param name="device">an instance of <see cref="T:SharpDX.XAudio2.XAudio2"/></param>
<param name="sourceFormat">[in] Pointer to a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure. This structure contains the expected format for all audio buffers submitted to the source voice. XAudio2 supports voice types of PCM, xWMA, ADPCM (Windows only), and XMA (Xbox 360 only). XAudio2 supports the following PCM formats. 8-bit (unsigned) integer PCM 16-bit integer PCM (Optimal format for XAudio2) 20-bit integer PCM (either in 24 or 32 bit containers) 24-bit integer PCM (either in 24 or 32 bit containers) 32-bit integer PCM 32-bit float PCM (Preferred format after 16-bit integer) The number of channels in a source voice must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. The sample rate of a source voice must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. Note Data formats such as XMA, {{ADPCM}}, and {{xWMA}} that require more information than provided by <see cref="T:SharpDX.Multimedia.WaveFormat"/> have a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure as the first member in their format structure. When creating a source voice with one of those formats cast the format's structure as a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure and use it as the value for pSourceFormat. </param>
<param name="flags">[in] Flags that specify the behavior of the source voice. A flag can be 0 or a combination of one or more of the following: ValueDescriptionXAUDIO2_VOICE_NOPITCHNo pitch control is available on the voice.?XAUDIO2_VOICE_NOSRCNo sample rate conversion is available on the voice, the voice's outputs must have the same sample rate.Note The XAUDIO2_VOICE_NOSRC flag causes the voice to behave as though the XAUDIO2_VOICE_NOPITCH flag also is specified. ?XAUDIO2_VOICE_USEFILTERThe filter effect should be available on this voice.?XAUDIO2_VOICE_MUSICThe voice is used to play background music. The system automatically can replace the voice with music selected by the user.? </param>
<param name="enableCallbackEvents">True to enable delegate callbacks on this instance. Default is false</param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2::CreateSourceVoice([Out] IXAudio2SourceVoice** ppSourceVoice,[In] const WAVEFORMATEX* pSourceFormat,[None] UINT32 Flags,[None] float MaxFrequencyRatio,[In, Optional] IXAudio2VoiceCallback* pCallback,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.#ctor(SharpDX.XAudio2.XAudio2,SharpDX.Multimedia.WaveFormat,SharpDX.XAudio2.VoiceFlags,System.Single)">
<summary>
Creates and configures a source voice.
</summary>
<param name="device">an instance of <see cref="T:SharpDX.XAudio2.XAudio2"/></param>
<param name="sourceFormat">[in] Pointer to a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure. This structure contains the expected format for all audio buffers submitted to the source voice. XAudio2 supports voice types of PCM, xWMA, ADPCM (Windows only), and XMA (Xbox 360 only). XAudio2 supports the following PCM formats. 8-bit (unsigned) integer PCM 16-bit integer PCM (Optimal format for XAudio2) 20-bit integer PCM (either in 24 or 32 bit containers) 24-bit integer PCM (either in 24 or 32 bit containers) 32-bit integer PCM 32-bit float PCM (Preferred format after 16-bit integer) The number of channels in a source voice must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. The sample rate of a source voice must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. Note Data formats such as XMA, {{ADPCM}}, and {{xWMA}} that require more information than provided by <see cref="T:SharpDX.Multimedia.WaveFormat"/> have a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure as the first member in their format structure. When creating a source voice with one of those formats cast the format's structure as a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure and use it as the value for pSourceFormat. </param>
<param name="flags">[in] Flags that specify the behavior of the source voice. A flag can be 0 or a combination of one or more of the following: ValueDescriptionXAUDIO2_VOICE_NOPITCHNo pitch control is available on the voice.?XAUDIO2_VOICE_NOSRCNo sample rate conversion is available on the voice, the voice's outputs must have the same sample rate.Note The XAUDIO2_VOICE_NOSRC flag causes the voice to behave as though the XAUDIO2_VOICE_NOPITCH flag also is specified. ?XAUDIO2_VOICE_USEFILTERThe filter effect should be available on this voice.?XAUDIO2_VOICE_MUSICThe voice is used to play background music. The system automatically can replace the voice with music selected by the user.? </param>
<param name="maxFrequencyRatio">[in] Highest allowable frequency ratio that can be set on this voice. The value for this argument must be between XAUDIO2_MIN_FREQ_RATIO and XAUDIO2_MAX_FREQ_RATIO. Subsequent calls to <see cref="M:SharpDX.XAudio2.SourceVoice.SetFrequencyRatio(System.Single,System.Int32)"/> are clamped between XAUDIO2_MIN_FREQ_RATIO and MaxFrequencyRatio. The maximum value for this argument is defined as XAUDIO2_MAX_FREQ_RATIO, which allows pitch to be raised by up to 10 octaves. If MaxFrequencyRatio is less than 1.0, the voice will use that ratio immediately after being created (rather than the default of 1.0). Xbox 360 For XMA voices there is an additional restriction on the MaxFrequencyRatio argument and the voice's sample rate. The product of these two numbers cannot exceed XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MONO for one-channel voices or XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MULTICHANNEL for voices with any other number of channels. If the value specified for MaxFrequencyRatio is too high for the specified format, the call to CreateSourceVoice fails and produces a debug message. Note XAudio2's memory usage can be reduced by using the lowest possible MaxFrequencyRatio value. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2::CreateSourceVoice([Out] IXAudio2SourceVoice** ppSourceVoice,[In] const WAVEFORMATEX* pSourceFormat,[None] UINT32 Flags,[None] float MaxFrequencyRatio,[In, Optional] IXAudio2VoiceCallback* pCallback,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.#ctor(SharpDX.XAudio2.XAudio2,SharpDX.Multimedia.WaveFormat,SharpDX.XAudio2.VoiceFlags,System.Single,SharpDX.XAudio2.VoiceCallback)">
<summary>
Creates and configures a source voice.
</summary>
<param name="device">an instance of <see cref="T:SharpDX.XAudio2.XAudio2"/></param>
<param name="sourceFormat">[in] Pointer to a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure. This structure contains the expected format for all audio buffers submitted to the source voice. XAudio2 supports voice types of PCM, xWMA, ADPCM (Windows only), and XMA (Xbox 360 only). XAudio2 supports the following PCM formats. 8-bit (unsigned) integer PCM 16-bit integer PCM (Optimal format for XAudio2) 20-bit integer PCM (either in 24 or 32 bit containers) 24-bit integer PCM (either in 24 or 32 bit containers) 32-bit integer PCM 32-bit float PCM (Preferred format after 16-bit integer) The number of channels in a source voice must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. The sample rate of a source voice must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. Note Data formats such as XMA, {{ADPCM}}, and {{xWMA}} that require more information than provided by <see cref="T:SharpDX.Multimedia.WaveFormat"/> have a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure as the first member in their format structure. When creating a source voice with one of those formats cast the format's structure as a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure and use it as the value for pSourceFormat. </param>
<param name="flags">[in] Flags that specify the behavior of the source voice. A flag can be 0 or a combination of one or more of the following: ValueDescriptionXAUDIO2_VOICE_NOPITCHNo pitch control is available on the voice.?XAUDIO2_VOICE_NOSRCNo sample rate conversion is available on the voice, the voice's outputs must have the same sample rate.Note The XAUDIO2_VOICE_NOSRC flag causes the voice to behave as though the XAUDIO2_VOICE_NOPITCH flag also is specified. ?XAUDIO2_VOICE_USEFILTERThe filter effect should be available on this voice.?XAUDIO2_VOICE_MUSICThe voice is used to play background music. The system automatically can replace the voice with music selected by the user.? </param>
<param name="maxFrequencyRatio">[in] Highest allowable frequency ratio that can be set on this voice. The value for this argument must be between XAUDIO2_MIN_FREQ_RATIO and XAUDIO2_MAX_FREQ_RATIO. Subsequent calls to <see cref="M:SharpDX.XAudio2.SourceVoice.SetFrequencyRatio(System.Single,System.Int32)"/> are clamped between XAUDIO2_MIN_FREQ_RATIO and MaxFrequencyRatio. The maximum value for this argument is defined as XAUDIO2_MAX_FREQ_RATIO, which allows pitch to be raised by up to 10 octaves. If MaxFrequencyRatio is less than 1.0, the voice will use that ratio immediately after being created (rather than the default of 1.0). Xbox 360 For XMA voices there is an additional restriction on the MaxFrequencyRatio argument and the voice's sample rate. The product of these two numbers cannot exceed XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MONO for one-channel voices or XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MULTICHANNEL for voices with any other number of channels. If the value specified for MaxFrequencyRatio is too high for the specified format, the call to CreateSourceVoice fails and produces a debug message. Note XAudio2's memory usage can be reduced by using the lowest possible MaxFrequencyRatio value. </param>
<param name="callback">[in, optional] Pointer to a client-provided callback interface, <see cref="T:SharpDX.XAudio2.VoiceCallback"/>. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2::CreateSourceVoice([Out] IXAudio2SourceVoice** ppSourceVoice,[In] const WAVEFORMATEX* pSourceFormat,[None] UINT32 Flags,[None] float MaxFrequencyRatio,[In, Optional] IXAudio2VoiceCallback* pCallback,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.#ctor(SharpDX.XAudio2.XAudio2,SharpDX.Multimedia.WaveFormat,SharpDX.XAudio2.VoiceFlags,System.Single,System.Boolean)">
<summary>
Creates and configures a source voice with callback through delegates.
</summary>
<param name="device">an instance of <see cref="T:SharpDX.XAudio2.XAudio2"/></param>
<param name="sourceFormat">[in] Pointer to a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure. This structure contains the expected format for all audio buffers submitted to the source voice. XAudio2 supports voice types of PCM, xWMA, ADPCM (Windows only), and XMA (Xbox 360 only). XAudio2 supports the following PCM formats. 8-bit (unsigned) integer PCM 16-bit integer PCM (Optimal format for XAudio2) 20-bit integer PCM (either in 24 or 32 bit containers) 24-bit integer PCM (either in 24 or 32 bit containers) 32-bit integer PCM 32-bit float PCM (Preferred format after 16-bit integer) The number of channels in a source voice must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. The sample rate of a source voice must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. Note Data formats such as XMA, {{ADPCM}}, and {{xWMA}} that require more information than provided by <see cref="T:SharpDX.Multimedia.WaveFormat"/> have a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure as the first member in their format structure. When creating a source voice with one of those formats cast the format's structure as a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure and use it as the value for pSourceFormat. </param>
<param name="flags">[in] Flags that specify the behavior of the source voice. A flag can be 0 or a combination of one or more of the following: ValueDescriptionXAUDIO2_VOICE_NOPITCHNo pitch control is available on the voice.?XAUDIO2_VOICE_NOSRCNo sample rate conversion is available on the voice, the voice's outputs must have the same sample rate.Note The XAUDIO2_VOICE_NOSRC flag causes the voice to behave as though the XAUDIO2_VOICE_NOPITCH flag also is specified. ?XAUDIO2_VOICE_USEFILTERThe filter effect should be available on this voice.?XAUDIO2_VOICE_MUSICThe voice is used to play background music. The system automatically can replace the voice with music selected by the user.? </param>
<param name="maxFrequencyRatio">[in] Highest allowable frequency ratio that can be set on this voice. The value for this argument must be between XAUDIO2_MIN_FREQ_RATIO and XAUDIO2_MAX_FREQ_RATIO. Subsequent calls to <see cref="M:SharpDX.XAudio2.SourceVoice.SetFrequencyRatio(System.Single,System.Int32)"/> are clamped between XAUDIO2_MIN_FREQ_RATIO and MaxFrequencyRatio. The maximum value for this argument is defined as XAUDIO2_MAX_FREQ_RATIO, which allows pitch to be raised by up to 10 octaves. If MaxFrequencyRatio is less than 1.0, the voice will use that ratio immediately after being created (rather than the default of 1.0). Xbox 360 For XMA voices there is an additional restriction on the MaxFrequencyRatio argument and the voice's sample rate. The product of these two numbers cannot exceed XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MONO for one-channel voices or XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MULTICHANNEL for voices with any other number of channels. If the value specified for MaxFrequencyRatio is too high for the specified format, the call to CreateSourceVoice fails and produces a debug message. Note XAudio2's memory usage can be reduced by using the lowest possible MaxFrequencyRatio value. </param>
<param name="enableDelegateCallbacks">True to enable delegate callbacks on this instance. Default is false</param>
<returns>No enableCallbackEvents.</returns>
<unmanaged>HRESULT IXAudio2::CreateSourceVoice([Out] IXAudio2SourceVoice** ppSourceVoice,[In] const WAVEFORMATEX* pSourceFormat,[None] UINT32 Flags,[None] float MaxFrequencyRatio,[In, Optional] IXAudio2VoiceCallback* pCallback,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.Start">
<summary>
Starts consumption and processing of audio by the voice. Delivers the result to any connected submix or mastering voices, or to the output device, with CommitNow changes.
</summary>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2SourceVoice::Start([None] UINT32 Flags,[None] UINT32 OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.SetFrequencyRatio(System.Single)">
<summary>
Sets the frequency ratio.
</summary>
<param name="ratio">The ratio.</param>
<returns></returns>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.Start(System.Int32)">
<summary>
Starts consumption and processing of audio by the voice. Delivers the result to any connected submix or mastering voices, or to the output device.
</summary>
<param name="operationSet">[in] Identifies this call as part of a deferred batch. See the {{XAudio2 Operation Sets}} overview for more information. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2SourceVoice::Start([None] UINT32 Flags,[None] UINT32 OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SourceVoice.SubmitSourceBuffer(SharpDX.XAudio2.AudioBuffer,System.UInt32[])">
<summary>
No documentation.
</summary>
<param name="bufferRef">No documentation.</param>
<param name="decodedXMWAPacketInfo">No documentation.</param>
<returns>No documentation.</returns>
<!-- Failed to insert some or all of included XML --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SourceVoice::SubmitSourceBuffer']/*"/>
<unmanaged>HRESULT IXAudio2SourceVoice::SubmitSourceBuffer([In] const XAUDIO2_BUFFER* pBuffer,[In, Optional] const XAUDIO2_BUFFER_WMA* pBufferWMA)</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.SourceVoice.FrequencyRatio">
<summary>
<code>
void GetFrequencyRatio( float *
</code>
Parameters<list>
<item><term>pRatio</term><description>[out] Returns the current frequency adjustment ratio if successful. </description></item>
</list>
Return ValueNone.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SourceVoice::GetFrequencyRatio']/*"/>
<unmanaged>GetFrequencyRatio</unmanaged>
<unmanaged>void IXAudio2SourceVoice::GetFrequencyRatio([Out] float* pRatio)</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.SourceVoice.SourceSampleRate">
<summary>
<code>
<see cref="T:SharpDX.Result"/> SetSourceSampleRate( UINT32
</code>
Parameters<list>
<item><term>NewSourceSampleRate</term><description>[in] The new sample rate the voice should process submitted data at. Valid sample rates are 1kHz to 200kHz. </description></item>
</list>
Return Value <para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of error codes.</para>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SourceVoice::SetSourceSampleRate']/*"/>
<unmanaged>SetSourceSampleRate</unmanaged>
<unmanaged>HRESULT IXAudio2SourceVoice::SetSourceSampleRate([In] unsigned int NewSourceSampleRate)</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.SourceVoice.State">
<summary>
Gets the state.
</summary>
</member>
<member name="E:SharpDX.XAudio2.SourceVoice.ProcessingPassStart">
<summary>
Occurs just before the processing pass for the voice begins.
</summary>
<remarks>
In order to use this delegate, this instance must have been intialized with events delegate support.
</remarks>
</member>
<member name="E:SharpDX.XAudio2.SourceVoice.ProcessingPassEnd">
<summary>
Occurs just after the processing pass for the voice ends.
</summary>
<remarks>
In order to use this delegate, this instance must have been intialized with events delegate support.
</remarks>
</member>
<member name="E:SharpDX.XAudio2.SourceVoice.StreamEnd">
<summary>
Occurs when the voice has just finished playing a contiguous audio stream.
</summary>
<remarks>
In order to use this delegate, this instance must have been intialized with events delegate support.
</remarks>
</member>
<member name="E:SharpDX.XAudio2.SourceVoice.BufferStart">
<summary>
Occurs when the voice is about to start processing a new audio buffer.
</summary>
<remarks>
In order to use this delegate, this instance must have been intialized with events delegate support.
</remarks>
</member>
<member name="E:SharpDX.XAudio2.SourceVoice.BufferEnd">
<summary>
Occurs when the voice finishes processing a buffer.
</summary>
<remarks>
In order to use this delegate, this instance must have been intialized with events delegate support.
</remarks>
</member>
<member name="E:SharpDX.XAudio2.SourceVoice.LoopEnd">
<summary>
Occurs when a critical error occurs during voice processing.
</summary>
<remarks>
In order to use this delegate, this instance must have been intialized with events delegate support.
</remarks>
</member>
<member name="E:SharpDX.XAudio2.SourceVoice.VoiceError">
<summary>
Occurs when [voice error].
</summary>
<remarks>
In order to use this delegate, this instance must have been intialized with events delegate support.
</remarks>
</member>
<member name="T:SharpDX.XAudio2.VoiceCallback">
<summary>
IXAudio2SourceVoice
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2VoiceCallback']/*"/>
<unmanaged>IXAudio2VoiceCallback</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.VoiceCallback.OnVoiceProcessingPassStart(System.Int32)">
<summary>
Called during each processing pass for each voice, just before XAudio2 reads data from the voice's buffer queue.
</summary>
<param name="bytesRequired"> The number of bytes that must be submitted immediately to avoid starvation. This allows the implementation of just-in-time streaming scenarios; the client can keep the absolute minimum data queued on the voice at all times, and pass it fresh data just before the data is required. This model provides the lowest possible latency attainable with XAudio2. For xWMA and XMA data BytesRequired will always be zero, since the concept of a frame of xWMA or XMA data is meaningless. Note In a situation where there is always plenty of data available on the source voice, BytesRequired should always report zero, because it doesn't need any samples immediately to avoid glitching. </param>
<unmanaged>void IXAudio2VoiceCallback::OnVoiceProcessingPassStart([None] UINT32 BytesRequired)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.VoiceCallback.OnVoiceProcessingPassEnd">
<summary>
Called just after the processing pass for the voice ends.
</summary>
<unmanaged>void IXAudio2VoiceCallback::OnVoiceProcessingPassEnd()</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.VoiceCallback.OnStreamEnd">
<summary>
Called when the voice has just finished playing a contiguous audio stream.
</summary>
<unmanaged>void IXAudio2VoiceCallback::OnStreamEnd()</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.VoiceCallback.OnBufferStart(System.IntPtr)">
<summary>
Called when the voice is about to start processing a new audio buffer.
</summary>
<param name="context"> Context pointer that was assigned to the pContext member of the <see cref="T:SharpDX.XAudio2.AudioBuffer"/> structure when the buffer was submitted. </param>
<unmanaged>void IXAudio2VoiceCallback::OnBufferStart([None] void* pBufferContext)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.VoiceCallback.OnBufferEnd(System.IntPtr)">
<summary>
Called when the voice finishes processing a buffer.
</summary>
<param name="context"> Context pointer assigned to the pContext member of the <see cref="T:SharpDX.XAudio2.AudioBuffer"/> structure when the buffer was submitted. </param>
<unmanaged>void IXAudio2VoiceCallback::OnBufferEnd([None] void* pBufferContext)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.VoiceCallback.OnLoopEnd(System.IntPtr)">
<summary>
Called when the voice reaches the end position of a loop.
</summary>
<param name="context"> Context pointer that was assigned to the pContext member of the <see cref="T:SharpDX.XAudio2.AudioBuffer"/> structure when the buffer was submitted. </param>
<unmanaged>void IXAudio2VoiceCallback::OnLoopEnd([None] void* pBufferContext)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.VoiceCallback.OnVoiceError(System.IntPtr,SharpDX.Result)">
<summary>
Called when a critical error occurs during voice processing.
</summary>
<param name="context"> Context pointer that was assigned to the pContext member of the <see cref="T:SharpDX.XAudio2.AudioBuffer"/> structure when the buffer was submitted. </param>
<param name="error"> The HRESULT code of the error encountered. </param>
<unmanaged>void IXAudio2VoiceCallback::OnVoiceError([None] void* pBufferContext,[None] HRESULT Error)</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.SubmixVoice">
<summary>
IXAudio2SubmixVoice inherits directly from <see cref="T:SharpDX.XAudio2.Voice"/>, but does not implement methods specific to submix voices. The interface type exists solely because some of the base class methods are implemented differently for submix voices. Having a separate type for these voices helps client code to distinguish the different voice types and to benefit from C++ type safety.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2SubmixVoice']/*"/>
<unmanaged>IXAudio2SubmixVoice</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SubmixVoice.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.SubmixVoice"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.XAudio2.SubmixVoice.#ctor(SharpDX.XAudio2.XAudio2)">
<summary>
Creates and configures a mastering voice on the default audio device, with stereo channels at 44100Hz.
</summary>
<param name="device">an instance of <see cref="T:SharpDX.XAudio2.XAudio2"/></param>
<unmanaged>HRESULT IXAudio2::CreateSubmixVoice([Out] IXAudio2SubmixVoice** ppSubmixVoice,[None] UINT32 InputChannels,[None] UINT32 InputSampleRate,[None] UINT32 Flags,[None] UINT32 DeviceIndex,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SubmixVoice.#ctor(SharpDX.XAudio2.XAudio2,System.Int32)">
<summary>
Creates and configures a mastering voice on the default audio device and 44100Hz.
</summary>
<param name="device">an instance of <see cref="T:SharpDX.XAudio2.XAudio2"/></param>
<param name="inputChannels">[in] Number of channels the mastering voice expects in its input audio. InputChannels must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. InputChannels can be set to XAUDIO2_DEFAULT_CHANNELS, with the default being determined by the current platform. Windows Attempts to detect the system speaker configuration setup. Xbox 360 Defaults to 5.1 surround. </param>
<unmanaged>HRESULT IXAudio2::CreateSubmixVoice([Out] IXAudio2SubmixVoice** ppSubmixVoice,[None] UINT32 InputChannels,[None] UINT32 InputSampleRate,[None] UINT32 Flags,[None] UINT32 DeviceIndex,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SubmixVoice.#ctor(SharpDX.XAudio2.XAudio2,System.Int32,System.Int32)">
<summary>
Creates and configures a mastering voice on the default audio device.
</summary>
<param name="device">an instance of <see cref="T:SharpDX.XAudio2.XAudio2"/></param>
<param name="inputChannels">[in] Number of channels the mastering voice expects in its input audio. InputChannels must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. InputChannels can be set to XAUDIO2_DEFAULT_CHANNELS, with the default being determined by the current platform. Windows Attempts to detect the system speaker configuration setup. Xbox 360 Defaults to 5.1 surround. </param>
<param name="inputSampleRate">[in] Sample rate of the input audio data of the mastering voice. This rate must be a multiple of XAUDIO2_QUANTUM_DENOMINATOR. InputSampleRate must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. InputSampleRate can be set to XAUDIO2_DEFAULT_SAMPLERATE, with the default being determined by the current platform. Windows Windows XP defaults to 44100. Windows Vista and Windows 7 default to the setting specified in the Sound Control Panel. The default for this setting is 44100 (or 48000 if required by the driver). Xbox 360 Defaults to 48000. </param>
<unmanaged>HRESULT IXAudio2::CreateSubmixVoice([Out] IXAudio2SubmixVoice** ppSubmixVoice,[None] UINT32 InputChannels,[None] UINT32 InputSampleRate,[None] UINT32 Flags,[None] UINT32 DeviceIndex,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.SubmixVoice.#ctor(SharpDX.XAudio2.XAudio2,System.Int32,System.Int32,SharpDX.XAudio2.VoiceSendFlags,System.Int32)">
<summary>
Creates and configures a submix voice.
</summary>
<param name="device">an instance of <see cref="T:SharpDX.XAudio2.XAudio2"/></param>
<param name="inputChannels">[in] Number of channels in the input audio data of the submix voice. InputChannels must be less than or equal to XAUDIO2_MAX_AUDIO_CHANNELS. </param>
<param name="inputSampleRate">[in] Sample rate of the input audio data of submix voice. This rate must be a multiple of XAUDIO2_QUANTUM_DENOMINATOR. InputSampleRate must be between XAUDIO2_MIN_SAMPLE_RATE and XAUDIO2_MAX_SAMPLE_RATE. </param>
<param name="flags">[in] Flags that specify the behavior of the submix voice. Can be 0 or the following: ValueDescriptionXAUDIO2_VOICE_USEFILTERThe filter effect should be available on this voice.? </param>
<param name="processingStage">[in] An arbitrary number that specifies when this voice is processed with respect to other submix voices, if the XAudio2 engine is running other submix voices. The voice is processed after all other voices that include a smaller ProcessingStage value, and before all other voices that include a larger ProcessingStage value. Voices that include the same ProcessingStage value are processed in any order. A submix voice cannot send to another submix voice with a lower or equal ProcessingStage value; this prevents audio being lost due to a submix cycle. </param>
<returns>No documentation.</returns>
<unmanaged>HRESULT IXAudio2::CreateSubmixVoice([Out] IXAudio2SubmixVoice** ppSubmixVoice,[None] UINT32 InputChannels,[None] UINT32 InputSampleRate,[None] UINT32 Flags,[None] UINT32 ProcessingStage,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.XAudio2">
<summary>
IXAudio2::AddRef
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2']/*"/>
<unmanaged>IXAudio2</unmanaged>
</member>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<member name="F:SharpDX.XAudio2.XAudio2.MaximumBufferBytes">
<summary>Constant MaximumBufferBytes.</summary>
<unmanaged>XAUDIO2_MAX_BUFFER_BYTES</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.MaximumQueuedBuffers">
<summary>Constant MaximumQueuedBuffers.</summary>
<unmanaged>XAUDIO2_MAX_QUEUED_BUFFERS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.MaximumAudioChannels">
<summary>Constant MaximumAudioChannels.</summary>
<unmanaged>XAUDIO2_MAX_AUDIO_CHANNELS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.MinimumSampleRate">
<summary>Constant MinimumSampleRate.</summary>
<unmanaged>XAUDIO2_MIN_SAMPLE_RATE</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.MaximumSampleRate">
<summary>Constant MaximumSampleRate.</summary>
<unmanaged>XAUDIO2_MAX_SAMPLE_RATE</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.MaximumVolumeLevel">
<summary>Constant MaximumVolumeLevel.</summary>
<unmanaged>XAUDIO2_MAX_VOLUME_LEVEL</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.MinimumFrequencyRatio">
<summary>Constant MinimumFrequencyRatio.</summary>
<unmanaged>XAUDIO2_MIN_FREQ_RATIO</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.MaximumFrequencyRatio">
<summary>Constant MaximumFrequencyRatio.</summary>
<unmanaged>XAUDIO2_MAX_FREQ_RATIO</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.DefaultFrequencyRatio">
<summary>Constant DefaultFrequencyRatio.</summary>
<unmanaged>XAUDIO2_DEFAULT_FREQ_RATIO</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.MaximumFilterOneOverQ">
<summary>Constant MaximumFilterOneOverQ.</summary>
<unmanaged>XAUDIO2_MAX_FILTER_ONEOVERQ</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.MaximumFilterFrequency">
<summary>Constant MaximumFilterFrequency.</summary>
<unmanaged>XAUDIO2_MAX_FILTER_FREQUENCY</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.MaximumLoopCount">
<summary>Constant MaximumLoopCount.</summary>
<unmanaged>XAUDIO2_MAX_LOOP_COUNT</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.CommitNow">
<summary>Constant CommitNow.</summary>
<unmanaged>XAUDIO2_COMMIT_NOW</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.CommitAll">
<summary>Constant CommitAll.</summary>
<unmanaged>XAUDIO2_COMMIT_ALL</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.NoLoopRegion">
<summary>Constant NoLoopRegion.</summary>
<unmanaged>XAUDIO2_NO_LOOP_REGION</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.DefaultChannels">
<summary>Constant DefaultChannels.</summary>
<unmanaged>XAUDIO2_DEFAULT_CHANNELS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.XAudio2.DefaultSampleRate">
<summary>Constant DefaultSampleRate.</summary>
<unmanaged>XAUDIO2_DEFAULT_SAMPLERATE</unmanaged>
</member>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<member name="M:SharpDX.XAudio2.XAudio2.#ctor(System.IntPtr)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.XAudio2"/> class.
</summary>
<param name="nativePtr">The native pointer.</param>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.RegisterForCallbacks_(System.IntPtr)">
<summary>
IXAudio2EngineCallback
</summary>
<param name="callbackRef">No documentation.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2::RegisterForCallbacks']/*"/>
<unmanaged>HRESULT IXAudio2::RegisterForCallbacks([In] IXAudio2EngineCallback* pCallback)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.UnregisterForCallbacks_(System.IntPtr)">
<summary>
IXAudio2EngineCallback
</summary>
<param name="callbackRef">No documentation.</param>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2::UnregisterForCallbacks']/*"/>
<unmanaged>void IXAudio2::UnregisterForCallbacks([In] IXAudio2EngineCallback* pCallback)</unmanaged>
</member>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<member name="M:SharpDX.XAudio2.XAudio2.CreateSourceVoice_(SharpDX.XAudio2.SourceVoice,System.IntPtr,SharpDX.XAudio2.VoiceFlags,System.Single,System.IntPtr,System.Nullable{SharpDX.XAudio2.VoiceSendDescriptors},System.Nullable{SharpDX.XAudio2.EffectChain})">
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<summary>
<code>
<see cref="T:SharpDX.Result"/> CreateSourceVoice( <see cref="T:SharpDX.XAudio2.SourceVoice"/> **
</code>
Parameters<list>
<item><term>ppSourceVoice</term><description>[out] If successful, returns a reference to the new <see cref="T:SharpDX.XAudio2.SourceVoice"/> object. </description></item>
<item><term>pSourceFormat</term><description>[in] Pointer to a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure. This structure contains the expected format for all audio buffers submitted to the source voice. <para>XAudio2 supports PCM and ADPCM voice types. XAudio2 supports the following PCM formats.</para>
<para>8-bit (unsigned) integer PCM</para>
<para>16-bit integer PCM (optimal format for XAudio2)</para>
<para>20-bit integer PCM (either in 24 or 32 bit containers)</para>
<para>24-bit integer PCM (either in 24 or 32 bit containers)</para>
<para>32-bit integer PCM</para>
<para>32-bit float PCM (preferred format after 16-bit integer)</para>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<para>The number of channels in a source voice must be less than or equal to <see cref="F:SharpDX.XAudio2.XAudio2.MaximumAudioChannels"/>. The sample rate of a source voice must be between <see cref="F:SharpDX.XAudio2.XAudio2.MinimumSampleRate"/> and <see cref="F:SharpDX.XAudio2.XAudio2.MaximumSampleRate"/>.</para>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
Note Data formats such as ADPCM that require more information than provided by <see cref="T:SharpDX.Multimedia.WaveFormat"/> have a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure as the first member in their format structures. When you create a source voice with one of those formats, cast the format's structure as a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure and use it as the value for pSourceFormat. </description></item>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<item><term>Flags</term><description>[in] Flags that specify the behavior of the source voice. A flag can be 0 or a combination of one or more of the following: ValueDescriptionXAUDIO2_VOICE_NOPITCHNo pitch control is available on the voice.?XAUDIO2_VOICE_NOSRCNo sample rate conversion is available on the voice. The voice's outputs must have the same sample rate. Note The <see cref="F:SharpDX.XAudio2.VoiceFlags.NoSampleRateConversion"/> flag causes the voice to behave as though the <see cref="F:SharpDX.XAudio2.VoiceFlags.NoPitch"/> flag also is specified. ?XAUDIO2_VOICE_USEFILTERThe filter effect should be available on this voice.? </description></item>
<item><term>MaxFrequencyRatio</term><description>[in] Highest allowable frequency ratio that can be set on this voice. The value for this argument must be between <see cref="F:SharpDX.XAudio2.XAudio2.MinimumFrequencyRatio"/> and <see cref="F:SharpDX.XAudio2.XAudio2.MaximumFrequencyRatio"/>. Subsequent calls to <see cref="M:SharpDX.XAudio2.SourceVoice.SetFrequencyRatio(System.Single,System.Int32)"/> are clamped between <see cref="F:SharpDX.XAudio2.XAudio2.MinimumFrequencyRatio"/> and MaxFrequencyRatio. <para>The maximum value for this argument is defined as <see cref="F:SharpDX.XAudio2.XAudio2.MaximumFrequencyRatio"/>, which allows pitch to be raised by up to 10 octaves.</para>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<para>If MaxFrequencyRatio is less than 1.0, the voice will use that ratio immediately after being created (rather than the default of 1.0).</para>
Xbox 360 <para>For XMA voices, there is one more restriction on the MaxFrequencyRatio argument and the voice's sample rate. The product of these two numbers cannot exceed XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MONO for one-channel voices or XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MULTICHANNEL for voices with any other number of channels. If the value specified for MaxFrequencyRatio is too high for the specified format, the call to CreateSourceVoice fails and produces a debug message.</para>
Note You can use the lowest possible MaxFrequencyRatio value to reduce XAudio2's memory usage. </description></item>
<item><term>pCallback</term><description>[in, optional] Pointer to a client-provided callback interface, <see cref="T:SharpDX.XAudio2.VoiceCallback"/>. </description></item>
<item><term>pSendList</term><description>[in, optional] Pointer to a list of <see cref="T:SharpDX.XAudio2.VoiceSendDescriptors"/> structures that describe the set of destination voices for the source voice. If pSendList is <c>null</c>, the send list defaults to a single output to the first mastering voice created. </description></item>
<item><term>pEffectChain</term><description>[in, optional] Pointer to a list of <see cref="T:SharpDX.XAudio2.EffectChain"/> structures that describe an effect chain to use in the source voice. </description></item>
</list>
Return Value <para> Returns <see cref="F:SharpDX.Result.Ok"/> if successful; otherwise, an error code. </para>
<para> See XAudio2 Error Codes for descriptions of XAudio2-specific error codes.</para>
</summary>
<param name="sourceVoiceOut">[out] If successful, returns a reference to the new <see cref="T:SharpDX.XAudio2.SourceVoice"/> object.</param>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<param name="sourceFormatRef">[in] Pointer to a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure. This structure contains the expected format for all audio buffers submitted to the source voice. <para>XAudio2 supports PCM and ADPCM voice types. XAudio2 supports the following PCM formats.</para> <para>8-bit (unsigned) integer PCM</para> <para>16-bit integer PCM (optimal format for XAudio2)</para> <para>20-bit integer PCM (either in 24 or 32 bit containers)</para> <para>24-bit integer PCM (either in 24 or 32 bit containers)</para> <para>32-bit integer PCM</para> <para>32-bit float PCM (preferred format after 16-bit integer)</para> <para>The number of channels in a source voice must be less than or equal to <see cref="F:SharpDX.XAudio2.XAudio2.MaximumAudioChannels"/>. The sample rate of a source voice must be between <see cref="F:SharpDX.XAudio2.XAudio2.MinimumSampleRate"/> and <see cref="F:SharpDX.XAudio2.XAudio2.MaximumSampleRate"/>.</para> Note Data formats such as ADPCM that require more information than provided by <see cref="T:SharpDX.Multimedia.WaveFormat"/> have a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure as the first member in their format structures. When you create a source voice with one of those formats, cast the format's structure as a <see cref="T:SharpDX.Multimedia.WaveFormat"/> structure and use it as the value for pSourceFormat.</param>
<param name="flags">[in] Flags that specify the behavior of the source voice. A flag can be 0 or a combination of one or more of the following: ValueDescriptionXAUDIO2_VOICE_NOPITCHNo pitch control is available on the voice.?XAUDIO2_VOICE_NOSRCNo sample rate conversion is available on the voice. The voice's outputs must have the same sample rate. Note The <see cref="F:SharpDX.XAudio2.VoiceFlags.NoSampleRateConversion"/> flag causes the voice to behave as though the <see cref="F:SharpDX.XAudio2.VoiceFlags.NoPitch"/> flag also is specified. ?XAUDIO2_VOICE_USEFILTERThe filter effect should be available on this voice.?</param>
<param name="maxFrequencyRatio">[in] Highest allowable frequency ratio that can be set on this voice. The value for this argument must be between <see cref="F:SharpDX.XAudio2.XAudio2.MinimumFrequencyRatio"/> and <see cref="F:SharpDX.XAudio2.XAudio2.MaximumFrequencyRatio"/>. Subsequent calls to <see cref="M:SharpDX.XAudio2.SourceVoice.SetFrequencyRatio(System.Single,System.Int32)"/> are clamped between <see cref="F:SharpDX.XAudio2.XAudio2.MinimumFrequencyRatio"/> and MaxFrequencyRatio. <para>The maximum value for this argument is defined as <see cref="F:SharpDX.XAudio2.XAudio2.MaximumFrequencyRatio"/>, which allows pitch to be raised by up to 10 octaves.</para> <para>If MaxFrequencyRatio is less than 1.0, the voice will use that ratio immediately after being created (rather than the default of 1.0).</para> Xbox 360 <para>For XMA voices, there is one more restriction on the MaxFrequencyRatio argument and the voice's sample rate. The product of these two numbers cannot exceed XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MONO for one-channel voices or XAUDIO2_MAX_RATIO_TIMES_RATE_XMA_MULTICHANNEL for voices with any other number of channels. If the value specified for MaxFrequencyRatio is too high for the specified format, the call to CreateSourceVoice fails and produces a debug message.</para> Note You can use the lowest possible MaxFrequencyRatio value to reduce XAudio2's memory usage.</param>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<param name="callbackRef">[in, optional] Pointer to a client-provided callback interface, <see cref="T:SharpDX.XAudio2.VoiceCallback"/>.</param>
<param name="sendListRef">[in, optional] Pointer to a list of <see cref="T:SharpDX.XAudio2.VoiceSendDescriptors"/> structures that describe the set of destination voices for the source voice. If pSendList is <c>null</c>, the send list defaults to a single output to the first mastering voice created.</param>
<param name="effectChainRef">[in, optional] Pointer to a list of <see cref="T:SharpDX.XAudio2.EffectChain"/> structures that describe an effect chain to use in the source voice.</param>
<returns><para> Returns <see cref="F:SharpDX.Result.Ok"/> if successful; otherwise, an error code. </para> <para> See XAudio2 Error Codes for descriptions of XAudio2-specific error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2::CreateSourceVoice']/*"/>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<unmanaged>HRESULT IXAudio2::CreateSourceVoice([Out, Fast] IXAudio2SourceVoice** ppSourceVoice,[In] const void* pSourceFormat,[In] XAUDIO2_VOICE_FLAGS Flags,[In] float MaxFrequencyRatio,[In, Optional] IXAudio2VoiceCallback* pCallback,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
</member>
<member name="M:SharpDX.XAudio2.XAudio2.CreateSubmixVoice(SharpDX.XAudio2.SubmixVoice,System.Int32,System.Int32,SharpDX.XAudio2.VoiceSendFlags,System.Int32,System.Nullable{SharpDX.XAudio2.VoiceSendDescriptors},System.Nullable{SharpDX.XAudio2.EffectChain})">
<summary>
<code>
<see cref="T:SharpDX.Result"/> CreateSubmixVoice( <see cref="T:SharpDX.XAudio2.SubmixVoice"/> **
</code>
Parameters<list>
<item><term>ppSubmixVoice</term><description>[out] On success, returns a reference to the new <see cref="T:SharpDX.XAudio2.SubmixVoice"/> object. </description></item>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<item><term>InputChannels</term><description>[in] Number of channels in the input audio data of the submix voice. <para>InputChannels must be less than or equal to <see cref="F:SharpDX.XAudio2.XAudio2.MaximumAudioChannels"/>.</para>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
</description></item>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<item><term>InputSampleRate</term><description>[in] Sample rate of the input audio data of submix voice. This rate must be a multiple of XAUDIO2_QUANTUM_DENOMINATOR. InputSampleRate must be between <see cref="F:SharpDX.XAudio2.XAudio2.MinimumSampleRate"/> and <see cref="F:SharpDX.XAudio2.XAudio2.MaximumSampleRate"/>. </description></item>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<item><term>Flags</term><description>[in] Flags that specify the behavior of the submix voice. It can be 0 or the following: ValueDescriptionXAUDIO2_VOICE_USEFILTERThe filter effect should be available on this voice.? </description></item>
<item><term>ProcessingStage</term><description>[in] An arbitrary number that specifies when this voice is processed with respect to other submix voices, if the XAudio2 engine is running other submix voices. The voice is processed after all other voices that include a smaller ProcessingStage value and before all other voices that include a larger ProcessingStage value. Voices that include the same ProcessingStage value are processed in any order. A submix voice cannot send to another submix voice with a lower or equal ProcessingStage value. This prevents audio being lost due to a submix cycle. </description></item>
<item><term>pSendList</term><description>[in, optional] Pointer to a list of <see cref="T:SharpDX.XAudio2.VoiceSendDescriptors"/> structures that describe the set of destination voices for the submix voice. If pSendList is <c>null</c>, the send list will default to a single output to the first mastering voice created. </description></item>
<item><term>pEffectChain</term><description>[in, optional] Pointer to a list of <see cref="T:SharpDX.XAudio2.EffectChain"/> structures that describe an effect chain to use in the submix voice. </description></item>
</list>
Return Value <para> Returns <see cref="F:SharpDX.Result.Ok"/> if successful; otherwise, an error code. </para>
<para> See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.</para>
</summary>
<param name="submixVoiceOut">[out] On success, returns a reference to the new <see cref="T:SharpDX.XAudio2.SubmixVoice"/> object.</param>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<param name="inputChannels">[in] Number of channels in the input audio data of the submix voice. <para>InputChannels must be less than or equal to <see cref="F:SharpDX.XAudio2.XAudio2.MaximumAudioChannels"/>.</para></param>
<param name="inputSampleRate">[in] Sample rate of the input audio data of submix voice. This rate must be a multiple of XAUDIO2_QUANTUM_DENOMINATOR. InputSampleRate must be between <see cref="F:SharpDX.XAudio2.XAudio2.MinimumSampleRate"/> and <see cref="F:SharpDX.XAudio2.XAudio2.MaximumSampleRate"/>.</param>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<param name="flags">[in] Flags that specify the behavior of the submix voice. It can be 0 or the following: ValueDescriptionXAUDIO2_VOICE_USEFILTERThe filter effect should be available on this voice.?</param>
<param name="processingStage">[in] An arbitrary number that specifies when this voice is processed with respect to other submix voices, if the XAudio2 engine is running other submix voices. The voice is processed after all other voices that include a smaller ProcessingStage value and before all other voices that include a larger ProcessingStage value. Voices that include the same ProcessingStage value are processed in any order. A submix voice cannot send to another submix voice with a lower or equal ProcessingStage value. This prevents audio being lost due to a submix cycle.</param>
<param name="sendListRef">[in, optional] Pointer to a list of <see cref="T:SharpDX.XAudio2.VoiceSendDescriptors"/> structures that describe the set of destination voices for the submix voice. If pSendList is <c>null</c>, the send list will default to a single output to the first mastering voice created.</param>
<param name="effectChainRef">[in, optional] Pointer to a list of <see cref="T:SharpDX.XAudio2.EffectChain"/> structures that describe an effect chain to use in the submix voice.</param>
<returns><para> Returns <see cref="F:SharpDX.Result.Ok"/> if successful; otherwise, an error code. </para> <para> See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2::CreateSubmixVoice']/*"/>
<unmanaged>HRESULT IXAudio2::CreateSubmixVoice([Out, Fast] IXAudio2SubmixVoice** ppSubmixVoice,[In] unsigned int InputChannels,[In] unsigned int InputSampleRate,[In] XAUDIO2_VOICE_SEND_FLAGS Flags,[In] unsigned int ProcessingStage,[In, Optional] const XAUDIO2_VOICE_SENDS* pSendList,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.CreateMasteringVoice(SharpDX.XAudio2.MasteringVoice,System.Int32,System.Int32,System.Int32,System.String,System.Nullable{SharpDX.XAudio2.EffectChain},SharpDX.Multimedia.AudioStreamCategory)">
<summary>
Creates and configures a mastering voice.
</summary>
<param name="masteringVoiceOut">[out] If successful, returns a reference to the new <see cref="T:SharpDX.XAudio2.MasteringVoice"/> object.</param>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<param name="inputChannels">[in] Number of channels the mastering voice expects in its input audio. <para>InputChannels must be less than or equal to <see cref="F:SharpDX.XAudio2.XAudio2.MaximumAudioChannels"/>.</para> <para>InputChannels can be set to <see cref="F:SharpDX.XAudio2.XAudio2.DefaultChannels"/>, with the default being determined by the current platform.</para> Windows <para>Attempts to detect the system speaker configuration setup.</para> Xbox 360 <para>Defaults to 5.1 surround.</para></param>
<param name="inputSampleRate">[in] Sample rate of the input audio data of the mastering voice. This rate must be a multiple of XAUDIO2_QUANTUM_DENOMINATOR. <para>InputSampleRate must be between <see cref="F:SharpDX.XAudio2.XAudio2.MinimumSampleRate"/> and <see cref="F:SharpDX.XAudio2.XAudio2.MaximumSampleRate"/>.</para> <para>InputSampleRate can be set to <see cref="F:SharpDX.XAudio2.XAudio2.DefaultSampleRate"/>, with the default being determined by the current platform.</para> Windows <para>Windows XP defaults to 44100.</para> <para>Windows Vista and Windows 7 default to the setting specified in the Sound Control Panel. The default for this setting is 44100 (or 48000 if required by the driver).</para> Xbox 360 <para>Defaults to 48000.</para></param>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<param name="flags">[in] Flags that specify the behavior of the mastering voice. Must be 0.</param>
<param name="szDeviceId">[in] Index of the output device that will be sent input by the mastering voice. Specifying the default value of 0 causes XAudio2 to select the global default audio device.</param>
<param name="effectChainRef">[in, optional] Pointer to an <see cref="T:SharpDX.XAudio2.EffectChain"/> structure that describe an effect chain to use in the mastering voice, or <c>null</c> to use no effects.</param>
<param name="streamCategory">No documentation.</param>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2::CreateMasteringVoice']/*"/>
<unmanaged>HRESULT IXAudio2::CreateMasteringVoice([Out, Fast] IXAudio2MasteringVoice** ppMasteringVoice,[In] unsigned int InputChannels,[In] unsigned int InputSampleRate,[In] unsigned int Flags,[In, Optional] const wchar_t* szDeviceId,[In, Optional] const XAUDIO2_EFFECT_CHAIN* pEffectChain,[In] AUDIO_STREAM_CATEGORY StreamCategory)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.StartEngine">
<summary>
<code>
<see cref="T:SharpDX.Result"/> StartEngine()
</code>
Return Value<para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.</para>
</summary>
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2::StartEngine']/*"/>
<unmanaged>HRESULT IXAudio2::StartEngine()</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.StopEngine">
<summary>
<code>
void StopEngine()
</code>
Return ValueNone.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2::StopEngine']/*"/>
<unmanaged>void IXAudio2::StopEngine()</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.CommitChanges(System.Int32)">
<summary>
<code>
<see cref="T:SharpDX.Result"/> CommitChanges( UINT32
</code>
Parameters<list>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<item><term>OperationSet</term><description>[in] Identifier of the set of operations to be applied. To commit all pending operations, pass <see cref="F:SharpDX.XAudio2.XAudio2.CommitAll"/>. </description></item>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
</list>
Return Value <para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful; returns an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.</para>
</summary>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<param name="operationSet">[in] Identifier of the set of operations to be applied. To commit all pending operations, pass <see cref="F:SharpDX.XAudio2.XAudio2.CommitAll"/>.</param>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<returns><para>Returns <see cref="F:SharpDX.Result.Ok"/> if successful; returns an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.</para></returns>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2::CommitChanges']/*"/>
<unmanaged>HRESULT IXAudio2::CommitChanges([In] unsigned int OperationSet)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.GetPerformanceData(SharpDX.XAudio2.PerformanceData@)">
<summary>
<code>
void GetPerformanceData( <see cref="T:SharpDX.XAudio2.PerformanceData"/> *
</code>
Parameters<list>
<item><term>pPerfData</term><description>[out] On success, reference to an <see cref="T:SharpDX.XAudio2.PerformanceData"/> structure that is returned. </description></item>
</list>
Return ValueNone.
</summary>
<param name="perfDataRef">[out] On success, reference to an <see cref="T:SharpDX.XAudio2.PerformanceData"/> structure that is returned.</param>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2::GetPerformanceData']/*"/>
<unmanaged>void IXAudio2::GetPerformanceData([Out] XAUDIO2_PERFORMANCE_DATA* pPerfData)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.SetDebugConfiguration(System.Nullable{SharpDX.XAudio2.DebugConfiguration},System.IntPtr)">
<summary>
No documentation.
</summary>
<param name="debugConfigurationRef">Pointer to a <see cref="T:SharpDX.XAudio2.DebugConfiguration"/> structure that contains the new debug configuration.</param>
<param name="reservedRef">No documentation.</param>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2::SetDebugConfiguration']/*"/>
<unmanaged>void IXAudio2::SetDebugConfiguration([In, Optional] const XAUDIO2_DEBUG_CONFIGURATION* pDebugConfiguration,[In, Optional] void* pReserved)</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.XAudio2"/> class.
</summary>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.#ctor(SharpDX.XAudio2.XAudio2Flags,SharpDX.XAudio2.ProcessorSpecifier)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.XAudio2"/> class.
</summary>
<param name="flags">Specify a Debug or Normal XAudio2 instance.</param>
<param name="processorSpecifier">The processor specifier.</param>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.AmplitudeRatioToDecibels(System.Single)">
<summary>
Calculate a decibel from a volume.
</summary>
<param name="volume">The volume.</param>
<returns>a dB value</returns>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.CutoffFrequencyToRadians(System.Single,System.Int32)">
<summary>
Calculate radians from a cutoffs frequency.
</summary>
<param name="cutoffFrequency">The cutoff frequency.</param>
<param name="sampleRate">The sample rate.</param>
<returns>radian</returns>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.RadiansToCutoffFrequency(System.Single,System.Single)">
<summary>
Calculate a cutoff frequency from a radian.
</summary>
<param name="radians">The radians.</param>
<param name="sampleRate">The sample rate.</param>
<returns>cutoff frequency</returns>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.DecibelsToAmplitudeRatio(System.Single)">
<summary>
Calculate a volume from a decibel
</summary>
<param name="decibels">a dB value</param>
<returns>an amplitude value</returns>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.FrequencyRatioToSemitones(System.Single)">
<summary>
Calculate semitones from a Frequency ratio
</summary>
<param name="frequencyRatio">The frequency ratio.</param>
<returns>semitones</returns>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.SemitonesToFrequencyRatio(System.Single)">
<summary>
Calculate frequency from semitones.
</summary>
<param name="semitones">The semitones.</param>
<returns>the frequency</returns>
</member>
<member name="M:SharpDX.XAudio2.XAudio2.CommitChanges">
<summary>
Atomically applies a set of operations for all pending operations.
</summary>
<unmanaged>HRESULT IXAudio2::CommitChanges([None] UINT32 OperationSet)</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.XAudio2.PerformanceData">
<summary>
<code>
void GetPerformanceData( <see cref="T:SharpDX.XAudio2.PerformanceData"/> *
</code>
Parameters<list>
<item><term>pPerfData</term><description>[out] On success, reference to an <see cref="T:SharpDX.XAudio2.PerformanceData"/> structure that is returned. </description></item>
</list>
Return ValueNone.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXAudio2::GetPerformanceData']/*"/>
<unmanaged>GetPerformanceData</unmanaged>
<unmanaged>void IXAudio2::GetPerformanceData([Out] XAUDIO2_PERFORMANCE_DATA* pPerfData)</unmanaged>
</member>
<member name="E:SharpDX.XAudio2.XAudio2.ProcessingPassStart">
<summary>
Called by XAudio2 just before an audio processing pass begins.
</summary>
</member>
<member name="E:SharpDX.XAudio2.XAudio2.ProcessingPassEnd">
<summary>
Called by XAudio2 just after an audio processing pass ends.
</summary>
</member>
<member name="E:SharpDX.XAudio2.XAudio2.CriticalError">
<summary>
Called if a critical system error occurs that requires XAudio2 to be closed down and restarted.
</summary>
</member>
<member name="T:SharpDX.XAudio2.BufferWma">
<summary>
IXAudio2SourceVoice::SubmitSourceBuffer
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_BUFFER_WMA']/*"/>
<unmanaged>XAUDIO2_BUFFER_WMA</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.BufferWma.DecodedPacketCumulativeBytesPointer">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_BUFFER_WMA::pDecodedPacketCumulativeBytes']/*"/>
<unmanaged>const unsigned int* pDecodedPacketCumulativeBytes</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.BufferWma.PacketCount">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_BUFFER_WMA::PacketCount']/*"/>
<unmanaged>unsigned int PacketCount</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.DebugConfiguration">
<summary>
SetDebugConfiguration
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_DEBUG_CONFIGURATION']/*"/>
<unmanaged>XAUDIO2_DEBUG_CONFIGURATION</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.DebugConfiguration.TraceMask">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_DEBUG_CONFIGURATION::TraceMask']/*"/>
<unmanaged>unsigned int TraceMask</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.DebugConfiguration.BreakMask">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_DEBUG_CONFIGURATION::BreakMask']/*"/>
<unmanaged>unsigned int BreakMask</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.DebugConfiguration.LogThreadID">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_DEBUG_CONFIGURATION::LogThreadID']/*"/>
<unmanaged>BOOL LogThreadID</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.DebugConfiguration.LogFileline">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_DEBUG_CONFIGURATION::LogFileline']/*"/>
<unmanaged>BOOL LogFileline</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.DebugConfiguration.LogFunctionName">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_DEBUG_CONFIGURATION::LogFunctionName']/*"/>
<unmanaged>BOOL LogFunctionName</unmanaged>
</member>
<member name="P:SharpDX.XAudio2.DebugConfiguration.LogTiming">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_DEBUG_CONFIGURATION::LogTiming']/*"/>
<unmanaged>BOOL LogTiming</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.EffectChain">
<summary>
<code>
typedef struct <see cref="T:SharpDX.XAudio2.EffectChain"/> { UINT32 EffectCount; <see cref="T:SharpDX.XAudio2.EffectDescriptor"/> *pEffectDescriptors;
} <see cref="T:SharpDX.XAudio2.EffectChain"/>;
</code>
Members<list>
<item><term>EffectCount</term><description> Number of effects in the effect chain for the voice. </description></item>
<item><term>pEffectDescriptors</term><description> Array of <see cref="T:SharpDX.XAudio2.EffectDescriptor"/> structures containing references to XAPO instances. </description></item>
</list>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_EFFECT_CHAIN']/*"/>
<unmanaged>XAUDIO2_EFFECT_CHAIN</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.EffectChain.EffectCount">
<summary>
Number of effects in the effect chain for the voice.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_EFFECT_CHAIN::EffectCount']/*"/>
<unmanaged>unsigned int EffectCount</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.EffectChain.EffectDescriptorPointer">
<summary>
Array of <see cref="T:SharpDX.XAudio2.EffectDescriptor"/> structures containing references to XAPO instances.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_EFFECT_CHAIN::pEffectDescriptors']/*"/>
<unmanaged>XAUDIO2_EFFECT_DESCRIPTOR* pEffectDescriptors</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.FilterParameters">
<summary>
<code>
typedef struct <see cref="T:SharpDX.XAudio2.FilterParameters"/> { <see cref="T:SharpDX.XAudio2.FilterType"/> Type; float Frequency; float OneOverQ;
} <see cref="T:SharpDX.XAudio2.FilterParameters"/>;
</code>
Members<list>
<item><term>Type</term><description> An <see cref="T:SharpDX.XAudio2.FilterType"/> indicating whether the filter is low pass, band pass, high pass, or notch. </description></item>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<item><term>Frequency</term><description> Filter radian frequency calculated as (2 * sin(pi * (desired filter cutoff frequency) / sampleRate)). The frequency must be greater than or equal to 0 and less than or equal to <see cref="F:SharpDX.XAudio2.XAudio2.MaximumFilterFrequency"/>. The maximum frequency allowable is equal to the source sound's sample rate divided by six which corresponds to the maximum filter radian frequency of 1. For example, if a sound's sample rate is 48000 and the desired cutoff frequency is the maximum allowable value for that sample rate, 8000, the value for Frequency will be 1. <para>If XAUDIO2_HELPER_FUNCTIONS is defined, XAudio2.h will include the XAudio2RadiansToCutoffFrequency and XAudio2CutoffFrequencyToRadians helper functions for converting between hertz and radian frequencies.</para>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
</description></item>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<item><term>OneOverQ</term><description> Reciprocal of Q factor. Controls how quickly frequencies beyond Frequency are dampened. Larger values result in quicker dampening while smaller values cause dampening to occur more gradually. Must be greater than 0 and less than or equal to <see cref="F:SharpDX.XAudio2.XAudio2.MaximumFilterOneOverQ"/>. </description></item>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
</list>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_FILTER_PARAMETERS']/*"/>
<unmanaged>XAUDIO2_FILTER_PARAMETERS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.FilterParameters.Type">
<summary>
An <see cref="T:SharpDX.XAudio2.FilterType"/> indicating whether the filter is low pass, band pass, high pass, or notch.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_FILTER_PARAMETERS::Type']/*"/>
<unmanaged>XAUDIO2_FILTER_TYPE Type</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.FilterParameters.Frequency">
<summary>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
Filter radian frequency calculated as (2 * sin(pi * (desired filter cutoff frequency) / sampleRate)). The frequency must be greater than or equal to 0 and less than or equal to <see cref="F:SharpDX.XAudio2.XAudio2.MaximumFilterFrequency"/>. The maximum frequency allowable is equal to the source sound's sample rate divided by six which corresponds to the maximum filter radian frequency of 1. For example, if a sound's sample rate is 48000 and the desired cutoff frequency is the maximum allowable value for that sample rate, 8000, the value for Frequency will be 1. <para>If XAUDIO2_HELPER_FUNCTIONS is defined, XAudio2.h will include the XAudio2RadiansToCutoffFrequency and XAudio2CutoffFrequencyToRadians helper functions for converting between hertz and radian frequencies.</para>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_FILTER_PARAMETERS::Frequency']/*"/>
<unmanaged>float Frequency</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.FilterParameters.OneOverQ">
<summary>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
Reciprocal of Q factor. Controls how quickly frequencies beyond Frequency are dampened. Larger values result in quicker dampening while smaller values cause dampening to occur more gradually. Must be greater than 0 and less than or equal to <see cref="F:SharpDX.XAudio2.XAudio2.MaximumFilterOneOverQ"/>.
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_FILTER_PARAMETERS::OneOverQ']/*"/>
<unmanaged>float OneOverQ</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.PerformanceData">
<summary>
<code>
typedef struct <see cref="T:SharpDX.XAudio2.PerformanceData"/> { UINT64 AudioCyclesSinceLastQuery; UINT64 TotalCyclesSinceLastQuery; UINT32 MinimumCyclesPerQuantum; UINT32 MaximumCyclesPerQuantum; UINT32 MemoryUsageInBytes; UINT32 CurrentLatencyInSamples; UINT32 GlitchesSinceEngineStarted; UINT32 ActiveSourceVoiceCount; UINT32 TotalSourceVoiceCount; UINT32 ActiveSubmixVoiceCount; UINT32 ActiveResamplerCount; UINT32 ActiveMatrixMixCount; UINT32 ActiveXmaSourceVoices; UINT32 ActiveXmaStreams;
} <see cref="T:SharpDX.XAudio2.PerformanceData"/>;
</code>
Members<list>
<item><term>AudioCyclesSinceLastQuery</term><description> CPU cycles spent on audio processing since the last call to the <see cref="M:SharpDX.XAudio2.XAudio2.StartEngine"/> or <see cref="M:SharpDX.XAudio2.XAudio2.GetPerformanceData(SharpDX.XAudio2.PerformanceData@)"/> function. </description></item>
<item><term>TotalCyclesSinceLastQuery</term><description> Total CPU cycles elapsed since the last call. Note This only counts cycles on the CPU on which XAudio2 is running. </description></item>
<item><term>MinimumCyclesPerQuantum</term><description> Fewest CPU cycles spent on processing any single audio quantum since the last call. </description></item>
<item><term>MaximumCyclesPerQuantum</term><description> Most CPU cycles spent on processing any single audio quantum since the last call. </description></item>
<item><term>MemoryUsageInBytes</term><description> Total memory currently in use. </description></item>
<item><term>CurrentLatencyInSamples</term><description> Minimum delay that occurs between the time a sample is read from a source buffer and the time it reaches the speakers. Windows <para>The delay reported is a variable value equal to the rough distance between the last sample submitted to the driver by XAudio2 and the sample currently playing. The following factors can affect the delay: playing multichannel audio on a hardware-accelerated device; the type of audio device (WavePci, WaveCyclic, or WaveRT); and, to a lesser extent, audio hardware implementation.</para>
Xbox 360 <para>The delay reported is a fixed value, which is normally 1,024 samples (21.333 ms at 48 kHz). If XOverrideSpeakerConfig has been called using the XAUDIOSPEAKERCONFIG_LOW_LATENCY flag, the delay reported is 512 samples (10.667 ms at 48 kHz).</para>
</description></item>
<item><term>GlitchesSinceEngineStarted</term><description> Total audio dropouts since the engine started. </description></item>
<item><term>ActiveSourceVoiceCount</term><description> Number of source voices currently playing. </description></item>
<item><term>TotalSourceVoiceCount</term><description> Total number of source voices currently in existence. </description></item>
<item><term>ActiveSubmixVoiceCount</term><description> Number of submix voices currently playing. </description></item>
<item><term>ActiveResamplerCount</term><description> Number of resampler xAPOs currently active. </description></item>
<item><term>ActiveMatrixMixCount</term><description> Number of matrix mix xAPOs currently active. </description></item>
<item><term>ActiveXmaSourceVoices</term><description> Windows <para>Unsupported.</para>
Xbox 360 <para>Number of source voices decoding XMA data.</para>
</description></item>
<item><term>ActiveXmaStreams</term><description> Windows <para>Unsupported.</para>
Xbox 360 <para>A voice can use more than one XMA stream.</para>
</description></item>
</list>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA']/*"/>
<unmanaged>XAUDIO2_PERFORMANCE_DATA</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PerformanceData.AudioCyclesSinceLastQuery">
<summary>
CPU cycles spent on audio processing since the last call to the <see cref="M:SharpDX.XAudio2.XAudio2.StartEngine"/> or <see cref="M:SharpDX.XAudio2.XAudio2.GetPerformanceData(SharpDX.XAudio2.PerformanceData@)"/> function.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA::AudioCyclesSinceLastQuery']/*"/>
<unmanaged>unsigned longlong AudioCyclesSinceLastQuery</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PerformanceData.TotalCyclesSinceLastQuery">
<summary>
Total CPU cycles elapsed since the last call. Note This only counts cycles on the CPU on which XAudio2 is running.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA::TotalCyclesSinceLastQuery']/*"/>
<unmanaged>unsigned longlong TotalCyclesSinceLastQuery</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PerformanceData.MinimumCyclesPerQuantum">
<summary>
Fewest CPU cycles spent on processing any single audio quantum since the last call.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA::MinimumCyclesPerQuantum']/*"/>
<unmanaged>unsigned int MinimumCyclesPerQuantum</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PerformanceData.MaximumCyclesPerQuantum">
<summary>
Most CPU cycles spent on processing any single audio quantum since the last call.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA::MaximumCyclesPerQuantum']/*"/>
<unmanaged>unsigned int MaximumCyclesPerQuantum</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PerformanceData.MemoryUsageInBytes">
<summary>
Total memory currently in use.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA::MemoryUsageInBytes']/*"/>
<unmanaged>unsigned int MemoryUsageInBytes</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PerformanceData.CurrentLatencyInSamples">
<summary>
Minimum delay that occurs between the time a sample is read from a source buffer and the time it reaches the speakers. Windows <para>The delay reported is a variable value equal to the rough distance between the last sample submitted to the driver by XAudio2 and the sample currently playing. The following factors can affect the delay: playing multichannel audio on a hardware-accelerated device; the type of audio device (WavePci, WaveCyclic, or WaveRT); and, to a lesser extent, audio hardware implementation.</para>
Xbox 360 <para>The delay reported is a fixed value, which is normally 1,024 samples (21.333 ms at 48 kHz). If XOverrideSpeakerConfig has been called using the XAUDIOSPEAKERCONFIG_LOW_LATENCY flag, the delay reported is 512 samples (10.667 ms at 48 kHz).</para>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA::CurrentLatencyInSamples']/*"/>
<unmanaged>unsigned int CurrentLatencyInSamples</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PerformanceData.GlitchesSinceEngineStarted">
<summary>
Total audio dropouts since the engine started.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA::GlitchesSinceEngineStarted']/*"/>
<unmanaged>unsigned int GlitchesSinceEngineStarted</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PerformanceData.ActiveSourceVoiceCount">
<summary>
Number of source voices currently playing.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA::ActiveSourceVoiceCount']/*"/>
<unmanaged>unsigned int ActiveSourceVoiceCount</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PerformanceData.TotalSourceVoiceCount">
<summary>
Total number of source voices currently in existence.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA::TotalSourceVoiceCount']/*"/>
<unmanaged>unsigned int TotalSourceVoiceCount</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PerformanceData.ActiveSubmixVoiceCount">
<summary>
Number of submix voices currently playing.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA::ActiveSubmixVoiceCount']/*"/>
<unmanaged>unsigned int ActiveSubmixVoiceCount</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PerformanceData.ActiveResamplerCount">
<summary>
Number of resampler xAPOs currently active.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA::ActiveResamplerCount']/*"/>
<unmanaged>unsigned int ActiveResamplerCount</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PerformanceData.ActiveMatrixMixCount">
<summary>
Number of matrix mix xAPOs currently active.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA::ActiveMatrixMixCount']/*"/>
<unmanaged>unsigned int ActiveMatrixMixCount</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PerformanceData.ActiveXmaSourceVoices">
<summary>
Windows <para>Unsupported.</para>
Xbox 360 <para>Number of source voices decoding XMA data.</para>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA::ActiveXmaSourceVoices']/*"/>
<unmanaged>unsigned int ActiveXmaSourceVoices</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.PerformanceData.ActiveXmaStreams">
<summary>
Windows <para>Unsupported.</para>
Xbox 360 <para>A voice can use more than one XMA stream.</para>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_PERFORMANCE_DATA::ActiveXmaStreams']/*"/>
<unmanaged>unsigned int ActiveXmaStreams</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.VoiceDetails">
<summary>
<code>
typedef struct <see cref="T:SharpDX.XAudio2.VoiceDetails"/> { UINT32 CreationFlags; UINT32 ActiveFlags; UINT32 InputChannels; UINT32 InputSampleRate;
} <see cref="T:SharpDX.XAudio2.VoiceDetails"/>;
</code>
Members<list>
<item><term>CreationFlags</term><description> Flags used to create the voice; see the individual voice interfaces for more information. </description></item>
<item><term>ActiveFlags</term><description> Flags that are currently set on the voice. </description></item>
<item><term>InputChannels</term><description> The number of input channels the voice expects. </description></item>
<item><term>InputSampleRate</term><description> The input sample rate the voice expects. </description></item>
</list>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_DETAILS']/*"/>
<unmanaged>XAUDIO2_VOICE_DETAILS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.VoiceDetails.CreationFlags">
<summary>
Flags used to create the voice; see the individual voice interfaces for more information.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_DETAILS::CreationFlags']/*"/>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<unmanaged>XAUDIO2_VOICE_FLAGS CreationFlags</unmanaged>
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
</member>
<member name="F:SharpDX.XAudio2.VoiceDetails.ActiveFlags">
<summary>
Flags that are currently set on the voice.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_DETAILS::ActiveFlags']/*"/>
<unmanaged>unsigned int ActiveFlags</unmanaged>
</member>
added SharpDX Windows 8 binaries (v2.0.4)
2012-02-18 13:10:55 +00:00
<member name="F:SharpDX.XAudio2.VoiceDetails.InputChannelCount">
added Win8 assemblies of SharpDX to lib folder
2011-12-05 18:01:06 +00:00
<summary>
The number of input channels the voice expects.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_DETAILS::InputChannels']/*"/>
<unmanaged>unsigned int InputChannels</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.VoiceDetails.InputSampleRate">
<summary>
The input sample rate the voice expects.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_DETAILS::InputSampleRate']/*"/>
<unmanaged>unsigned int InputSampleRate</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.VoiceSendDescriptor">
<summary>
<code>
typedef struct <see cref="T:SharpDX.XAudio2.VoiceSendDescriptor"/> { UINT32 Flags; <see cref="T:SharpDX.XAudio2.Voice"/> *pOutputVoice;
} <see cref="T:SharpDX.XAudio2.VoiceSendDescriptor"/>;
</code>
Members<list>
<item><term>Flags</term><description> Indicates whether a filter should be used on data sent to the voice pointed to by pOutputVoice. Flags can be 0 or XAUDIO2_SEND_USEFILTER. </description></item>
<item><term>pOutputVoice</term><description> A reference to an <see cref="T:SharpDX.XAudio2.Voice"/> that will be the target of the send. The pOutputVoice member cannot be <c>null</c>. </description></item>
</list>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_SEND_DESCRIPTOR']/*"/>
<unmanaged>XAUDIO2_SEND_DESCRIPTOR</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.VoiceSendDescriptor.Flags">
<summary>
Indicates whether a filter should be used on data sent to the voice pointed to by pOutputVoice. Flags can be 0 or XAUDIO2_SEND_USEFILTER.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_SEND_DESCRIPTOR::Flags']/*"/>
<unmanaged>XAUDIO2_VOICE_SEND_FLAGS Flags</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.VoiceSendDescriptor.OutputVoicePointer">
<summary>
A reference to an <see cref="T:SharpDX.XAudio2.Voice"/> that will be the target of the send. The pOutputVoice member cannot be <c>null</c>.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_SEND_DESCRIPTOR::pOutputVoice']/*"/>
<unmanaged>IXAudio2Voice* pOutputVoice</unmanaged>
</member>
<member name="M:SharpDX.XAudio2.VoiceSendDescriptor.#ctor(SharpDX.XAudio2.Voice)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.VoiceSendDescriptor"/> struct.
</summary>
<param name="outputVoice">The output voice.</param>
</member>
<member name="M:SharpDX.XAudio2.VoiceSendDescriptor.#ctor(SharpDX.XAudio2.VoiceSendFlags,SharpDX.XAudio2.Voice)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.VoiceSendDescriptor"/> struct.
</summary>
<param name="flags">The send flags.</param>
<param name="outputVoice">The output voice.</param>
</member>
<member name="P:SharpDX.XAudio2.VoiceSendDescriptor.OutputVoice">
<summary>
Gets or sets the output voice. This parameter cannot be null.
</summary>
<value>The output voice.</value>
</member>
<member name="T:SharpDX.XAudio2.VoiceSendDescriptors">
<summary>
<code>
typedef struct <see cref="T:SharpDX.XAudio2.VoiceSendDescriptors"/> { UINT32 SendCount; <see cref="T:SharpDX.XAudio2.VoiceSendDescriptor"/> *pSends;
} <see cref="T:SharpDX.XAudio2.VoiceSendDescriptors"/>;
</code>
Members<list>
<item><term>SendCount</term><description> Number of voices to receive the output of the voice. An OutputCount value of 0 indicates the voice should not send output to any voices. </description></item>
<item><term>pSends</term><description> Array of <see cref="T:SharpDX.XAudio2.VoiceSendDescriptor"/> structures describing destination voices and the filters that should be used when sending to the voices. This array should contain SendCount elements. If SendCount is 0 pSends should be <c>null</c>. Note that pSends cannot contain the same voice more than once. </description></item>
</list>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_SENDS']/*"/>
<unmanaged>XAUDIO2_VOICE_SENDS</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.VoiceSendDescriptors.SendCount">
<summary>
Number of voices to receive the output of the voice. An OutputCount value of 0 indicates the voice should not send output to any voices.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_SENDS::SendCount']/*"/>
<unmanaged>unsigned int SendCount</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.VoiceSendDescriptors.SendPointer">
<summary>
Array of <see cref="T:SharpDX.XAudio2.VoiceSendDescriptor"/> structures describing destination voices and the filters that should be used when sending to the voices. This array should contain SendCount elements. If SendCount is 0 pSends should be <c>null</c>. Note that pSends cannot contain the same voice more than once.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_SENDS::pSends']/*"/>
<unmanaged>XAUDIO2_SEND_DESCRIPTOR* pSends</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.VoiceState">
<summary>
<code>
typedef struct <see cref="T:SharpDX.XAudio2.VoiceState"/> { void *pCurrentBufferContext; UINT32 BuffersQueued; UINT64 SamplesPlayed;
} <see cref="T:SharpDX.XAudio2.VoiceState"/>;
</code>
Members<list>
<item><term>pCurrentBufferContext</term><description> Pointer to a buffer context provided in the <see cref="T:SharpDX.XAudio2.AudioBuffer"/> that is processed currently, or, if the voice is stopped currently, to the next buffer due to be processed. pCurrentBufferContext is <c>null</c> if there are no buffers in the queue. </description></item>
<item><term>BuffersQueued</term><description> Number of audio buffers currently queued on the voice, including the one that is processed currently. </description></item>
<item><term>SamplesPlayed</term><description> Total number of samples processed by this voice since it last started, or since the last audio stream ended (as marked with the <see cref="F:SharpDX.XAudio2.BufferFlags.EndOfStream"/> flag). This total includes samples played multiple times due to looping. Theoretically, if all audio emitted by the voice up to this time is captured, this parameter would be the length of the audio stream in samples. If you specify <see cref="F:SharpDX.XAudio2.VoiceFlags.Nosamplesplayed"/> when you call <see cref="M:SharpDX.XAudio2.SourceVoice.GetState(System.Int32)"/>, this member won't be calculated, and its value is unspecified on return from <see cref="M:SharpDX.XAudio2.SourceVoice.GetState(System.Int32)"/>. <see cref="M:SharpDX.XAudio2.SourceVoice.GetState(System.Int32)"/> takes about one-third as much time to complete when you specify <see cref="F:SharpDX.XAudio2.VoiceFlags.Nosamplesplayed"/>. </description></item>
</list>
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_STATE']/*"/>
<unmanaged>XAUDIO2_VOICE_STATE</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.VoiceState.Context">
<summary>
Pointer to a buffer context provided in the <see cref="T:SharpDX.XAudio2.AudioBuffer"/> that is processed currently, or, if the voice is stopped currently, to the next buffer due to be processed. pCurrentBufferContext is <c>null</c> if there are no buffers in the queue.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_STATE::pCurrentBufferContext']/*"/>
<unmanaged>void* pCurrentBufferContext</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.VoiceState.BuffersQueued">
<summary>
Number of audio buffers currently queued on the voice, including the one that is processed currently.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_STATE::BuffersQueued']/*"/>
<unmanaged>unsigned int BuffersQueued</unmanaged>
</member>
<member name="F:SharpDX.XAudio2.VoiceState.SamplesPlayed">
<summary>
Total number of samples processed by this voice since it last started, or since the last audio stream ended (as marked with the <see cref="F:SharpDX.XAudio2.BufferFlags.EndOfStream"/> flag). This total includes samples played multiple times due to looping. Theoretically, if all audio emitted by the voice up to this time is captured, this parameter would be the length of the audio stream in samples. If you specify <see cref="F:SharpDX.XAudio2.VoiceFlags.Nosamplesplayed"/> when you call <see cref="M:SharpDX.XAudio2.SourceVoice.GetState(System.Int32)"/>, this member won't be calculated, and its value is unspecified on return from <see cref="M:SharpDX.XAudio2.SourceVoice.GetState(System.Int32)"/>. <see cref="M:SharpDX.XAudio2.SourceVoice.GetState(System.Int32)"/> takes about one-third as much time to complete when you specify <see cref="F:SharpDX.XAudio2.VoiceFlags.Nosamplesplayed"/>.
</summary>
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XAUDIO2_VOICE_STATE::SamplesPlayed']/*"/>
<unmanaged>unsigned longlong SamplesPlayed</unmanaged>
</member>
<member name="T:SharpDX.XAudio2.VoiceShadow">
<summary>
Internal VoiceCallback callback Impl
</summary>
</member>
<member name="M:SharpDX.XAudio2.VoiceShadow.ToIntPtr(SharpDX.XAudio2.VoiceCallback)">
<summary>
Return a pointer to the unamanged version of this callback.
</summary>
<param name="callback">The callback.</param>
<returns>A pointer to a shadow c++ callback</returns>
</member>
<member name="T:SharpDX.XAudio2.Fx.Reverb">
<summary>
A Reverb XAudio2 AudioProcessor.
</summary>
</member>
<member name="M:SharpDX.XAudio2.Fx.Reverb.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.Fx.Reverb"/> class.
</summary>
</member>
<member name="M:SharpDX.XAudio2.Fx.Reverb.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.Fx.Reverb"/> class.
</summary>
</member>
<member name="T:SharpDX.XAudio2.Fx.VolumeMeter">
<summary>
A VolumeMeter XAudio2 AudioProcessor.
</summary>
</member>
<member name="M:SharpDX.XAudio2.Fx.VolumeMeter.#ctor">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.Fx.VolumeMeter"/> class.
</summary>
</member>
<member name="M:SharpDX.XAudio2.Fx.VolumeMeter.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:SharpDX.XAudio2.Fx.VolumeMeter"/> class.
</summary>
</member>
</members>
</doc>
Reference in New Issue Copy Permalink