Settings for the <seecref="T:SharpDX.XACT3.AudioEngine"/>.
</summary>
<summary>
<p>Runtime parameters for initialization of the XACT engine.</p>
</summary>
<!-- Failed to insert some or all of included XML --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS']/*"/>
<dd> Interactive audio and branch event look-ahead time, in milliseconds. This specifies how far ahead the XACT engine will look ahead when determining when to transition to another sound. XACT_ENGINE_LOOKAHEAD_DEFAULT is a good default value to use for this member. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::lookAheadTime']/*"/>
<dd> Buffer containing the global file data. This file is generated when you build an XACT project file. It contains category, variable, and RPC information. <table><tr><th>Xbox 360 </th></tr><tr><td><p>Memory for this member must be allocated using <strong>XMemAlloc</strong> when specifying the XACT_FLAG_ENGINE_CREATE_MANAGEDATA flag.</p></td></tr></table><table><tr><th>Windows </th></tr><tr><td><p>Memory for this member must be allocated using <strong>CoTaskMemAlloc</strong> when specifying the XACT_FLAG_ENGINE_CREATE_MANAGEDATA flag.</p></td></tr></table></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::pGlobalSettingsBuffer']/*"/>
<dd> Size of the data buffer associated with <strong>pGlobalSettingsBuffer.</strong></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::globalSettingsBufferSize']/*"/>
<dd> Flag values indicating how global file data should be handled by XACT. This member can be zero or the value shown in the following table. <table><tr><th>Value</th><th>Description</th></tr><tr><td>XACT_FLAG_ENGINE_CREATE_MANAGEDATA</td><td><p>Indicates that XACT should free the buffer pointed to by <strong>pGlobalSettingsBuffer</strong> when initialization is complete.</p> Note XACT will not attempt to free the memory if the buffer allocation fails. ?</td></tr></table></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::globalSettingsFlags']/*"/>
<dd> Flag values that indicate the attributes of the memory buffer pointed to by <strong>pGlobalSettingsBuffer</strong>. <table><tr><th>Xbox 360 </th></tr><tr><td><p>This member is needed only if XACT_FLAG_ENGINE_CREATE_MANAGEDATA is specified in <strong>globalSettingsFlags</strong>, so that <strong>XMemFree</strong> can receive the correct values when XACT frees the buffer. Otherwise, <strong>globalSettingsAllocAttributes</strong> is ignored.</p><p>These flags should match the <strong>XALLOC_ATTRIBUTES</strong> values that were specified to <strong>XMemAlloc</strong> when the memory buffer pointed to by <strong>pGlobalSettingsBuffer</strong> was allocated.</p></td></tr></table><table><tr><th>Windows </th></tr><tr><td><p>This parameter has no relevance and is ignored.</p></td></tr></table></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::globalSettingsAllocAttributes']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::fileIOCallbacks']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::fnNotificationCallback']/*"/>
<dd> Pointer to the ID for the audio renderer the engine should connect to. <table><tr><th>Xbox 360 </th></tr><tr><td><p>This parameter is undefined.</p></td></tr></table></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::pRendererID']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XAudio2.XAudio2"/> interface used by the engine. If this member is <c>null</c>, the XACT engine will create the XAudio2 object. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::pXAudio2']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XAudio2.MasteringVoice"/> interface, representing the mastering voice that should be used by the XACT engine. If <strong>pXAudio2</strong> is <c>null</c>, this member must also be <c>null</c>. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::pMasteringVoice']/*"/>
Gets or sets the MasteringVoice to use with XACT3 engine.
</summary>
<value>
The MasteringVoice.
</value>
<remarks>
<seecref="P:SharpDX.XACT3.AudioEngineSettings.XAudio2"/> field must also be set to a valid XAudio2 instance.
</remarks>
</member>
<membername="T:SharpDX.XACT3.Cue">
<summary>
<p>Retrieves the properties of the cue.</p><p>[Content-driven]</p>
</summary>
<remarks>
<p><strong>GetProperties</strong> will allocate memory for the <seecref="T:SharpDX.XACT3.CueInstanceProperties"/> structure.</p><table><tr><th>Xbox 360 </th></tr><tr><td><p><strong>GetProperties</strong> performs memory allocation using <strong>XMemAlloc</strong>.</p><p>The caller should free the memory using <strong>XMemFree</strong>. As an example:</p><pre> LPXACT_CUE_INSTANCE_PROPERTIES pCueProperties = <c>null</c>;
if ( FAILED( pCue->GetProperties( &pCueProperties ) ) )
{ // Error
}
XMemFree( pCueProperties, pCueProperties->allocAttributes ); </pre></td></tr></table><table><tr><th>Windows </th></tr><tr><td><p>The caller should free the memory using CoTaskMemAlloc. The caller should free the memory using CoTaskMemFree. As an example:</p><pre> LPXACT_CUE_INSTANCE_PROPERTIES pCueProperties = <c>null</c>;
if ( FAILED( pCue->GetProperties( &pCueProperties ) ) )
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Cue']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.XACT3.Cue"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<p>Plays a prepared cue.</p><p>[Content-driven]</p>
</summary>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Cue::Play']/*"/>
<paramname="flags"><dd>[in] Flag specifying how the cue should be stopped. The flag value may be 0 or the following: <table><tr><th>Value</th><th>Description</th></tr><tr><td><seecref="F:SharpDX.XACT3.StopFlags.Immediate"/></td><td>Indicates the cue should stop immediately, ignoring any release phase or transition specified in the content.?</td></tr></table><table><tr><th>Note </th></tr><tr><td>Specifying a value of 0 causes <strong>Stop</strong> to account for the release phase and/or transition specified in the XACT.</td></tr></table></dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Cue::Stop']/*"/>
<p>Retrieves the current operating state of a cue.</p><p>[Content-driven]</p>
</summary>
<paramname="stateRef"><dd> Flags indicating the state of the cue. The flags are as follows: <table><tr><th>Value</th><th>Description</th></tr><tr><td><seecref="F:SharpDX.XACT3.CueState.Created"/></td><td>Created, but nothing else?</td></tr><tr><td><seecref="F:SharpDX.XACT3.CueState.Preparing"/></td><td>Preparing to play?</td></tr><tr><td><seecref="F:SharpDX.XACT3.CueState.Prepared"/></td><td>Prepared, but not yet played?</td></tr><tr><td><seecref="F:SharpDX.XACT3.CueState.Playing"/></td><td>Playing, but can be paused?</td></tr><tr><td><seecref="F:SharpDX.XACT3.CueState.Stopping"/></td><td>Stopping?</td></tr><tr><td><seecref="F:SharpDX.XACT3.CueState.Stopped"/></td><td>Stopped?</td></tr><tr><td><seecref="F:SharpDX.XACT3.CueState.Paused"/></td><td>Paused?</td></tr></table><table><tr><th>Note </th></tr><tr><td>States represented by these flags are not necessarily mutually exclusive. Therefore, test states using the & (and) operation rather than the == (equals) operation.</td></tr></table></dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</p></returns>
<remarks>
<p>This function informs the caller what activity the cue is performing at the moment the call is made. The state returned from <strong>GetState</strong> indicates only the current condition.</p><p>Only <seecref="F:SharpDX.XACT3.CueState.Paused"/> is used in combination with other state flags. In other words, the <strong>GetState</strong> might return a state value with <seecref="F:SharpDX.XACT3.CueState.Preparing"/> set or <seecref="F:SharpDX.XACT3.CueState.Playing"/> set, but never with both (since both conditions cannot both be true at the same time). However, <strong>GetState</strong> may return a state value with both <seecref="F:SharpDX.XACT3.CueState.Playing"/> and <seecref="F:SharpDX.XACT3.CueState.Paused"/> flags set, to signify that the cue is paused while playing.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Cue::GetState']/*"/>
<returns>Returns <seecref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</returns>
<remarks>
<p><strong><seecref="M:SharpDX.XACT3.Cue.Destroy"/></strong> will synchronously destroy the cue, stopping the playback immediately, and frees resources allocated for the cue.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Cue::Destroy']/*"/>
<p>Sets the volume level that each source channel of the cue should play in each of its destination channels.</p><p>[Content-driven]</p>
</summary>
<paramname="srcChannelCount"><dd>[in] Number of source channels. This must equal the number of emitter channels. </dd></param>
<paramname="dstChannelCount"><dd>[in] Number of destination channels. This must equal the number of final mix channels. </dd></param>
<paramname="matrixCoefficientsRef"><dd>[in] Matrix coefficient table. This is an array that represents the volume level of each source channel present in each destination channel. The source channels are the column index and the destination channels are the row index of the table. The table must have at least <em>uSrcChannelCount</em> * <em>uDstChannelCount</em> elements. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</p></returns>
<remarks>
<p>The <strong>SetMatrixCoefficients</strong> method is primarily used for creating the illusion of the cue being played at some position in 3D space. However, it is recommended to use the XACT methods provided for interacting with X3DAudio instead of calling <strong>SetMatrixCoefficients</strong> directly. The XACT's X3DAudio helper methods handle calculating and applying a cue's matrix coefficients by calling <strong>SetMatrixCoefficients</strong>. See How To: Integrate X3DAudio with XACT for more information.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Cue::SetMatrixCoefficients']/*"/>
<p>Retrieves the corresponding index for a variable name string.</p><p>[Content-driven]</p>
</summary>
<paramname="friendlyName"><dd>[in] String containing the "friendly name" of the variable, as specified in the XACT. </dd></param>
<returns><p>The index of the variable if it exists, or XACTVARIABLEINDEX_INVALID otherwise.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Cue::GetVariableIndex']/*"/>
<msdn-id>ee418385</msdn-id>
<unmanaged>unsigned short IXACT3Cue::GetVariableIndex([In] const char* szFriendlyName)</unmanaged>
<p>Stores a new value to a variable, referenced by its index.</p><p>[Content-driven]</p>
</summary>
<paramname="index"><dd>[in] Assigned index of the variable in which to store <em>nValue</em>. </dd></param>
<paramname="value"><dd>[in] Value to store in the variable. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</p><p>If the variable is private or read-only, <strong>SetVariable</strong> returns XACTENGINE_E_INVALIDVARIABLEINDEX.</p><p>If <em>nValue</em> falls outside of it's assigned range (or XACTVARIABLEVALUE_MIN to XACTVARIABLEVALUE_MAX), <strong>SetVariable</strong> returns E_FAIL. In this case, the variable is clamped within valid range and a warning message is sent to the debugger.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Cue::SetVariable']/*"/>
<msdn-id>ee418391</msdn-id>
<unmanaged>HRESULT IXACT3Cue::SetVariable([In] unsigned short nIndex,[In] float nValue)</unmanaged>
<p>Retrieves the value of a variable by its index.</p><p>[Content-driven]</p>
</summary>
<paramname="index"><dd>[in] Assigned index of the variable to retrieve. </dd></param>
<returns><dd>[out] Pointer to where to store the value currently held by the variable. </dd></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Cue::GetVariable']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Cue::Pause']/*"/>
<p>Retrieves the properties of the cue.</p><p>[Content-driven]</p>
</summary>
<paramname="propertiesOut"><dd>[out] Pointer to an <seecref="T:SharpDX.XACT3.CueInstanceProperties"/> structure that contains the cue properties. </dd></param>
<returns>Returns <seecref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</returns>
<remarks>
<p><strong>GetProperties</strong> will allocate memory for the <seecref="T:SharpDX.XACT3.CueInstanceProperties"/> structure.</p><table><tr><th>Xbox 360 </th></tr><tr><td><p><strong>GetProperties</strong> performs memory allocation using <strong>XMemAlloc</strong>.</p><p>The caller should free the memory using <strong>XMemFree</strong>. As an example:</p><pre> LPXACT_CUE_INSTANCE_PROPERTIES pCueProperties = <c>null</c>;
if ( FAILED( pCue->GetProperties( &pCueProperties ) ) )
{ // Error
}
XMemFree( pCueProperties, pCueProperties->allocAttributes ); </pre></td></tr></table><table><tr><th>Windows </th></tr><tr><td><p>The caller should free the memory using CoTaskMemAlloc. The caller should free the memory using CoTaskMemFree. As an example:</p><pre> LPXACT_CUE_INSTANCE_PROPERTIES pCueProperties = <c>null</c>;
if ( FAILED( pCue->GetProperties( &pCueProperties ) ) )
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Cue::GetProperties']/*"/>
<p>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.</p>
</summary>
<paramname="destinationVoiceRef"><dd>[in] Pointer to a destination <seecref="T:SharpDX.XAudio2.Voice"/> for which to set volume levels. <table><tr><th>Note </th></tr><tr><td>If the voice sends to a single target voice specifying <c>null</c> will cause <strong>SetOutputVoiceMatrix</strong> to operate on that target voice.</td></tr></table></dd></param>
<paramname="sourceChannels"><dd>[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. </dd></param>
<paramname="destinationChannels"><dd>[in] Confirms the input channel count of the destination voice. </dd></param>
<paramname="levelMatrixRef"><dd>[in] Array of [<em>SourceChannels</em> ? <em>DestinationChannels</em>] volume levels sent to the destination voice. The level sent from source channel <em>S</em> to destination channel <em>D</em> is specified in the form <em>pLevelMatrix</em>[<em>SourceChannels</em> ? <em>D</em> + <em>S</em>]. <p>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.</p><table><tr><th>Output</th><th>Left Input</th><th>Right Input</th></tr><tr><td>Left</td><td>1.0</td><td>0.0</td></tr><tr><td>Right</td><td>0.0</td><td>1.0</td></tr><tr><td>Front Center</td><td>0.0</td><td>0.0</td></tr><tr><td>LFE</td><td>0.0</td><td>0.0</td></tr><tr><td>Rear Left</td><td>0.8</td><td>0.0</td></tr><tr><td>Rear Right</td><td>0.0</td><td>0.8</td></tr></table><p>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.</p><p>See Remarks for more information on volume levels.</p></dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</p></returns>
<remarks>
<p>Volume levels are expressed as floating-point amplitude multipliers between -<seecref="F:SharpDX.XAudio2.XAudio2.MaximumVolumeLevel"/> and <seecref="F:SharpDX.XAudio2.XAudio2.MaximumVolumeLevel"/> (-224 to 224), with a maximum gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. Negative levels can be used to invert the audio's phase.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Cue::SetOutputVoiceMatrix']/*"/>
Use <seecref="M:SharpDX.XACT3.Cue.RegisterNotification(SharpDX.XACT3.NotificationType)"/> to register types.
</remarks>
</member>
<membername="P:SharpDX.XACT3.Cue.State">
<summary>
<p>Retrieves the current operating state of a cue.</p><p>[Content-driven]</p>
</summary>
<remarks>
<p>This function informs the caller what activity the cue is performing at the moment the call is made. The state returned from <strong>GetState</strong> indicates only the current condition.</p><p>Only <seecref="F:SharpDX.XACT3.CueState.Paused"/> is used in combination with other state flags. In other words, the <strong>GetState</strong> might return a state value with <seecref="F:SharpDX.XACT3.CueState.Preparing"/> set or <seecref="F:SharpDX.XACT3.CueState.Playing"/> set, but never with both (since both conditions cannot both be true at the same time). However, <strong>GetState</strong> may return a state value with both <seecref="F:SharpDX.XACT3.CueState.Playing"/> and <seecref="F:SharpDX.XACT3.CueState.Paused"/> flags set, to signify that the cue is paused while playing.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Cue::GetState']/*"/>
<p>Retrieves the properties of the cue.</p><p>[Content-driven]</p>
</summary>
<remarks>
<p><strong>GetProperties</strong> will allocate memory for the <seecref="T:SharpDX.XACT3.CueInstanceProperties"/> structure.</p><table><tr><th>Xbox 360 </th></tr><tr><td><p><strong>GetProperties</strong> performs memory allocation using <strong>XMemAlloc</strong>.</p><p>The caller should free the memory using <strong>XMemFree</strong>. As an example:</p><pre> LPXACT_CUE_INSTANCE_PROPERTIES pCueProperties = <c>null</c>;
if ( FAILED( pCue->GetProperties( &pCueProperties ) ) )
{ // Error
}
XMemFree( pCueProperties, pCueProperties->allocAttributes ); </pre></td></tr></table><table><tr><th>Windows </th></tr><tr><td><p>The caller should free the memory using CoTaskMemAlloc. The caller should free the memory using CoTaskMemFree. As an example:</p><pre> LPXACT_CUE_INSTANCE_PROPERTIES pCueProperties = <c>null</c>;
if ( FAILED( pCue->GetProperties( &pCueProperties ) ) )
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Cue::GetProperties']/*"/>
<p>This section contains information about the methods used with the <seecref="T:SharpDX.XACT3.AudioEngine"/> interface.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.XACT3.AudioEngine"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::GetRendererCount']/*"/>
<p>Retrieves information about a specific renderer.</p><table><tr><th>Xbox 360 </th></tr><tr><td><p>This method is not supported on the Xbox 360 platform.</p></td></tr></table><p>[Content-driven]</p>
</summary>
<paramname="rendererIndex"><dd> Index of the renderer to retrieve information from. </dd></param>
<returns><dd> Pointer to an <seecref="T:SharpDX.XACT3.RendererDetails"/> structure that contains details of the renderer. </dd></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::GetRendererDetails']/*"/>
<msdn-id>ee418403</msdn-id>
<unmanaged>HRESULT IXACT3Engine::GetRendererDetails([In] unsigned short nRendererIndex,[Out] XACT_RENDERER_DETAILS* pRendererDetails)</unmanaged>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::GetFinalMixFormat']/*"/>
<p>Initializes the XACT engine.</p><p>[Content-driven]</p>
</summary>
<paramname="paramsRef"><dd>[in] Pointer to an <seecref="T:SharpDX.XACT3.AudioEngineSettings"/> structure that contains the XACT engine initialization parameters. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<remarks>
<p>This function creates the XACT engine and data structures. It should be called in an application only once per <seecref="T:SharpDX.XACT3.AudioEngine"/> instance.</p><p>If a title passes an instance of the XAudio2 engine to <strong>Initialize</strong> and uses auditioning the XAudio2 mastering voice must have a volume meter XAPO attached to it. See XAudio2CreateVolumeMeter for information on creating the volume meter and SetEffectChain for information on attaching the volume meter.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::Initialize']/*"/>
<p>Shuts down the XACT engine and frees any resources in use.</p><p>[Content-driven]</p>
</summary>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<remarks>
<p>This method destroys all existing cues, sound banks, and wave banks. It blocks until all cues are destroyed. The method also flushes all pending notifications and unregisters all notification descriptions. No XACT API or method calls can be made after calling this function.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::ShutDown']/*"/>
<p>Performs periodic work that is required by the XACT engine.</p><p>[Code-driven]</p><p>[Content-driven]</p>
</summary>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<remarks>
<p>This method drives the XACT engine and is typically called every 30 to 100 milliseconds (about once every one to four frames).</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::DoWork']/*"/>
<p>Creates a sound bank for use by the XACT engine.</p><p>[Content-driven]</p>
</summary>
<paramname="vBufferRef"><dd>[in] Pointer to the data that is used to create the sound bank. <table><tr><th>Xbox 360 </th></tr><tr><td><p>Memory for this member must be allocated by using <strong>XMemAlloc</strong> when specifying the XACT_FLAG_ENGINE_CREATE_MANAGEDATA flag.</p><p>Xbox 360 sound banks must be allocated from physical memory (and not the heap). The XALLOC_MEMTYPE_PHYSICAL memory type must be specified as <em>dwMemoryType</em> when memory is allocated through <strong>XMemAlloc</strong>.</p></td></tr></table><table><tr><th>Windows </th></tr><tr><td><p>Memory for this member must be allocated by using <strong>CoTaskMemAlloc</strong> when specifying the XACT_FLAG_ENGINE_CREATE_MANAGEDATA flag.</p></td></tr></table></dd></param>
<paramname="size"><dd>[in] Value that indicates the size of the data that is used to create the sound bank . </dd></param>
<paramname="flags"><dd>[in] Flag values that indicate how the sound bank is created. This parameter can be zero or the value shown in the following table. <table><tr><th>Value</th><th>Description</th></tr><tr><td>XACT_FLAG_ENGINE_CREATE_MANAGEDATA</td><td><p>Indicates that XACT should free the buffer that the <em>pvBuffer</em> parameter points to, when the sound bank data is released.</p> Note XACT does not attempt to free the memory if the buffer allocation fails. ?</td></tr></table></dd></param>
<paramname="allocAttributes"><dd>[in] Flag values that indicate the attributes of the memory buffer that the <em>pvBuffer</em> parameter points to. <table><tr><th>Xbox 360 </th></tr><tr><td><p>This parameter is needed only if XACT_FLAG_ENGINE_CREATE_MANAGEDATA is specified in <em>dwFlags</em>. This is so that <strong>XMemFree</strong> can receive the correct values when the XACT frees the buffer. Otherwise, <em>dwAllocAttributes</em> is ignored.</p><p>These flags should match the <strong>XALLOC_ATTRIBUTES</strong> values that were specified to <strong>XMemAlloc</strong> when the memory buffer that <em>pvBuffer</em> points to was allocated.</p></td></tr></table><table><tr><th>Windows </th></tr><tr><td><p>This parameter has no relevance and is ignored.</p></td></tr></table></dd></param>
<paramname="soundBankOut"><dd>[out] Pointer to an <seecref="T:SharpDX.XACT3.SoundBank"/> object that is returned. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::CreateSoundBank']/*"/>
<p>Creates an in-memory wave bank for use by the XACT engine.</p><p>[Code-driven]</p><p>[Content-driven]</p>
</summary>
<paramname="vBufferRef"><dd>[in] Pointer to the data that is used to create the wave bank. <table><tr><th>Xbox 360 </th></tr><tr><td><p>Memory for this member must be allocated by using <strong>XMemAlloc</strong> when you specify the XACT_FLAG_ENGINE_CREATE_MANAGEDATA flag.</p><p>Xbox 360 wavebanks must be created with caching enabled. The PAGE_WRITECOMBINE and PAGE_NOCACHE flags must not be used when calling <strong>XMemAlloc</strong>.</p><p>Xbox 360 wavebanks must be allocated from physical memory (and not the heap). The XALLOC_MEMTYPE_PHYSICAL memory type must be specified as <em>dwMemoryType</em> when memory is allocated through <strong>XMemAlloc</strong>.</p></td></tr></table><table><tr><th>Windows </th></tr><tr><td><p>Memory for this member must be allocated by using <strong>CoTaskMemAlloc</strong> when you specify the XACT_FLAG_ENGINE_CREATE_MANAGEDATA flag.</p></td></tr></table></dd></param>
<paramname="size"><dd>[in] Value that indicates the size of the data used to create the wave bank. </dd></param>
<paramname="flags"><dd>[in] Flag values that indicate how the wave bank is created. This parameter can be zero or the value shown in the following table. <table><tr><th>Value</th><th>Description</th></tr><tr><td>XACT_FLAG_ENGINE_CREATE_MANAGEDATA</td><td><p>Indicates that XACT frees the buffer that the <em>pvBuffer</em> parameter points to, when the wave bank data is released.</p> Note XACT does not attempt to free the memory if the buffer allocation fails. ?</td></tr></table></dd></param>
<paramname="allocAttributes"><dd>[in] Flag values that indicate the attributes of the memory buffer that the <em>pvBuffer</em> parameter points to. <table><tr><th>Xbox 360 </th></tr><tr><td><p>This parameter is needed only if XACT_FLAG_ENGINE_CREATE_MANAGEDATA is specified in <em>dwFlags</em>. This is so that <strong>XMemFree</strong> can receive the correct values when the XACT engine frees the buffer. Otherwise, <em>dwAllocAttributes</em> is ignored.</p><p>These flags should match the <strong>XALLOC_ATTRIBUTES</strong> values that were specified to <strong>XMemAlloc</strong> when the memory buffer that <em>pvBuffer</em> points to was allocated.</p></td></tr></table><table><tr><th>Windows </th></tr><tr><td><p>This parameter has no relevance and is ignored.</p></td></tr></table></dd></param>
<paramname="waveBankOut"><dd>[out] Pointer to an <seecref="T:SharpDX.XACT3.WaveBank"/> object that is returned. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::CreateInMemoryWaveBank']/*"/>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<remarks>
<p>Do not use a sound that is associated with a streaming wave bank unless you know that the wave bank is prepared.</p><p>To ascertain that the wave bank is prepared, do one of the following:</p><ul><li><p>Create an XACTNOTIFICATIONTYPE_WAVEBANKPREPARED notification by using <seecref="M:SharpDX.XACT3.AudioEngine.RegisterNotification(SharpDX.XACT3.NotificationType)"/>.</p><p> ?or?</p></li><li><p>Issue a query about the state of the wave bank by using <seecref="M:SharpDX.XACT3.WaveBank.GetState(System.Int32@)"/>. When the XACT_WAVEBANKSTATE_PREPARED bit is set, you can use the wave bank.</p></li></ul>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::CreateStreamingWaveBank']/*"/>
<p>Prepares a wave object from a standard PCM, XMA (Xbox 360) file.</p><p>[Code-driven]</p>
</summary>
<paramname="flags"><dd> Flags that affect wave preparation: <table><tr><th>Value</th><th>Description</th></tr><tr><td>XACT_FLAG_BACKGROUND_MUSIC</td><td>Marks the waves as background music.Xbox 360 This flag is supported only on the Xbox 360 platform. ?</td></tr><tr><td>XACT_FLAG_UNITS_MS</td><td>Indicates that the units passed in are measured in milliseconds.?</td></tr><tr><td>XACT_FLAG_UNITS_SAMPLES</td><td>Indicates that the units passed in are in samples.?</td></tr></table></dd></param>
<paramname="wavePath"><dd> Path to the wave file. </dd></param>
<paramname="streamingPacketSize"><dd> Packet Size, in 2 KB increments. If <em>wStreamingPacketSize</em> is 0, the file is an in-memory wave. A fully prepared wave is returned. For streaming waves, the client needs to call <seecref="M:SharpDX.XACT3.Wave.GetState(SharpDX.XACT3.WaveState@)"/> to ensure that the wave is prepared before playback. Loop region information is read from the wave file. </dd></param>
<paramname="alignment"><dd> Alignment of wave data on the media from which it is streamed. This must be at least 2048. Otherwise, it must be a multiple of 2048. </dd></param>
<paramname="playOffset"><dd> Play offset to use as the start of the wave. The offset can be described in milliseconds or in samples. The <em>dwFlags</em> argument determines the offset units. </dd></param>
<paramname="loopCount"><dd> Number of times to loop the file. If there is no loop region, and the loop count is nonzero, the entire wave is looped. </dd></param>
<paramname="waveOut"><dd> Pointer to an <seecref="T:SharpDX.XACT3.Wave"/> object that is returned. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<remarks>
<p>If this API is used to prepare XMA content, the content must be encoded by using 64K block size.</p><p><strong>PrepareWave</strong> does not support xWMA. xWMA content can be prepared using one of the following methods:</p><ul><li>Prepare</li><li>Prepare</li><li>PrepareInMemoryWave</li><li>PrepareStreamingWave</li></ul>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::PrepareWave']/*"/>
<msdn-id>ee418408</msdn-id>
<unmanaged>HRESULT IXACT3Engine::PrepareWave([In] unsigned int dwFlags,[In] const char* szWavePath,[In] unsigned short wStreamingPacketSize,[In] unsigned int dwAlignment,[In] unsigned int dwPlayOffset,[In] unsigned char nLoopCount,[Out, Fast] IXACT3Wave** ppWave)</unmanaged>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<remarks>
<p>The application must make sure that the any buffers passed in (data, seek table) are valid through the lifetime of this wave.</p><table><tr><th>Xbox 360 </th></tr><tr><td><p>If this API is used to prepare XMA content, the content must be encoded with 64K block size. When using <strong>XMAEncode</strong>, specify "/b 64" on the command line to create 64K blocks.</p></td></tr></table>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::PrepareInMemoryWave']/*"/>
<p>Creates a streaming wave object for the file handle that is passed in.</p><p>[Code-driven]</p>
</summary>
<paramname="flags"><dd> Flags that affect wave preparation: <table><tr><th>Value</th><th>Description</th></tr><tr><td>XACT_FLAG_BACKGROUND_MUSIC</td><td>Marks the waves as background music. Xbox 360 This flag is supported only on the Xbox 360 platform.?</td></tr><tr><td>XACT_FLAG_UNITS_MS</td><td>Indicates that the units passed in are measured in milliseconds.?</td></tr><tr><td>XACT_FLAG_UNITS_SAMPLES</td><td>Indicates that the units passed in are in samples.?</td></tr></table></dd></param>
<paramname="entry"><dd><seecref="T:SharpDX.XACT3.WaveBankEntry"/> structure that describes the format, play region, and loop region for the wave. </dd></param>
<paramname="streamingParams"><dd><seecref="T:SharpDX.XACT3.StreamingParameters"/> structure with a valid file handle, packet size, etc. </dd></param>
<paramname="alignment"><dd> Alignment of wave data on the media from which it is streamed. This must be at least 2048. Otherwise, it must be a multiple of 2048. </dd></param>
<paramname="seekTableRef"><dd> The seek table for XMA content. The first DWORD must be the count of entries in the table that follows it. </dd></param>
<paramname="playOffset"><dd> Play offset to use as the start of the wave. The offset can be described in milliseconds or in samples. The <em>dwFlags</em> argument determines the offset units. </dd></param>
<paramname="loopCount"><dd> Loop count for the wave. </dd></param>
<paramname="waveOut"><dd> Pointer an <seecref="T:SharpDX.XACT3.Wave"/> object that is returned. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<remarks>
<p>If this API is used to prepare XMA content, the content must be encoded with 64K block size. ADPCM files are currently not supported.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::PrepareStreamingWave']/*"/>
<msdn-id>ee418407</msdn-id>
<unmanaged>HRESULT IXACT3Engine::PrepareStreamingWave([In] unsigned int dwFlags,[In] WAVEBANKENTRY entry,[In] XACT_STREAMING_PARAMETERS streamingParams,[In] unsigned int dwAlignment,[In, Optional] unsigned int* pdwSeekTable,[In] unsigned int dwPlayOffset,[In] unsigned char nLoopCount,[Out, Fast] IXACT3Wave** ppWave)</unmanaged>
<p>Registers an event notification.</p><p>[Content-driven]</p>
</summary>
<paramname="notificationDescRef"><dd>[in] Pointer to an <seecref="T:SharpDX.XACT3.RawNotificationDescription"/> structure that describes the notification to register. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::RegisterNotification']/*"/>
<p>Cancels registration of an event notification.</p><p>[Content-driven]</p>
</summary>
<paramname="notificationDescRef"><dd>[in] Pointer to an <seecref="T:SharpDX.XACT3.RawNotificationDescription"/> structure that describes the notification to unregister. <table><tr><th>Note </th></tr><tr><td>Attempting to unregister a notification that has not been registered has no effect.</td></tr></table></dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::UnRegisterNotification']/*"/>
<p>Retrieves the sound category index that corresponds to a friendly name string.</p><p>[Content-driven]</p>
</summary>
<paramname="friendlyName"><dd>[in] Pointer to a buffer that contains the zero-terminated string that describes the category's friendly name. </dd></param>
<returns><p>Returns a category index for the friendly name if successful. Otherwise, XACTCATEGORY_INVALID.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::GetCategory']/*"/>
<msdn-id>ee418398</msdn-id>
<unmanaged>unsigned short IXACT3Engine::GetCategory([In] const char* szFriendlyName)</unmanaged>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::Stop']/*"/>
<unmanaged>HRESULT IXACT3Engine::Stop([In] unsigned short nCategory,[In] XACT_STOP_FLAGS dwFlags)</unmanaged>
<p>Sets the volume of a sound category.</p><p>[Content-driven]</p>
</summary>
<paramname="category"><dd>[in] Index of the category (<strong>XACTCATEGORY</strong>) for which to set the volume, as returned by <seecref="M:SharpDX.XACT3.AudioEngine.GetCategory(System.String)"/>. </dd></param>
<paramname="volume"><dd>[in] Volume level to set. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<remarks>
<p>The volume is a floating point scale where 0.0 means -96db, 1.0 means 0db, and 2.0 means +6db.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::SetVolume']/*"/>
<msdn-id>ee418413</msdn-id>
<unmanaged>HRESULT IXACT3Engine::SetVolume([In] unsigned short nCategory,[In] float nVolume)</unmanaged>
<p>Pauses or resumes playback of a category.</p><p>[Content-driven]</p>
</summary>
<paramname="category"><dd>[in] Index of the category (<strong>XACTCATEGORY</strong>) to pause, as returned by <seecref="M:SharpDX.XACT3.AudioEngine.GetCategory(System.String)"/>. </dd></param>
<paramname="pause"><dd>[in] Action to take. If TRUE, playback is paused. If <seecref="F:SharpDX.Result.False"/>, playback resumes. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<remarks>
<p>A stopping or stopped cue cannot be paused.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::Pause']/*"/>
<p>Retrieves the corresponding index for a global variable name string.</p><p>[Content-driven]</p>
</summary>
<paramname="friendlyName"><dd>[in] String that contains the friendly name of the global variable, as specified in the XACT engine. </dd></param>
<returns><p>The index of the global variable if it exists. Otherwise, XACTVARIABLEINDEX_INVALID.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::GetGlobalVariableIndex']/*"/>
<msdn-id>ee418401</msdn-id>
<unmanaged>unsigned short IXACT3Engine::GetGlobalVariableIndex([In] const char* szFriendlyName)</unmanaged>
<p>Stores a new value to a global variable, which is referenced by its index.</p><p>[Content-driven]</p>
</summary>
<paramname="index"><dd>[in] Assigned index of the global variable in which to store <em>nValue</em>. </dd></param>
<paramname="value"><dd>[in] Value to store in the global variable. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::SetGlobalVariable']/*"/>
<msdn-id>ee418412</msdn-id>
<unmanaged>HRESULT IXACT3Engine::SetGlobalVariable([In] unsigned short nIndex,[In] float nValue)</unmanaged>
<p>Retrieves the value of a global variable by its index.</p><p>[Content-driven]</p>
</summary>
<paramname="index"><dd>[in] Assigned index of the global variable to retrieve. </dd></param>
<returns><dd>[out] Pointer to the location of the value that is currently held by the global variable. </dd></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::GetGlobalVariable']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::GetRendererCount']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Engine::GetFinalMixFormat']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CONTENT_PREPARATION_FLAGS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_FLAG_UNITS_MS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_FLAG_UNITS_SAMPLES']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CREATION_FLAGS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_FLAG_API_AUDITION_MODE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_FLAG_API_DEBUG_MODE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='']/*"/>
<unmanaged>None</unmanaged>
<unmanaged-short>None</unmanaged-short>
</member>
<membername="T:SharpDX.XACT3.CueState">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUE_STATE']/*"/>
<unmanaged>XACT_CUE_STATE</unmanaged>
<unmanaged-short>XACT_CUE_STATE</unmanaged-short>
</member>
<membername="F:SharpDX.XACT3.CueState.Created">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUESTATE_CREATED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUESTATE_PREPARING']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUESTATE_PREPARED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUESTATE_PLAYING']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUESTATE_STOPPING']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUESTATE_STOPPED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUESTATE_PAUSED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_TYPE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_CUEPREPARED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_CUEPLAY']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_CUESTOP']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_CUEDESTROYED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_MARKER']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_SOUNDBANKDESTROYED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVEBANKDESTROYED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_LOCALVARIABLECHANGED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_GLOBALVARIABLECHANGED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_GUICONNECTED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_GUIDISCONNECTED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVEPREPARED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVEPLAY']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVESTOP']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVELOOPED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVEDESTROYED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVEBANKPREPARED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVEBANKSTREAMING_INVALIDCONTENT']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_STOP_FLAGS']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_FLAG_CUE_STOP_RELEASE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_FLAG_CUE_STOP_IMMEDIATE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKMINIFORMAT_TAG']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKMINIFORMAT_TAG_PCM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKMINIFORMAT_TAG_XMA']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKMINIFORMAT_TAG_ADPCM']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKMINIFORMAT_TAG_WMA']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKSEGIDX']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANK_SEGIDX_BANKDATA']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANK_SEGIDX_ENTRYMETADATA']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANK_SEGIDX_SEEKTABLES']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANK_SEGIDX_ENTRYNAMES']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANK_SEGIDX_ENTRYWAVEDATA']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANK_SEGIDX_COUNT']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_WAVE_STATE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_STATE_CREATED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_STATE_PREPARING']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_STATE_PREPARED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_STATE_PLAYING']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_STATE_STOPPING']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_STATE_STOPPED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_STATE_PAUSED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_STATE_INUSE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='MACRO_XACT_STATE_PREPAREFAILED']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='SharpDX.XACT3.XACT3']/*"/>
</member>
<membername="T:SharpDX.XACT3.SoundBank">
<summary>
<p>Plays a cue. Optionally, returns an instance handle to the cue object for further control.</p><p>[Content-driven]</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3SoundBank']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.XACT3.SoundBank"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<p>Retrieves a sound cue index based on a string that represents the friendly name of the cue.</p><p>[Content-driven]</p>
</summary>
<paramname="friendlyName"><dd>[in] <c>null</c>-terminated string that represents the friendly name of a cue in the sound bank. <table><tr><th>Note </th></tr><tr><td>This string is case sensitive.</td></tr></table></dd></param>
<returns><p>Returns the cue index that is associated with <strong>szFriendlyName</strong>. If the cue index is not found, XACTINDEX_INVALID is returned.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3SoundBank::GetCueIndex']/*"/>
<p>Retrieves the number of cues in the sound bank.</p><p>[Content-driven]</p>
</summary>
<paramname="numCuesRef"><dd> Pointer to an XACTINDEX that returns the number of cues. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. If unsuccessful, an error code is returned.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3SoundBank::GetNumCues']/*"/>
<p>Retrieves the properties of a cue.</p><p>[Content-driven]</p>
</summary>
<paramname="cueIndex"><dd> Index of the cue to query. </dd></param>
<returns><dd> Pointer to an <seecref="T:SharpDX.XACT3.CueProperties"/> structure that receives the cue properties. </dd></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3SoundBank::GetCueProperties']/*"/>
<msdn-id>ee418419</msdn-id>
<unmanaged>HRESULT IXACT3SoundBank::GetCueProperties([In] unsigned short nCueIndex,[Out] XACT_CUE_PROPERTIES* pProperties)</unmanaged>
<p>Prepares a cue instance for playback.</p><p>[Content-driven]</p>
</summary>
<paramname="cueIndex"><dd>[in] Value that indicates the index of the cue to be prepared. </dd></param>
<paramname="flags"><dd>[in] Unused. Should be 0. </dd></param>
<paramname="timeOffset"><dd>[in] Time offset into the cue to start from, in milliseconds. </dd></param>
<returns><dd>[out] Pointer to the <seecref="T:SharpDX.XACT3.Cue"/> object that is returned. </dd></returns>
<remarks>
<p>This method returns a valid cue instance that is ready to be played. All allocations and stream priming, if necessary, are performed by this method.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3SoundBank::Prepare']/*"/>
<msdn-id>ee418423</msdn-id>
<unmanaged>HRESULT IXACT3SoundBank::Prepare([In] unsigned short nCueIndex,[In] unsigned int dwFlags,[In] int timeOffset,[Out] IXACT3Cue** ppCue)</unmanaged>
<p>Plays a cue. Optionally, returns an instance handle to the cue object for further control.</p><p>[Content-driven]</p>
</summary>
<paramname="cueIndex"><dd>[in] Value that indicates the index of the cue to be played. </dd></param>
<paramname="flags"><dd>[in] Flags to pass to <seecref="M:SharpDX.XACT3.SoundBank.Prepare(System.Int16,System.Int32,System.Int32)"/> for cue playback. </dd></param>
<paramname="timeOffset"><dd>[in] Time offset into the cue to start from, in milliseconds. </dd></param>
<returns><dd>[out, optional] Pointer to the <seecref="T:SharpDX.XACT3.Cue"/> object that is returned. If <c>null</c> is specified, no cue instance object is returned. </dd></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3SoundBank::Play']/*"/>
<unmanaged>HRESULT IXACT3SoundBank::Play([In] unsigned short nCueIndex,[In] unsigned int dwFlags,[In] int timeOffset,[Out, Optional] IXACT3Cue** ppCue)</unmanaged>
<paramname="cueIndex"><dd>[in] Index of the cue to be stopped. <table><tr><th>Note </th></tr><tr><td>All instances of the cue that are specified by <strong>nCueIndex</strong> are stopped.</td></tr></table></dd></param>
<paramname="flags"><dd>[in] Flags affecting how the cue will be stopped. By default, the sound completes the release phase that the content has set up. <table><tr><th>Value</th><th>Description</th></tr><tr><td>XACT_FLAG_SOUNDBANK_STOP_IMMEDIATE</td><td>Cue stops immediately. It ignores any release phase or transition that is specified in the content.?</td></tr></table></dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3SoundBank::Stop']/*"/>
<msdn-id>ee418424</msdn-id>
<unmanaged>HRESULT IXACT3SoundBank::Stop([In] unsigned short nCueIndex,[In] XACT_STOP_FLAGS dwFlags)</unmanaged>
<p>Destroys the sound bank.</p><p>[Content-driven]</p>
</summary>
<returns>Returns <seecref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</returns>
<remarks>
<p><strong><seecref="M:SharpDX.XACT3.SoundBank.Destroy"/></strong> synchronously destroys all cues that are associated with the sound bank. It stops the playback immediately, and frees resources that were allocated to the sound bank.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3SoundBank::Destroy']/*"/>
<p>Retrieves the current state of the sound bank.</p><p>[Content-driven]</p>
</summary>
<paramname="stateRef"><dd>[out] Flags that indicate the state of the sound bank. The flags are as follows: <table><tr><th>Value</th><th>Description</th></tr><tr><td>XACT_SOUNDBANKSTATE_INUSE</td><td>Indicates that the sound bank is referenced by at least one valid cue instance or other client. For example, the game itself might reference the sound bank.?</td></tr></table></dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3SoundBank::GetState']/*"/>
Unregisters this instance to notify for a type of notification.
</summary>
<paramname="notificationType">Type of the notification.</param>
</member>
<membername="P:SharpDX.XACT3.SoundBank.CueCount">
<summary>
<p>Retrieves the number of cues in the sound bank.</p><p>[Content-driven]</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3SoundBank::GetNumCues']/*"/>
Use <seecref="M:SharpDX.XACT3.SoundBank.RegisterNotification(SharpDX.XACT3.NotificationType)"/> to register types.
</remarks>
</member>
<membername="P:SharpDX.XACT3.SoundBank.IsInUse">
<summary>
Gets a value indicating whether this instance is referenced by at least one valid cue instance or other client. For example, the game itself might reference the sound bank.
</summary>
<value>
<c>true</c> if this instance is in use; otherwise, <c>false</c>.
</value>
</member>
<membername="T:SharpDX.XACT3.Wave">
<summary>
<p>Sets the volume value for each output of a wave.</p><p>[Code-driven]</p>
</summary>
<remarks>
<p>The final output volume of any channel is the matrix coefficient volume multiplied by the value that is specified by <seecref="M:SharpDX.XACT3.Wave.SetVolume(System.Single)"/>.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Wave']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.XACT3.Wave"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Wave::Destroy']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Wave::Play']/*"/>
<paramname="flags"><dd> Flags that affect how the wave is stopped: <table><tr><th>Value</th><th>Description</th></tr><tr><td>XACT_FLAG_STOP_RELEASE</td><td>Plays the wave to completion, then stops. For looping waves, this flag plays the current iteration to completion, then stops (ignoring any subsequent iterations). In either case, any release or tail is played. To stop the wave immediately, use the XACT_FLAG_STOP_IMMEDIATE flag.?</td></tr><tr><td>XACT_FLAG_STOP_IMMEDIATE</td><td>Stops the playback immediately.?</td></tr></table></dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Wave::Stop']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Wave::Pause']/*"/>
<p>Returns the state of the wave object.</p><p>[Code-driven]</p>
</summary>
<paramname="stateRef"><dd> Pointer to a DWORD that receives the current wave state. <table><tr><th>Value</th><th>Description</th></tr><tr><td>XACT_STATE_CREATED</td><td>Created, but nothing else.?</td></tr><tr><td>XACT_STATE_PREPARING</td><td>In the middle of preparing.?</td></tr><tr><td>XACT_STATE_PREPARED</td><td>Prepared, but not yet played.?</td></tr><tr><td>XACT_STATE_PLAYING</td><td>Playing, but can be paused.?</td></tr><tr><td>XACT_STATE_STOPPING</td><td>Stopping.?</td></tr><tr><td>XACT_STATE_STOPPED</td><td>Stopped.?</td></tr><tr><td>XACT_STATE_PAUSED</td><td>Paused. Can be combined with some of the other state flags.?</td></tr><tr><td>XACT_STATE_INUSE</td><td>Object is in use. Used by wave banks and sound banks.?</td></tr><tr><td>XACT_STATE_PREPAREFAILED</td><td>Object preparation failed.?</td></tr></table></dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. If unsuccessful, an error code is returned.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Wave::GetState']/*"/>
<p>Sets the pitch of a wave.</p><p>[Code-driven]</p>
</summary>
<paramname="pitch"><dd> XACTPITCH value that is used to set the pitch for playback of this wave. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<remarks>
<p>The value of <em>pitch</em> may be between XACTPITCH_MIN (-1200) and XACTPITCH_MAX (1200), which is approximately one semitone.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Wave::SetPitch']/*"/>
<msdn-id>ee418439</msdn-id>
<unmanaged>HRESULT IXACT3Wave::SetPitch([In] short pitch)</unmanaged>
<p>Sets the volume of a wave.</p><p>[Code-driven]</p>
</summary>
<paramname="volume"><dd> XACTVOLUME value that is used to set the volume for playback of this wave. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Wave::SetVolume']/*"/>
<p>Sets the volume value for each output of a wave.</p><p>[Code-driven]</p>
</summary>
<paramname="srcChannelCount"><dd> Number of source channels. </dd></param>
<paramname="dstChannelCount"><dd> Number of destination channels. </dd></param>
<paramname="matrixCoefficientsRef"><dd> Matrix coefficient table. This is an array that represents the volume level of each source channel that is present in each destination channel. The source channels are represented by the column index of the table. The destination channels are represented by the row index of the table. The table must have at least <em>uSrcChannelCount</em>?<em>uDstChannelCount</em> elements. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<remarks>
<p>The final output volume of any channel is the matrix coefficient volume multiplied by the value that is specified by <seecref="M:SharpDX.XACT3.Wave.SetVolume(System.Single)"/>.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Wave::SetMatrixCoefficients']/*"/>
<msdn-id>ee418438</msdn-id>
<unmanaged>HRESULT IXACT3Wave::SetMatrixCoefficients([In] unsigned int uSrcChannelCount,[In] unsigned int uDstChannelCount,[In, Buffer] float* pMatrixCoefficients)</unmanaged>
<p>Retrieves the properties of the wave object.</p><p>[Code-driven]</p>
</summary>
<paramname="propertiesRef"><dd> Pointer to an <seecref="T:SharpDX.XACT3.WaveInstanceProperties"/> structure that is returned. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Wave::GetProperties']/*"/>
Unregisters this instance to notify for a type of notification.
</summary>
<paramname="notificationType">Type of the notification.</param>
</member>
<membername="P:SharpDX.XACT3.Wave.State">
<summary>
<p>Returns the state of the wave object.</p><p>[Code-driven]</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Wave::GetState']/*"/>
<p>Sets the pitch of a wave.</p><p>[Code-driven]</p>
</summary>
<remarks>
<p>The value of <em>pitch</em> may be between XACTPITCH_MIN (-1200) and XACTPITCH_MAX (1200), which is approximately one semitone.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Wave::SetPitch']/*"/>
<msdn-id>ee418439</msdn-id>
<unmanaged>SetPitch</unmanaged>
<unmanaged-short>SetPitch</unmanaged-short>
<unmanaged>HRESULT IXACT3Wave::SetPitch([In] short pitch)</unmanaged>
</member>
<membername="P:SharpDX.XACT3.Wave.Volume">
<summary>
<p>Sets the volume of a wave.</p><p>[Code-driven]</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Wave::SetVolume']/*"/>
<p>Retrieves the properties of the wave object.</p><p>[Code-driven]</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3Wave::GetProperties']/*"/>
Use <seecref="M:SharpDX.XACT3.Wave.RegisterNotification(SharpDX.XACT3.NotificationType)"/> to register types.
</remarks>
</member>
<membername="T:SharpDX.XACT3.WaveBank">
<summary>
<p>This section contains information about the methods used with the <seecref="T:SharpDX.XACT3.WaveBank"/> interface.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3WaveBank']/*"/>
Performs an explicit conversion from <seecref="T:System.IntPtr"/> to <seecref="T:SharpDX.XACT3.WaveBank"/>. (This method is a shortcut to <seecref="P:SharpDX.CppObject.NativePointer"/>)
<p>Destroys the wave bank.</p><p>[Content-driven]</p>
</summary>
<returns>Returns <seecref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</returns>
<remarks>
<p><strong><seecref="M:SharpDX.XACT3.WaveBank.Destroy"/></strong> synchronously destroys any cues that are using the wavebank. It stops playback immediately, and frees resources that were allocated to the wavebank.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3WaveBank::Destroy']/*"/>
<p>Returns the number of wave entries in the wave bank.</p><p>[Code-driven]</p>
</summary>
<paramname="numWavesRef"><dd> Pointer to an XACTINDEX that returns the number of waves in the wave bank. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3WaveBank::GetNumWaves']/*"/>
<p>Returns the wave index for the friendly name of a wave in a wave bank.</p><p>[Code-driven]</p>
</summary>
<paramname="friendlyName"><dd> Friendly name for the wave within the wave bank. </dd></param>
<returns><p>Wave index for the friendly name of a wave within a wave bank.</p><p>If the wave bank does not contain the friendly name, or if an entry does not exist for the name that is passed in, the method returns XACTINDEX_INVALID.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3WaveBank::GetWaveIndex']/*"/>
<msdn-id>ee418428</msdn-id>
<unmanaged>unsigned short IXACT3WaveBank::GetWaveIndex([In] const char* szFriendlyName)</unmanaged>
<p>Gets the properties of a specific wave in a wave bank.</p><p>[Code-driven]</p>
</summary>
<paramname="waveIndex"><dd> Index of the wave for which to get properties. </dd></param>
<paramname="wavePropertiesRef"><dd> Pointer to an <seecref="T:SharpDX.XACT3.WaveProperties"/> structure that is returned. </dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3WaveBank::GetWaveProperties']/*"/>
<msdn-id>ee418429</msdn-id>
<unmanaged>HRESULT IXACT3WaveBank::GetWaveProperties([In] unsigned short nWaveIndex,[Out] XACT_WAVE_PROPERTIES* pWaveProperties)</unmanaged>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3WaveBank::Prepare']/*"/>
<unmanaged>HRESULT IXACT3WaveBank::Prepare([In] unsigned short nWaveIndex,[In] XACT_CONTENT_PREPARATION_FLAGS dwFlags,[In] unsigned int dwPlayOffset,[In] unsigned char nLoopCount,[Out] IXACT3Wave** ppWave)</unmanaged>
<p>Starts the playback for a wave that is indicated by the wave index.</p><p>[Code-driven]</p>
</summary>
<paramname="waveIndex"><dd> Index of the wave. </dd></param>
<paramname="flags"><dd> Flags that affect wave preparation: <table><tr><th>Value</th><th>Description</th></tr><tr><td>XACT_FLAG_BACKGROUND_MUSIC</td><td>Marks the waves as background music.Xbox 360 This flag is supported only on the Xbox 360 platform.?</td></tr><tr><td>XACT_FLAG_UNITS_MS</td><td>Indicates that the units that are passed in are measured in milliseconds.?</td></tr><tr><td>XACT_FLAG_UNITS_SAMPLES</td><td>Indicates that the units that are passed in are in samples.?</td></tr></table></dd></param>
<paramname="playOffset"><dd> Play offset to use as the start of the wave. The offset can be described in milliseconds or in samples. The <em>dwFlags</em> argument determines the offset units. </dd></param>
<paramname="loopCount"><dd> Number of loops for playback. </dd></param>
<returns><dd> Pointer to an <seecref="T:SharpDX.XACT3.Wave"/> object that is returned. </dd></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3WaveBank::Play']/*"/>
<msdn-id>ee418430</msdn-id>
<unmanaged>HRESULT IXACT3WaveBank::Play([In] unsigned short nWaveIndex,[In] XACT_CONTENT_PREPARATION_FLAGS dwFlags,[In] unsigned int dwPlayOffset,[In] unsigned char nLoopCount,[Out] IXACT3Wave** ppWave)</unmanaged>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3WaveBank::Stop']/*"/>
<unmanaged>HRESULT IXACT3WaveBank::Stop([In] unsigned short nWaveIndex,[In] XACT_STOP_FLAGS dwFlags)</unmanaged>
<p>Retrieves the current state of the wave bank.</p><p>[Content-driven]</p>
</summary>
<paramname="stateRef"><dd>[out] Flags that indicate the state of the wave bank. The flags are as follows: <table><tr><th>Value</th><th>Description</th></tr><tr><td>XACT_WAVEBANKSTATE_INUSE</td><td>Indicates that the wave bank is referenced by at least one valid cue instance or other client. For example, the game itself might reference the wave bank.?</td></tr><tr><td>XACT_WAVEBANKSTATE_PREPARED</td><td>Indicates that the wave is prepared for use by a cue instance.?</td></tr></table></dd></param>
<returns><p>Returns <seecref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3WaveBank::GetState']/*"/>
<!-- Failed to insert some or all of included XML --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3WaveBank::Prepare']/*"/>
<unmanaged>HRESULT IXACT3WaveBank::Prepare([In] unsigned short nWaveIndex,[In] XACT_CONTENT_PREPARATION_FLAGS dwFlags,[In] unsigned int dwPlayOffset,[In] unsigned char nLoopCount,[Out] IXACT3Wave** ppWave)</unmanaged>
<!-- Failed to insert some or all of included XML --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3WaveBank::Play']/*"/>
<unmanaged>HRESULT IXACT3WaveBank::Play([In] unsigned short nWaveIndex,[In] XACT_CONTENT_PREPARATION_FLAGS dwFlags,[In] unsigned int dwPlayOffset,[In] unsigned char nLoopCount,[Out] IXACT3Wave** ppWave)</unmanaged>
</member>
<membername="P:SharpDX.XACT3.WaveBank.WaveCount">
<summary>
<p>Returns the number of wave entries in the wave bank.</p><p>[Code-driven]</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3WaveBank::GetNumWaves']/*"/>
<p>Retrieves the current state of the wave bank.</p><p>[Content-driven]</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='IXACT3WaveBank::GetState']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUE_INSTANCE_PROPERTIES']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUE_INSTANCE_PROPERTIES::allocAttributes']/*"/>
<unmanaged>unsigned int allocAttributes</unmanaged>
<unmanaged-short>unsigned int allocAttributes</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUE_INSTANCE_PROPERTIES::cueProperties']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUE_INSTANCE_PROPERTIES::activeVariationProperties']/*"/>
<p>This structure returns the non-instance specific cue properties for a cue. That is, it returns the properties shared across all instances of a cue.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUE_PROPERTIES']/*"/>
<dd> Friendly name of the cue. If the sound bank does not contain the friendly names, an empty string is returned. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUE_PROPERTIES::friendlyName']/*"/>
<dd> TRUE if the cue is an interactive audio cue and <seecref="F:SharpDX.Result.False"/> otherwise. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUE_PROPERTIES::interactive']/*"/>
<dd> For interactive audio cues, the index of the variable to control the cue. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUE_PROPERTIES::iaVariableIndex']/*"/>
<dd> Number of sound variations for this cue. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUE_PROPERTIES::numVariations']/*"/>
<dd> Maximum number of instances that are allowed for this cue. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUE_PROPERTIES::maxInstances']/*"/>
<dd> Number of currently active instances of this cue. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_CUE_PROPERTIES::currentInstances']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_FILEIO_CALLBACKS']/*"/>
<dd> Pointer to the client (title) implementation of the XACT_READFILE_CALLBACK callback function. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_FILEIO_CALLBACKS::readFileCallback']/*"/>
<dd> Pointer to the client (title) implementation of the XACT_GETOVERLAPPEDRESULT_CALLBACK callback function. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_FILEIO_CALLBACKS::getOverlappedResultCallback']/*"/>
<p>Notification structure for all XACT cue notifications.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_CUE']/*"/>
<dd> Cue index. XACTINDEX_INVALID signifies an invalid cue index. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_CUE::cueIndex']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XACT3.SoundBank"/> instance. This reference is invalid when the notification type is XACTNOTIFICATIONTYPE_CUEDESTROYED. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_CUE::pSoundBank']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XACT3.Cue"/> instance. This reference is invalid when the notification type is XACTNOTIFICATIONTYPE_CUEDESTROYED. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_CUE::pCue']/*"/>
<p>Provides descriptions for registering, unregistering, and flushing notifications.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::type']/*"/>
<dd> Flag that describes the notification behavior. Can be 0 or the following: <table><tr><th>Value</th><th>Description</th></tr><tr><td>XACT_FLAG_NOTIFICATION_PERSIST</td><td>Sets the notification to persist. If this flag is not set, the user receives no more than one notification of the type registered.?</td></tr></table></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::flags']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XACT3.SoundBank"/> instance. If this entry is set to <c>null</c>, the notification applies to all sound banks. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::pSoundBank']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XACT3.WaveBank"/> instance (optional). This entry can be <c>null</c>, if no wave bank applies. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::pWaveBank']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XACT3.Cue"/> instance (optional). This entry can be <c>null</c>, if no cue applies. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::pCue']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XACT3.Wave"/> instance (optional). The entry can be <c>null</c>, if no wave applies. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::pWave']/*"/>
<dd> Cue index. If <strong>pSoundBank</strong> is <c>null</c>, this entry should contain the value XACTINDEX_INVALID. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::cueIndex']/*"/>
<msdn-id>ee419084</msdn-id>
<unmanaged>unsigned short cueIndex</unmanaged>
<unmanaged-short>unsigned short cueIndex</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::waveIndex']/*"/>
<msdn-id>ee419084</msdn-id>
<unmanaged>unsigned short waveIndex</unmanaged>
<unmanaged-short>unsigned short waveIndex</unmanaged-short>
<dd> User context (optional). The entry can be <c>null</c>, if no user context applies. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::pvContext']/*"/>
<msdn-id>ee419084</msdn-id>
<unmanaged>void* pvContext</unmanaged>
<unmanaged-short>void pvContext</unmanaged-short>
</member>
<membername="T:SharpDX.XACT3.RawNotificationGui">
<summary>
<p>Notification structure for all GUI notifications.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_GUI']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_GUI::reserved']/*"/>
<p>Notification structure for all marker notifications.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_MARKER']/*"/>
<dd> Cue index. XACTINDEX_INVALID signifies an invalid cue index. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_MARKER::cueIndex']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XACT3.SoundBank"/> instance. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_MARKER::pSoundBank']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XACT3.Cue"/> instance. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_MARKER::pCue']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_MARKER::marker']/*"/>
<p>Notification structure for all sound bank notifications.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_SOUNDBANK']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XACT3.SoundBank"/> instance. This reference is invalid when the notification type is XACTNOTIFICATIONTYPE_SOUNDBANKDESTROYED. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_SOUNDBANK::pSoundBank']/*"/>
<p>Notification structure for all variable notifications.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_VARIABLE']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_VARIABLE::cueIndex']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_VARIABLE::pSoundBank']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_VARIABLE::pCue']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_VARIABLE::variableIndex']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_VARIABLE::variableValue']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_VARIABLE::local']/*"/>
<p>Notification structure for all wave notifications.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_WAVE']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XACT3.WaveBank"/> instance. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_WAVE::pWaveBank']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_WAVE::waveIndex']/*"/>
<dd> Cue index. XACTINDEX_INVALID signifies an invalid cue index. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_WAVE::cueIndex']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XACT3.SoundBank"/> instance. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_WAVE::pSoundBank']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XACT3.Cue"/> instance. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_WAVE::pCue']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XACT3.Wave"/> instance. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_WAVE::pWave']/*"/>
<p>Notification structure for all wave bank notifications.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_WAVEBANK']/*"/>
<dd> Pointer to the <seecref="T:SharpDX.XACT3.WaveBank"/> instance. This reference is invalid when the notification type is XACTNOTIFICATIONTYPE_WAVEBANKDESTROYED. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_NOTIFICATION_WAVEBANK::pWaveBank']/*"/>
<p>Returns information about a particular renderer.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RENDERER_DETAILS']/*"/>
<dd> Wide character array containing the id of the renderer. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RENDERER_DETAILS::rendererID']/*"/>
<dd> Wide character array that contains the name of the renderer. <table><tr><th>Note </th></tr><tr><td>The friendly name is useful in presenting the audio devices that are available to the end user. However, the renderer id can be passed in the <seecref="T:SharpDX.XACT3.AudioEngineSettings"/> structure?which is used during XACT initialization?to connect to the renderer.</td></tr></table></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RENDERER_DETAILS::displayName']/*"/>
<dd> TRUE if this renderer is the default renderer. Otherwise, <seecref="F:SharpDX.Result.False"/>. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_RENDERER_DETAILS::defaultDevice']/*"/>
<p>Returns the properties for a sound that is referenced by the active variation.</p>
</summary>
<remarks>
<p>The following is an example of iterating through the track properties represented by the <strong>arrTrackProperties</strong> member:</p><pre> void EnumerateTrackProperties(LPXACT_SOUND_PROPERTIES pSoundProperties)
{ for (XACTINDEX nIndex = 0; nIndex < pSoundProperties->numTracks; ++nIndex) { // Do something with pSoundProperties->arrTrackProperties[nIndex]; }
}
</pre>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_SOUND_PROPERTIES']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_SOUND_PROPERTIES::category']/*"/>
<dd> Priority that is assigned to this sound. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_SOUND_PROPERTIES::priority']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_SOUND_PROPERTIES::pitch']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_SOUND_PROPERTIES::volume']/*"/>
<p>Returns the properties of the sound variation that is currently active in a cue instance.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_SOUND_VARIATION_PROPERTIES']/*"/>
<dd> Properties of the currently active variation, represented by an <seecref="T:SharpDX.XACT3.VariationProperties"/> structure. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_SOUND_VARIATION_PROPERTIES::variationProperties']/*"/>
<dd> Properties of the sound that the active variation references, represented by an <seecref="T:SharpDX.XACT3.SoundProperties"/> structure. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_SOUND_VARIATION_PROPERTIES::soundProperties']/*"/>
<p>Xact.h also includes the following constant declaration:</p><pre>typedef const XACT_WAVEBANK_STREAMING_PARAMETERS *LPCXACT_WAVEBANK_STREAMING_PARAMETERS;</pre>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_STREAMING_PARAMETERS']/*"/>
<dd> File handle that is associated with the wave bank data. <table><tr><th>Windows </th></tr><tr><td><p>The file that is referenced by this handle must be opened with the following <strong>CreateFile</strong> flags: FILE_FLAG_OVERLAPPED | FILE_FLAG_NO_BUFFERING.</p></td></tr></table></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_STREAMING_PARAMETERS::file']/*"/>
<dd> Offset in the wave bank data file. This offset must be DVD sector aligned. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_STREAMING_PARAMETERS::offset']/*"/>
<dd> Flags. <em>Reserved for future use. Set to 0.</em></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_STREAMING_PARAMETERS::flags']/*"/>
<dd> Stream packet size, in sectors, to use for each stream. The minimum value is 2. <p>The size of a DVD sector is 2048 bytes. Therefore, setting this value to 2 results in a packet size of 4096 bytes. Setting it to 3 specifies packets of 6144 bytes, setting it to 4 specifies packets of 8192 bytes, and so on.</p><p>The optimal DVD size is a multiple of 16 (1 DVD block = 16 DVD sectors).</p></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_STREAMING_PARAMETERS::packetSize']/*"/>
<unmanaged-short>unsigned short packetSize</unmanaged-short>
</member>
<membername="T:SharpDX.XACT3.TrackProperties">
<summary>
<p>Returns the properties of a track in an active sound variation in a cue instance.</p>
</summary>
<remarks>
<p>These properties are timing dependent. They may change when the <seecref="M:SharpDX.XACT3.SoundBank.GetCueProperties(System.Int16)"/> call returns.</p>
</remarks>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_TRACK_PROPERTIES']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_TRACK_PROPERTIES::duration']/*"/>
<dd> Total number of wave variations in the track. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_TRACK_PROPERTIES::numVariations']/*"/>
<dd> Maximum number of channels that are required to play the track. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_TRACK_PROPERTIES::numChannels']/*"/>
<dd> Index of the currently active wave variation. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_TRACK_PROPERTIES::waveVariation']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_TRACK_PROPERTIES::loopCount']/*"/>
<p>Returns the properties for the variation that is currently active in a cue instance.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_VARIATION_PROPERTIES']/*"/>
<dd> Index of the variation in the parent variation list. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_VARIATION_PROPERTIES::index']/*"/>
<dd> Weight that is assigned to the variation. This member is used by noninteractive variations only. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_VARIATION_PROPERTIES::weight']/*"/>
<dd> Lower bound of the interactive variable that controls the variation. This member is used by interactive variations only. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_VARIATION_PROPERTIES::iaVariableMin']/*"/>
<dd> Upper bound of the interactive variable that controls the variation. This member is used by interactive variations only. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_VARIATION_PROPERTIES::iaVariableMax']/*"/>
<dd> Flag that indicates if the variation should linger. This member is used by interactive variations only. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_VARIATION_PROPERTIES::linger']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKDATA']/*"/>
<unmanaged>WAVEBANKDATA</unmanaged>
<unmanaged-short>WAVEBANKDATA</unmanaged-short>
</member>
<membername="F:SharpDX.XACT3.WaveBankData.Flags">
<summary>
No documentation.
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKDATA::dwFlags']/*"/>
<unmanaged>unsigned int dwFlags</unmanaged>
<unmanaged-short>unsigned int dwFlags</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKDATA::dwEntryCount']/*"/>
<unmanaged>unsigned int dwEntryCount</unmanaged>
<unmanaged-short>unsigned int dwEntryCount</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKDATA::szBankName']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKDATA::dwEntryMetaDataElementSize']/*"/>
<unmanaged>unsigned int dwEntryMetaDataElementSize</unmanaged>
<unmanaged-short>unsigned int dwEntryMetaDataElementSize</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKDATA::dwEntryNameElementSize']/*"/>
<unmanaged>unsigned int dwEntryNameElementSize</unmanaged>
<unmanaged-short>unsigned int dwEntryNameElementSize</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKDATA::dwAlignment']/*"/>
<unmanaged>unsigned int dwAlignment</unmanaged>
<unmanaged-short>unsigned int dwAlignment</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKDATA::CompactFormat']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKDATA::BuildTime']/*"/>
<p>Contains the entry information from an XACT wave bank.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKENTRY']/*"/>
<dd><p>DWORD value representing both the flags and duration.</p></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKENTRY::dwFlagsAndDuration']/*"/>
<dd><seecref="T:SharpDX.XACT3.WaveBankMiniWaveFormat"/> structure describing the mini-wave format for the wave bank entry.</dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKENTRY::Format']/*"/>
<dd><seecref="T:SharpDX.XACT3.WaveBankRegion"/> structure that describes the region within the wave data segment that contains this entry.</dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKENTRY::PlayRegion']/*"/>
<dd><seecref="T:SharpDX.XACT3.WaveBankSampleRegion"/> structure that describes the region within the wave data (in samples) that should loop.</dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKENTRY::LoopRegion']/*"/>
<dd><p>Flags for the wave bank entry. Can be the following values.</p><table><tr><th>Value</th><th>Description</th></tr><tr><td>WAVEBANKENTRY_FLAGS_READAHEAD</td><td>Indicates stream read-ahead is enabled.?</td></tr><tr><td>WAVEBANKENTRY_FLAGS_LOOPCACHE</td><td>Indicates one or more looping sounds use this wave.?</td></tr><tr><td>WAVEBANKENTRY_FLAGS_REMOVELOOPTAIL</td><td>Indicates removal of data after the end of the loop region.?</td></tr></table></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKENTRY::dwFlags']/*"/>
<dd><p>Duration of the wave, in units of one sample. For instance, a ten second long wave sampled at 48KHz would have a duration of 480,000. This value is not affected by the number of channels, the number of bits per sample, or the compression format of the wave.</p></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKENTRY::Duration']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKENTRYCOMPACT']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKENTRYCOMPACT::dwOffset']/*"/>
<unmanaged>unsigned int dwOffset</unmanaged>
<unmanaged-short>unsigned int dwOffset</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKENTRYCOMPACT::dwLengthDeviation']/*"/>
<unmanaged>unsigned int dwLengthDeviation</unmanaged>
<unmanaged-short>unsigned int dwLengthDeviation</unmanaged-short>
</member>
<membername="T:SharpDX.XACT3.WaveBankHeader">
<summary>
<p>Contains the header information from an XACT wave bank.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKHEADER']/*"/>
<dd>File signature. In a valid file, this will equal WAVEBANK_HEADER_SIGNATURE.</dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKHEADER::dwSignature']/*"/>
<dd>Version of the tool that created the file. The version is XACT_CONTENT_VERSION, and is defined in XACT.h.</dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKHEADER::dwVersion']/*"/>
<dd>Version of the wave bank file format. The current file format version is WAVEBANK_HEADER_VERSION.</dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKHEADER::dwHeaderVersion']/*"/>
<dd>Array of <seecref="T:SharpDX.XACT3.WaveBankRegion"/> structures representing the segment lookup table. The indices into this array are defined in <seecref="T:SharpDX.XACT3.Wavebanksegidx"/>. For example, you would use the <seecref="F:SharpDX.XACT3.Wavebanksegidx.SegidxBankdata"/> index to find the bank data region.</dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKHEADER::Segments']/*"/>
<p>Contains the mini-wave format for an XACT wave bank.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKMINIWAVEFORMAT']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKMINIWAVEFORMAT::dwValue']/*"/>
<dd><p>Format of the wave file. Can be one of the values in the following table.</p><table><tr><th>Value</th><th>Description</th></tr><tr><td><seecref="F:SharpDX.XACT3.WaveBankMiniFormatTag.Pcm"/></td><td>Specifies PCM wave format.?</td></tr><tr><td><seecref="F:SharpDX.XACT3.WaveBankMiniFormatTag.Xma"/></td><td>Specifies XMA2 format.?</td></tr><tr><td><seecref="F:SharpDX.XACT3.WaveBankMiniFormatTag.Adpcm"/></td><td>Specifies ADPCM wave format.?</td></tr><tr><td><seecref="F:SharpDX.XACT3.WaveBankMiniFormatTag.Wma"/></td><td>Specifies xWMA format.?</td></tr></table></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKMINIWAVEFORMAT::wFormatTag']/*"/>
<dd><p>Number of channels in the wave file. Can be a value from 1 to 6.</p></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKMINIWAVEFORMAT::nChannels']/*"/>
<dd><p>Sampling rate of the wave file or sample rate of the decoded audio for compressed formats.</p></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKMINIWAVEFORMAT::nSamplesPerSec']/*"/>
<dd><p>Block alignment index. For xWMA the lower 6 bits are the block alignment index and the upper 2 bits are the bytes per second index.</p></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKMINIWAVEFORMAT::wBlockAlign']/*"/>
<dd><p>Bit depth of the wave file. Can be one of the values in the following table.</p><table><tr><th>Value</th><th>Description</th></tr><tr><td>WAVEBANKMINIFORMAT_BITDEPTH_8</td><td>Specifies 8-bit data. (PCM only)?</td></tr><tr><td>WAVEBANKMINIFORMAT_BITDEPTH_16</td><td>Specifies 16-bit data. (PCM, XMA, ADPCM).?</td></tr></table><p>For xWMA this field indicates whether the format is in the WMA format (0) or the WMA Pro format (1).</p></dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKMINIWAVEFORMAT::wBitsPerSample']/*"/>
<unmanaged>unsigned int wBitsPerSample</unmanaged>
<unmanaged-short>unsigned int wBitsPerSample</unmanaged-short>
</member>
<membername="T:SharpDX.XACT3.WaveBankRegion">
<summary>
<p>Contains the region information for an XACT wave bank.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKREGION']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKREGION::dwOffset']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKREGION::dwLength']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKSAMPLEREGION']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKSAMPLEREGION::dwStartSample']/*"/>
<unmanaged>unsigned int dwStartSample</unmanaged>
<unmanaged-short>unsigned int dwStartSample</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='WAVEBANKSAMPLEREGION::dwTotalSamples']/*"/>
<unmanaged>unsigned int dwTotalSamples</unmanaged>
<unmanaged-short>unsigned int dwTotalSamples</unmanaged-short>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_WAVE_INSTANCE_PROPERTIES']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_WAVE_INSTANCE_PROPERTIES::properties']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_WAVE_INSTANCE_PROPERTIES::backgroundMusic']/*"/>
<p>Returns the properties that are common to all waves.</p>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_WAVE_PROPERTIES']/*"/>
<dd> Friendly name for the wave. An empty string if the wave bank has been stripped of friendly names. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_WAVE_PROPERTIES::friendlyName']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_WAVE_PROPERTIES::format']/*"/>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_WAVE_PROPERTIES::durationInSamples']/*"/>
<dd> Loop region that is defined in samples. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_WAVE_PROPERTIES::loopRegion']/*"/>
<dd> TRUE if the wave is streaming. Otherwise, <seecref="F:SharpDX.Result.False"/>. </dd>
</summary>
<!-- No matching elements were found for the following include tag --><includefile=".\..\Documentation\CodeComments.xml"path="/comments/comment[@id='XACT_WAVE_PROPERTIES::streaming']/*"/>
