3234 lines
240 KiB
XML
3234 lines
240 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>SharpDX.XACT3</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:SharpDX.XACT3.AssemblyDoc">
|
|
<summary>
|
|
The <see cref="A:SharpDX.XACT3"/> assembly provides managed XACT3 API.
|
|
</summary>
|
|
<msdn-id>hh405049</msdn-id>
|
|
<unmanaged>XACT3</unmanaged>
|
|
<unmanaged-short>XACT3</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.AudioEngineSettings">
|
|
<summary>
|
|
Settings for the <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_runtime_parameters</msdn-id>
|
|
<unmanaged>XACT_RUNTIME_PARAMETERS</unmanaged>
|
|
<unmanaged-short>XACT_RUNTIME_PARAMETERS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngineSettings.DefaultLookAhead">
|
|
<summary>
|
|
Default value for <see cref="F:SharpDX.XACT3.AudioEngineSettings.LookAheadTime"/> property (250ms).
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngineSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.XACT3.AudioEngineSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngineSettings.#ctor(System.IO.Stream)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.XACT3.AudioEngineSettings"/> struct.
|
|
</summary>
|
|
<param name="settings">The settings.</param>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngineSettings.LookAheadTime">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::lookAheadTime']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_runtime_parameters</msdn-id>
|
|
<unmanaged>unsigned int lookAheadTime</unmanaged>
|
|
<unmanaged-short>unsigned int lookAheadTime</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngineSettings.GlobalSettingsBufferPointer">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::pGlobalSettingsBuffer']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_runtime_parameters</msdn-id>
|
|
<unmanaged>void* pGlobalSettingsBuffer</unmanaged>
|
|
<unmanaged-short>void pGlobalSettingsBuffer</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngineSettings.GlobalSettingsBufferSize">
|
|
<summary>
|
|
<dd> Size of the data buffer associated with <strong>pGlobalSettingsBuffer.</strong> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::globalSettingsBufferSize']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_runtime_parameters</msdn-id>
|
|
<unmanaged>unsigned int globalSettingsBufferSize</unmanaged>
|
|
<unmanaged-short>unsigned int globalSettingsBufferSize</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngineSettings.GlobalSettingsFlags">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::globalSettingsFlags']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_runtime_parameters</msdn-id>
|
|
<unmanaged>unsigned int globalSettingsFlags</unmanaged>
|
|
<unmanaged-short>unsigned int globalSettingsFlags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngineSettings.GlobalSettingsAllocAttributes">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::globalSettingsAllocAttributes']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_runtime_parameters</msdn-id>
|
|
<unmanaged>unsigned int globalSettingsAllocAttributes</unmanaged>
|
|
<unmanaged-short>unsigned int globalSettingsAllocAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngineSettings.FileIOCallbacks">
|
|
<summary>
|
|
<dd> File I/O callbacks. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::fileIOCallbacks']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_runtime_parameters</msdn-id>
|
|
<unmanaged>XACT_FILEIO_CALLBACKS fileIOCallbacks</unmanaged>
|
|
<unmanaged-short>XACT_FILEIO_CALLBACKS fileIOCallbacks</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngineSettings.FnNotificationCallback">
|
|
<summary>
|
|
<dd> Callback that receives notifications. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::fnNotificationCallback']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_runtime_parameters</msdn-id>
|
|
<unmanaged>__function__stdcall* fnNotificationCallback</unmanaged>
|
|
<unmanaged-short>__function__stdcall fnNotificationCallback</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngineSettings.RendererId">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::pRendererID']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_runtime_parameters</msdn-id>
|
|
<unmanaged>wchar_t* pRendererID</unmanaged>
|
|
<unmanaged-short>wchar_t pRendererID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngineSettings.XAudio2Pointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::pXAudio2']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_runtime_parameters</msdn-id>
|
|
<unmanaged>IXAudio2* pXAudio2</unmanaged>
|
|
<unmanaged-short>IXAudio2 pXAudio2</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngineSettings.MasteringVoicePointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RUNTIME_PARAMETERS::pMasteringVoice']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_runtime_parameters</msdn-id>
|
|
<unmanaged>IXAudio2MasteringVoice* pMasteringVoice</unmanaged>
|
|
<unmanaged-short>IXAudio2MasteringVoice pMasteringVoice</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.AudioEngineSettings.Settings">
|
|
<summary>
|
|
Gets or sets the settings file.
|
|
</summary>
|
|
<value>
|
|
The settings file.
|
|
</value>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.AudioEngineSettings.XAudio2">
|
|
<summary>
|
|
Gets or sets the XAudio2 engine to use with XACT3 engine.
|
|
</summary>
|
|
<value>
|
|
The XAudio2 engine.
|
|
</value>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.AudioEngineSettings.MasteringVoice">
|
|
<summary>
|
|
Gets or sets the MasteringVoice to use with XACT3 engine.
|
|
</summary>
|
|
<value>
|
|
The MasteringVoice.
|
|
</value>
|
|
<remarks>
|
|
<see cref="P:SharpDX.XACT3.AudioEngineSettings.XAudio2"/> field must also be set to a valid XAudio2 instance.
|
|
</remarks>
|
|
</member>
|
|
<member name="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 <see cref="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 ) ) )
|
|
{ // Error
|
|
}
|
|
CoTaskMemFree( (void*)pCueProperties ); </pre> </td></tr></table>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Cue']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3cue.ixact3cue.getproperties</msdn-id>
|
|
<unmanaged>IXACT3Cue</unmanaged>
|
|
<unmanaged-short>IXACT3Cue</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.OnNotificationDelegate(SharpDX.XACT3.Notification)">
|
|
<summary>
|
|
Called when an internal notification occured.
|
|
</summary>
|
|
<param name="notification">The notification.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.RegisterNotification(SharpDX.XACT3.NotificationType)">
|
|
<summary>
|
|
Registers this instance to notify for a type of notification.
|
|
</summary>
|
|
<param name="notificationType">Type of the notification.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.UnregisterNotification(SharpDX.XACT3.NotificationType)">
|
|
<summary>
|
|
Unregisters this instance to notify for a type of notification.
|
|
</summary>
|
|
<param name="notificationType">Type of the notification.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.XACT3.Cue"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.op_Explicit(System.IntPtr)~SharpDX.XACT3.Cue">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.XACT3.Cue"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
|
|
</summary>
|
|
<param name="nativePointer">The native pointer.</param>
|
|
<returns>
|
|
The result of the conversion.
|
|
</returns>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.Play">
|
|
<summary>
|
|
<p>Plays a prepared cue.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<returns><p>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Cue::Play']/*"/>
|
|
<msdn-id>ee418387</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Cue::Play()</unmanaged>
|
|
<unmanaged-short>IXACT3Cue::Play</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.Stop(SharpDX.XACT3.StopFlags)">
|
|
<summary>
|
|
<p>Stops a cue.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="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><see cref="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 <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Cue::Stop']/*"/>
|
|
<msdn-id>ee418392</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Cue::Stop([In] XACT_STOP_FLAGS dwFlags)</unmanaged>
|
|
<unmanaged-short>IXACT3Cue::Stop</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.GetState(SharpDX.XACT3.CueState@)">
|
|
<summary>
|
|
<p>Retrieves the current operating state of a cue.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="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><see cref="F:SharpDX.XACT3.CueState.Created"/></td><td>Created, but nothing else?</td></tr><tr><td><see cref="F:SharpDX.XACT3.CueState.Preparing"/></td><td>Preparing to play?</td></tr><tr><td><see cref="F:SharpDX.XACT3.CueState.Prepared"/></td><td>Prepared, but not yet played?</td></tr><tr><td><see cref="F:SharpDX.XACT3.CueState.Playing"/></td><td>Playing, but can be paused?</td></tr><tr><td><see cref="F:SharpDX.XACT3.CueState.Stopping"/></td><td>Stopping?</td></tr><tr><td><see cref="F:SharpDX.XACT3.CueState.Stopped"/></td><td>Stopped?</td></tr><tr><td><see cref="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 <see cref="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 <see cref="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 <see cref="F:SharpDX.XACT3.CueState.Preparing"/> set or <see cref="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 <see cref="F:SharpDX.XACT3.CueState.Playing"/> and <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Cue::GetState']/*"/>
|
|
<msdn-id>ee418383</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Cue::GetState([Out] XACT_CUE_STATE* pdwState)</unmanaged>
|
|
<unmanaged-short>IXACT3Cue::GetState</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.Destroy">
|
|
<summary>
|
|
<p>Destroys the cue.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<returns>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</returns>
|
|
<remarks>
|
|
<p> <strong><see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Cue::Destroy']/*"/>
|
|
<msdn-id>ee418381</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Cue::Destroy()</unmanaged>
|
|
<unmanaged-short>IXACT3Cue::Destroy</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.SetMatrixCoefficients(System.Int32,System.Int32,System.Single[])">
|
|
<summary>
|
|
<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>
|
|
<param name="srcChannelCount"><dd>[in] Number of source channels. This must equal the number of emitter channels. </dd></param>
|
|
<param name="dstChannelCount"><dd>[in] Number of destination channels. This must equal the number of final mix channels. </dd></param>
|
|
<param name="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 <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Cue::SetMatrixCoefficients']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3cue.ixact3cue.setmatrixcoefficients</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Cue::SetMatrixCoefficients([In] unsigned int uSrcChannelCount,[In] unsigned int uDstChannelCount,[In, Buffer] float* pMatrixCoefficients)</unmanaged>
|
|
<unmanaged-short>IXACT3Cue::SetMatrixCoefficients</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.GetVariableIndex(System.String)">
|
|
<summary>
|
|
<p>Retrieves the corresponding index for a variable name string.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Cue::GetVariableIndex']/*"/>
|
|
<msdn-id>ee418385</msdn-id>
|
|
<unmanaged>unsigned short IXACT3Cue::GetVariableIndex([In] const char* szFriendlyName)</unmanaged>
|
|
<unmanaged-short>IXACT3Cue::GetVariableIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.SetVariable(System.Int16,System.Single)">
|
|
<summary>
|
|
<p>Stores a new value to a variable, referenced by its index.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="index"><dd>[in] Assigned index of the variable in which to store <em>nValue</em>. </dd></param>
|
|
<param name="value"><dd>[in] Value to store in the variable. </dd></param>
|
|
<returns><p>Returns <see cref="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 --><include file=".\..\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>
|
|
<unmanaged-short>IXACT3Cue::SetVariable</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.GetVariable(System.Int16)">
|
|
<summary>
|
|
<p>Retrieves the value of a variable by its index.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Cue::GetVariable']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3cue.ixact3cue.getvariable</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Cue::GetVariable([In] unsigned short nIndex,[Out] float* nValue)</unmanaged>
|
|
<unmanaged-short>IXACT3Cue::GetVariable</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.Pause(System.Boolean)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="pause">No documentation.</param>
|
|
<returns>No documentation.</returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Cue::Pause']/*"/>
|
|
<unmanaged>HRESULT IXACT3Cue::Pause([In] BOOL fPause)</unmanaged>
|
|
<unmanaged-short>IXACT3Cue::Pause</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.GetProperties(SharpDX.XACT3.CueInstanceProperties@)">
|
|
<summary>
|
|
<p>Retrieves the properties of the cue.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="propertiesOut"><dd>[out] Pointer to an <see cref="T:SharpDX.XACT3.CueInstanceProperties"/> structure that contains the cue properties. </dd></param>
|
|
<returns>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</returns>
|
|
<remarks>
|
|
<p><strong>GetProperties</strong> will allocate memory for the <see cref="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 ) ) )
|
|
{ // Error
|
|
}
|
|
CoTaskMemFree( (void*)pCueProperties ); </pre> </td></tr></table>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Cue::GetProperties']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3cue.ixact3cue.getproperties</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Cue::GetProperties([Out] XACT_CUE_INSTANCE_PROPERTIES** ppProperties)</unmanaged>
|
|
<unmanaged-short>IXACT3Cue::GetProperties</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Cue.SetOutputVoiceMatrix(SharpDX.XAudio2.Voice,System.Int32,System.Int32,System.Single[])">
|
|
<summary>
|
|
<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>
|
|
<param name="destinationVoiceRef"><dd>[in] Pointer to a destination <see cref="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>
|
|
<param name="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>
|
|
<param name="destinationChannels"><dd>[in] Confirms the input channel count of the destination voice. </dd></param>
|
|
<param name="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 <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</p></returns>
|
|
<remarks>
|
|
<p>Volume levels are expressed as floating-point amplitude multipliers between -<see cref="F:SharpDX.XAudio2.XAudio2.MaximumVolumeLevel"/> and <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Cue::SetOutputVoiceMatrix']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3cue.ixact3cue.setoutputvoicematrix</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Cue::SetOutputVoiceMatrix([In, Optional] IXAudio2Voice* pDestinationVoice,[In] unsigned int SourceChannels,[In] unsigned int DestinationChannels,[In, Buffer] const float* pLevelMatrix)</unmanaged>
|
|
<unmanaged-short>IXACT3Cue::SetOutputVoiceMatrix</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.Cue.AudioEngine">
|
|
<summary>
|
|
Gets or sets the audio engine.
|
|
</summary>
|
|
<value>
|
|
The audio engine.
|
|
</value>
|
|
</member>
|
|
<member name="E:SharpDX.XACT3.Cue.OnNotification">
|
|
<summary>
|
|
Occurs when a cue event occurs.
|
|
</summary>
|
|
<remarks>
|
|
Use <see cref="M:SharpDX.XACT3.Cue.RegisterNotification(SharpDX.XACT3.NotificationType)"/> to register types.
|
|
</remarks>
|
|
</member>
|
|
<member name="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 <see cref="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 <see cref="F:SharpDX.XACT3.CueState.Preparing"/> set or <see cref="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 <see cref="F:SharpDX.XACT3.CueState.Playing"/> and <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Cue::GetState']/*"/>
|
|
<msdn-id>ee418383</msdn-id>
|
|
<unmanaged>GetState</unmanaged>
|
|
<unmanaged-short>GetState</unmanaged-short>
|
|
<unmanaged>HRESULT IXACT3Cue::GetState([Out] XACT_CUE_STATE* pdwState)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.Cue.Properties">
|
|
<summary>
|
|
<p>Retrieves the properties of the cue.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<remarks>
|
|
<p><strong>GetProperties</strong> will allocate memory for the <see cref="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 ) ) )
|
|
{ // Error
|
|
}
|
|
CoTaskMemFree( (void*)pCueProperties ); </pre> </td></tr></table>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Cue::GetProperties']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3cue.ixact3cue.getproperties</msdn-id>
|
|
<unmanaged>GetProperties</unmanaged>
|
|
<unmanaged-short>GetProperties</unmanaged-short>
|
|
<unmanaged>HRESULT IXACT3Cue::GetProperties([Out] XACT_CUE_INSTANCE_PROPERTIES** ppProperties)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.GuiNotification">
|
|
<summary>
|
|
Gui notification parameters.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_GUI</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.Notification">
|
|
<summary>
|
|
Generic notification event.
|
|
</summary>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.Notification.Type">
|
|
<summary>
|
|
Gets or sets the type.
|
|
</summary>
|
|
<value>
|
|
The type.
|
|
</value>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.Notification.TimeStamp">
|
|
<summary>
|
|
Timestamp of notification, in milliseconds.
|
|
</summary>
|
|
<unmanaged>int timeStamp</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.CueNotification">
|
|
<summary>
|
|
Cue notification parameters.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_CUE</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.AudioEngine">
|
|
<summary>
|
|
<p>This section contains information about the methods used with the <see cref="T:SharpDX.XACT3.AudioEngine"/> interface.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3engine.ixact3engine</msdn-id>
|
|
<unmanaged>IXACT3Engine</unmanaged>
|
|
<unmanaged-short>IXACT3Engine</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.XACT3.AudioEngine"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.#ctor(System.IO.Stream)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.XACT3.AudioEngine"/> class.
|
|
</summary>
|
|
<param name="settingsFile">The settings file.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.#ctor(SharpDX.XACT3.CreationFlags,System.IO.Stream)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.XACT3.AudioEngine"/> class.
|
|
</summary>
|
|
<param name="creationFlags">The creation flags.</param>
|
|
<param name="settingsFile"></param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.#ctor(SharpDX.XACT3.CreationFlags,SharpDX.XACT3.AudioEngineSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.XACT3.AudioEngine"/> class.
|
|
</summary>
|
|
<param name="creationFlags">The creation flags.</param>
|
|
<param name="settings">Settings for this audio engine</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.PreInitialize(SharpDX.XACT3.AudioEngineSettings)">
|
|
<summary>
|
|
Initializes this instance from a settings file and a renderer index.
|
|
</summary>
|
|
<unmanaged>IXACT3Engine::Initialize</unmanaged>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.OnNotificationDelegate(SharpDX.XACT3.Notification)">
|
|
<summary>
|
|
Called when an internal notification occured.
|
|
</summary>
|
|
<param name="notification">The notification.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.RegisterNotification(SharpDX.XACT3.NotificationType)">
|
|
<summary>
|
|
Registers this instance to notify for a type of notification.
|
|
</summary>
|
|
<param name="notificationType">Type of the notification.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.UnregisterNotification(SharpDX.XACT3.NotificationType)">
|
|
<summary>
|
|
Unregisters this instance to notify for a type of notification.
|
|
</summary>
|
|
<param name="notificationType">Type of the notification.</param>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngine.AllowedNotifications">
|
|
<summary>
|
|
Internal dictionary to verify allowed notifications.
|
|
</summary>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.VerifyRegister(SharpDX.XACT3.NotificationType,System.Type,SharpDX.XACT3.ManagedNotificationCallback)">
|
|
<summary>
|
|
Verifies a notification registration for a particular type.
|
|
</summary>
|
|
<param name="notificationType">Type of the notification.</param>
|
|
<param name="type">The type.</param>
|
|
<param name="notificationCallback">The notification callback.</param>
|
|
<exception cref="T:System.InvalidOperationException">If this registration is invalid</exception>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.XACT3.AudioEngine"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.op_Explicit(System.IntPtr)~SharpDX.XACT3.AudioEngine">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.XACT3.AudioEngine"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
|
|
</summary>
|
|
<param name="nativePointer">The native pointer.</param>
|
|
<returns>
|
|
The result of the conversion.
|
|
</returns>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngine.AuditionEngineGuid">
|
|
<summary>Constant AuditionEngineGuid.</summary>
|
|
<unmanaged>CLSID_XACTAuditionEngine</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngine.EngineGuid">
|
|
<summary>Constant EngineGuid.</summary>
|
|
<unmanaged>CLSID_XACTEngine</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.AudioEngine.DebugEngineGuid">
|
|
<summary>Constant DebugEngineGuid.</summary>
|
|
<unmanaged>CLSID_XACTDebugEngine</unmanaged>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.GetRendererCount(System.Int16@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="rendererCountRef">No documentation.</param>
|
|
<returns>No documentation.</returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::GetRendererCount']/*"/>
|
|
<unmanaged>HRESULT IXACT3Engine::GetRendererCount([Out] unsigned short* pnRendererCount)</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::GetRendererCount</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.GetRendererDetails(System.Int16)">
|
|
<summary>
|
|
<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>
|
|
<param name="rendererIndex"><dd> Index of the renderer to retrieve information from. </dd></param>
|
|
<returns><dd> Pointer to an <see cref="T:SharpDX.XACT3.RendererDetails"/> structure that contains details of the renderer. </dd></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\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>
|
|
<unmanaged-short>IXACT3Engine::GetRendererDetails</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.GetFinalMixFormat(SharpDX.Multimedia.WaveFormatExtensible@)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="finalMixFormatRef">No documentation.</param>
|
|
<returns>No documentation.</returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::GetFinalMixFormat']/*"/>
|
|
<unmanaged>HRESULT IXACT3Engine::GetFinalMixFormat([Out] WAVEFORMATEXTENSIBLE* pFinalMixFormat)</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::GetFinalMixFormat</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.Initialize(SharpDX.XACT3.AudioEngineSettings)">
|
|
<summary>
|
|
<p>Initializes the XACT engine.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="paramsRef"><dd>[in] Pointer to an <see cref="T:SharpDX.XACT3.AudioEngineSettings"/> structure that contains the XACT engine initialization parameters. </dd></param>
|
|
<returns><p>Returns <see cref="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 <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::Initialize']/*"/>
|
|
<msdn-id>ee418404</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Engine::Initialize([In] const XACT_RUNTIME_PARAMETERS* pParams)</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::Initialize</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.ShutDown">
|
|
<summary>
|
|
<p>Shuts down the XACT engine and frees any resources in use.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<returns><p>Returns <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::ShutDown']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3engine.ixact3engine.shutdown</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Engine::ShutDown()</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::ShutDown</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.DoWork">
|
|
<summary>
|
|
<p>Performs periodic work that is required by the XACT engine.</p><p>[Code-driven]</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<returns><p>Returns <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::DoWork']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3engine.ixact3engine.dowork</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Engine::DoWork()</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::DoWork</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.CreateSoundBank(System.IntPtr,System.Int32,System.Int32,System.Int32,SharpDX.XACT3.SoundBank)">
|
|
<summary>
|
|
<p>Creates a sound bank for use by the XACT engine.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="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>
|
|
<param name="size"><dd>[in] Value that indicates the size of the data that is used to create the sound bank . </dd></param>
|
|
<param name="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>
|
|
<param name="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>
|
|
<param name="soundBankOut"><dd>[out] Pointer to an <see cref="T:SharpDX.XACT3.SoundBank"/> object that is returned. </dd></param>
|
|
<returns><p>Returns <see cref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::CreateSoundBank']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3engine.ixact3engine.createsoundbank</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Engine::CreateSoundBank([In] const void* pvBuffer,[In] unsigned int dwSize,[In] unsigned int dwFlags,[In] unsigned int dwAllocAttributes,[Out, Fast] IXACT3SoundBank** ppSoundBank)</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::CreateSoundBank</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.CreateInMemoryWaveBank(System.IntPtr,System.Int32,System.Int32,System.Int32,SharpDX.XACT3.WaveBank)">
|
|
<summary>
|
|
<p>Creates an in-memory wave bank for use by the XACT engine.</p><p>[Code-driven]</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="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>
|
|
<param name="size"><dd>[in] Value that indicates the size of the data used to create the wave bank. </dd></param>
|
|
<param name="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>
|
|
<param name="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>
|
|
<param name="waveBankOut"><dd>[out] Pointer to an <see cref="T:SharpDX.XACT3.WaveBank"/> object that is returned. </dd></param>
|
|
<returns><p>Returns <see cref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::CreateInMemoryWaveBank']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3engine.ixact3engine.createinmemorywavebank</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Engine::CreateInMemoryWaveBank([In] const void* pvBuffer,[In] unsigned int dwSize,[In] unsigned int dwFlags,[In] unsigned int dwAllocAttributes,[Out, Fast] IXACT3WaveBank** ppWaveBank)</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::CreateInMemoryWaveBank</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.CreateStreamingWaveBank(SharpDX.XACT3.StreamingParameters,SharpDX.XACT3.WaveBank)">
|
|
<summary>
|
|
<p>Creates an <see cref="T:SharpDX.XACT3.WaveBank"/> instance.</p><p>[Code-driven]</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="parmsRef">No documentation.</param>
|
|
<param name="waveBankOut">No documentation.</param>
|
|
<returns><p>Returns <see cref="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 <see cref="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 <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::CreateStreamingWaveBank']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3engine.ixact3engine.createstreamingwavebank</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Engine::CreateStreamingWaveBank([In] const XACT_STREAMING_PARAMETERS* pParms,[Out, Fast] IXACT3WaveBank** ppWaveBank)</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::CreateStreamingWaveBank</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.PrepareWave(System.Int32,System.String,System.Int16,System.Int32,System.Int32,System.Byte,SharpDX.XACT3.Wave)">
|
|
<summary>
|
|
<p>Prepares a wave object from a standard PCM, XMA (Xbox 360) file.</p><p>[Code-driven]</p>
|
|
</summary>
|
|
<param name="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>
|
|
<param name="wavePath"><dd> Path to the wave file. </dd></param>
|
|
<param name="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 <see cref="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>
|
|
<param name="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>
|
|
<param name="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>
|
|
<param name="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>
|
|
<param name="waveOut"><dd> Pointer to an <see cref="T:SharpDX.XACT3.Wave"/> object that is returned. </dd></param>
|
|
<returns><p>Returns <see cref="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 --><include file=".\..\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>
|
|
<unmanaged-short>IXACT3Engine::PrepareWave</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.PrepareInMemoryWave(System.Int32,SharpDX.XACT3.WaveBankEntry,System.Nullable{System.Int32},System.Nullable{System.Byte},System.Int32,System.Byte,SharpDX.XACT3.Wave)">
|
|
<summary>
|
|
<p>Creates an in-memory <see cref="T:SharpDX.XACT3.Wave"/> object from data that is already resident in memory.</p><p>[Code-driven]</p>
|
|
</summary>
|
|
<param name="flags">No documentation.</param>
|
|
<param name="entry">No documentation.</param>
|
|
<param name="seekTableRef">No documentation.</param>
|
|
<param name="bWaveDataRef">No documentation.</param>
|
|
<param name="playOffset">No documentation.</param>
|
|
<param name="loopCount">No documentation.</param>
|
|
<param name="waveOut">No documentation.</param>
|
|
<returns><p>Returns <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::PrepareInMemoryWave']/*"/>
|
|
<msdn-id>ee418406</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Engine::PrepareInMemoryWave([In] unsigned int dwFlags,[In] WAVEBANKENTRY entry,[In, Optional] unsigned int* pdwSeekTable,[In, Optional] unsigned char* pbWaveData,[In] unsigned int dwPlayOffset,[In] unsigned char nLoopCount,[Out, Fast] IXACT3Wave** ppWave)</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::PrepareInMemoryWave</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.PrepareStreamingWave(System.Int32,SharpDX.XACT3.WaveBankEntry,SharpDX.XACT3.StreamingParameters,System.Int32,System.Nullable{System.Int32},System.Int32,System.Byte,SharpDX.XACT3.Wave)">
|
|
<summary>
|
|
<p>Creates a streaming wave object for the file handle that is passed in.</p><p>[Code-driven]</p>
|
|
</summary>
|
|
<param name="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>
|
|
<param name="entry"><dd> <see cref="T:SharpDX.XACT3.WaveBankEntry"/> structure that describes the format, play region, and loop region for the wave. </dd></param>
|
|
<param name="streamingParams"><dd> <see cref="T:SharpDX.XACT3.StreamingParameters"/> structure with a valid file handle, packet size, etc. </dd></param>
|
|
<param name="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>
|
|
<param name="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>
|
|
<param name="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>
|
|
<param name="loopCount"><dd> Loop count for the wave. </dd></param>
|
|
<param name="waveOut"><dd> Pointer an <see cref="T:SharpDX.XACT3.Wave"/> object that is returned. </dd></param>
|
|
<returns><p>Returns <see cref="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 --><include file=".\..\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>
|
|
<unmanaged-short>IXACT3Engine::PrepareStreamingWave</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.RegisterNotification(SharpDX.XACT3.RawNotificationDescription@)">
|
|
<summary>
|
|
<p>Registers an event notification.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="notificationDescRef"><dd>[in] Pointer to an <see cref="T:SharpDX.XACT3.RawNotificationDescription"/> structure that describes the notification to register. </dd></param>
|
|
<returns><p>Returns <see cref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::RegisterNotification']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3engine.ixact3engine.registernotification</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Engine::RegisterNotification([In] const XACT_NOTIFICATION_DESCRIPTION* pNotificationDesc)</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::RegisterNotification</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.UnRegisterNotification(SharpDX.XACT3.RawNotificationDescription@)">
|
|
<summary>
|
|
<p>Cancels registration of an event notification.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="notificationDescRef"><dd>[in] Pointer to an <see cref="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 <see cref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::UnRegisterNotification']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3engine.ixact3engine.unregisternotification</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Engine::UnRegisterNotification([In] const XACT_NOTIFICATION_DESCRIPTION* pNotificationDesc)</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::UnRegisterNotification</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.GetCategory(System.String)">
|
|
<summary>
|
|
<p>Retrieves the sound category index that corresponds to a friendly name string.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::GetCategory']/*"/>
|
|
<msdn-id>ee418398</msdn-id>
|
|
<unmanaged>unsigned short IXACT3Engine::GetCategory([In] const char* szFriendlyName)</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::GetCategory</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.Stop(System.Int16,SharpDX.XACT3.StopFlags)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="category">No documentation.</param>
|
|
<param name="flags">No documentation.</param>
|
|
<returns>No documentation.</returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::Stop']/*"/>
|
|
<unmanaged>HRESULT IXACT3Engine::Stop([In] unsigned short nCategory,[In] XACT_STOP_FLAGS dwFlags)</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::Stop</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.SetVolume(System.Int16,System.Single)">
|
|
<summary>
|
|
<p>Sets the volume of a sound category.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="category"><dd>[in] Index of the category (<strong>XACTCATEGORY</strong>) for which to set the volume, as returned by <see cref="M:SharpDX.XACT3.AudioEngine.GetCategory(System.String)"/>. </dd></param>
|
|
<param name="volume"><dd>[in] Volume level to set. </dd></param>
|
|
<returns><p>Returns <see cref="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 --><include file=".\..\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>
|
|
<unmanaged-short>IXACT3Engine::SetVolume</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.Pause(System.Int16,System.Boolean)">
|
|
<summary>
|
|
<p>Pauses or resumes playback of a category.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="category"><dd>[in] Index of the category (<strong>XACTCATEGORY</strong>) to pause, as returned by <see cref="M:SharpDX.XACT3.AudioEngine.GetCategory(System.String)"/>. </dd></param>
|
|
<param name="pause"><dd>[in] Action to take. If TRUE, playback is paused. If <see cref="F:SharpDX.Result.False"/>, playback resumes. </dd></param>
|
|
<returns><p>Returns <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::Pause']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3engine.ixact3engine.pause</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Engine::Pause([In] unsigned short nCategory,[In] BOOL fPause)</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::Pause</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.GetGlobalVariableIndex(System.String)">
|
|
<summary>
|
|
<p>Retrieves the corresponding index for a global variable name string.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::GetGlobalVariableIndex']/*"/>
|
|
<msdn-id>ee418401</msdn-id>
|
|
<unmanaged>unsigned short IXACT3Engine::GetGlobalVariableIndex([In] const char* szFriendlyName)</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::GetGlobalVariableIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.SetGlobalVariable(System.Int16,System.Single)">
|
|
<summary>
|
|
<p>Stores a new value to a global variable, which is referenced by its index.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="index"><dd>[in] Assigned index of the global variable in which to store <em>nValue</em>. </dd></param>
|
|
<param name="value"><dd>[in] Value to store in the global variable. </dd></param>
|
|
<returns><p>Returns <see cref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\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>
|
|
<unmanaged-short>IXACT3Engine::SetGlobalVariable</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.AudioEngine.GetGlobalVariable(System.Int16)">
|
|
<summary>
|
|
<p>Retrieves the value of a global variable by its index.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::GetGlobalVariable']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3engine.ixact3engine.getglobalvariable</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Engine::GetGlobalVariable([In] unsigned short nIndex,[Out] float* nValue)</unmanaged>
|
|
<unmanaged-short>IXACT3Engine::GetGlobalVariable</unmanaged-short>
|
|
</member>
|
|
<member name="E:SharpDX.XACT3.AudioEngine.OnNotification">
|
|
<summary>
|
|
Occurs when a AudioEngine event occurs.
|
|
</summary>
|
|
<remarks>
|
|
Use <see cref="M:SharpDX.XACT3.AudioEngine.RegisterNotification(SharpDX.XACT3.NotificationType)"/> to register types.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.AudioEngine.RendererCount">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::GetRendererCount']/*"/>
|
|
<unmanaged>GetRendererCount</unmanaged>
|
|
<unmanaged-short>GetRendererCount</unmanaged-short>
|
|
<unmanaged>HRESULT IXACT3Engine::GetRendererCount([Out] unsigned short* pnRendererCount)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.AudioEngine.FinalMixFormat">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Engine::GetFinalMixFormat']/*"/>
|
|
<unmanaged>GetFinalMixFormat</unmanaged>
|
|
<unmanaged-short>GetFinalMixFormat</unmanaged-short>
|
|
<unmanaged>HRESULT IXACT3Engine::GetFinalMixFormat([Out] WAVEFORMATEXTENSIBLE* pFinalMixFormat)</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.AudioEngine.NotificationCallbackDelegate">
|
|
<summary>
|
|
Internal unmanaged delegate
|
|
</summary>
|
|
<param name="notification">The notification.</param>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.ContentPreparationFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CONTENT_PREPARATION_FLAGS']/*"/>
|
|
<unmanaged>XACT_CONTENT_PREPARATION_FLAGS</unmanaged>
|
|
<unmanaged-short>XACT_CONTENT_PREPARATION_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.ContentPreparationFlags.UnitsMs">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_FLAG_UNITS_MS']/*"/>
|
|
<unmanaged>MACRO_XACT_FLAG_UNITS_MS</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_FLAG_UNITS_MS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.ContentPreparationFlags.UnitsSamples">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_FLAG_UNITS_SAMPLES']/*"/>
|
|
<unmanaged>MACRO_XACT_FLAG_UNITS_SAMPLES</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_FLAG_UNITS_SAMPLES</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.CreationFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CREATION_FLAGS']/*"/>
|
|
<unmanaged>XACT_CREATION_FLAGS</unmanaged>
|
|
<unmanaged-short>XACT_CREATION_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CreationFlags.AuditionMode">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_FLAG_API_AUDITION_MODE']/*"/>
|
|
<unmanaged>MACRO_XACT_FLAG_API_AUDITION_MODE</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_FLAG_API_AUDITION_MODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CreationFlags.DebugMode">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_FLAG_API_DEBUG_MODE']/*"/>
|
|
<unmanaged>MACRO_XACT_FLAG_API_DEBUG_MODE</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_FLAG_API_DEBUG_MODE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CreationFlags.None">
|
|
<summary>
|
|
None.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='']/*"/>
|
|
<unmanaged>None</unmanaged>
|
|
<unmanaged-short>None</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.CueState">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUE_STATE']/*"/>
|
|
<unmanaged>XACT_CUE_STATE</unmanaged>
|
|
<unmanaged-short>XACT_CUE_STATE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueState.Created">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUESTATE_CREATED']/*"/>
|
|
<unmanaged>XACT_CUESTATE_CREATED</unmanaged>
|
|
<unmanaged-short>XACT_CUESTATE_CREATED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueState.Preparing">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUESTATE_PREPARING']/*"/>
|
|
<unmanaged>XACT_CUESTATE_PREPARING</unmanaged>
|
|
<unmanaged-short>XACT_CUESTATE_PREPARING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueState.Prepared">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUESTATE_PREPARED']/*"/>
|
|
<unmanaged>XACT_CUESTATE_PREPARED</unmanaged>
|
|
<unmanaged-short>XACT_CUESTATE_PREPARED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueState.Playing">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUESTATE_PLAYING']/*"/>
|
|
<unmanaged>XACT_CUESTATE_PLAYING</unmanaged>
|
|
<unmanaged-short>XACT_CUESTATE_PLAYING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueState.Stopping">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUESTATE_STOPPING']/*"/>
|
|
<unmanaged>XACT_CUESTATE_STOPPING</unmanaged>
|
|
<unmanaged-short>XACT_CUESTATE_STOPPING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueState.Stopped">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUESTATE_STOPPED']/*"/>
|
|
<unmanaged>XACT_CUESTATE_STOPPED</unmanaged>
|
|
<unmanaged-short>XACT_CUESTATE_STOPPED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueState.Paused">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUESTATE_PAUSED']/*"/>
|
|
<unmanaged>XACT_CUESTATE_PAUSED</unmanaged>
|
|
<unmanaged-short>XACT_CUESTATE_PAUSED</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.NotificationType">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_TYPE']/*"/>
|
|
<unmanaged>XACT_NOTIFICATION_TYPE</unmanaged>
|
|
<unmanaged-short>XACT_NOTIFICATION_TYPE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.CuePrepared">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_CUEPREPARED']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_CUEPREPARED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_CUEPREPARED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.CuePlay">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_CUEPLAY']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_CUEPLAY</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_CUEPLAY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.CueStop">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_CUESTOP']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_CUESTOP</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_CUESTOP</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.CueDestroyed">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_CUEDESTROYED']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_CUEDESTROYED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_CUEDESTROYED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.Marker">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_MARKER']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_MARKER</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_MARKER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.SoundBankDestroyed">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_SOUNDBANKDESTROYED']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_SOUNDBANKDESTROYED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_SOUNDBANKDESTROYED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.WaveBankDestroyed">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVEBANKDESTROYED']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_WAVEBANKDESTROYED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_WAVEBANKDESTROYED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.LocalVariableChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_LOCALVARIABLECHANGED']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_LOCALVARIABLECHANGED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_LOCALVARIABLECHANGED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.GlobalVariableChanged">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_GLOBALVARIABLECHANGED']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_GLOBALVARIABLECHANGED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_GLOBALVARIABLECHANGED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.GuiConnected">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_GUICONNECTED']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_GUICONNECTED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_GUICONNECTED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.GuiDisconnected">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_GUIDISCONNECTED']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_GUIDISCONNECTED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_GUIDISCONNECTED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.WavePrepared">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVEPREPARED']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_WAVEPREPARED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_WAVEPREPARED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.WavePlay">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVEPLAY']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_WAVEPLAY</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_WAVEPLAY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.WaveStop">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVESTOP']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_WAVESTOP</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_WAVESTOP</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.WaveLooped">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVELOOPED']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_WAVELOOPED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_WAVELOOPED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.WaveDestroyed">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVEDESTROYED']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_WAVEDESTROYED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_WAVEDESTROYED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.WaveBankPrepared">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVEBANKPREPARED']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_WAVEBANKPREPARED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_WAVEBANKPREPARED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.NotificationType.WaveBankStreamingInvalidContent">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_NOTIFICATIONTYPE_WAVEBANKSTREAMING_INVALIDCONTENT']/*"/>
|
|
<unmanaged>MACRO_XACT_NOTIFICATIONTYPE_WAVEBANKSTREAMING_INVALIDCONTENT</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_NOTIFICATIONTYPE_WAVEBANKSTREAMING_INVALIDCONTENT</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.StopFlags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_STOP_FLAGS']/*"/>
|
|
<unmanaged>XACT_STOP_FLAGS</unmanaged>
|
|
<unmanaged-short>XACT_STOP_FLAGS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.StopFlags.Release">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_FLAG_CUE_STOP_RELEASE']/*"/>
|
|
<unmanaged>XACT_FLAG_CUE_STOP_RELEASE</unmanaged>
|
|
<unmanaged-short>XACT_FLAG_CUE_STOP_RELEASE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.StopFlags.Immediate">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_FLAG_CUE_STOP_IMMEDIATE']/*"/>
|
|
<unmanaged>XACT_FLAG_CUE_STOP_IMMEDIATE</unmanaged>
|
|
<unmanaged-short>XACT_FLAG_CUE_STOP_IMMEDIATE</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.WaveBankMiniFormatTag">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKMINIFORMAT_TAG']/*"/>
|
|
<unmanaged>WAVEBANKMINIFORMAT_TAG</unmanaged>
|
|
<unmanaged-short>WAVEBANKMINIFORMAT_TAG</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankMiniFormatTag.Pcm">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKMINIFORMAT_TAG_PCM']/*"/>
|
|
<unmanaged>WAVEBANKMINIFORMAT_TAG_PCM</unmanaged>
|
|
<unmanaged-short>WAVEBANKMINIFORMAT_TAG_PCM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankMiniFormatTag.Xma">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKMINIFORMAT_TAG_XMA']/*"/>
|
|
<unmanaged>WAVEBANKMINIFORMAT_TAG_XMA</unmanaged>
|
|
<unmanaged-short>WAVEBANKMINIFORMAT_TAG_XMA</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankMiniFormatTag.Adpcm">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKMINIFORMAT_TAG_ADPCM']/*"/>
|
|
<unmanaged>WAVEBANKMINIFORMAT_TAG_ADPCM</unmanaged>
|
|
<unmanaged-short>WAVEBANKMINIFORMAT_TAG_ADPCM</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankMiniFormatTag.Wma">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKMINIFORMAT_TAG_WMA']/*"/>
|
|
<unmanaged>WAVEBANKMINIFORMAT_TAG_WMA</unmanaged>
|
|
<unmanaged-short>WAVEBANKMINIFORMAT_TAG_WMA</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.Wavebanksegidx">
|
|
<summary>
|
|
<p>Wave bank segment identifiers.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKSEGIDX']/*"/>
|
|
<msdn-id>ee419069</msdn-id>
|
|
<unmanaged>WAVEBANKSEGIDX</unmanaged>
|
|
<unmanaged-short>WAVEBANKSEGIDX</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.Wavebanksegidx.SegidxBankdata">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANK_SEGIDX_BANKDATA']/*"/>
|
|
<unmanaged>WAVEBANK_SEGIDX_BANKDATA</unmanaged>
|
|
<unmanaged-short>WAVEBANK_SEGIDX_BANKDATA</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.Wavebanksegidx.SegidxEntrymetadata">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANK_SEGIDX_ENTRYMETADATA']/*"/>
|
|
<unmanaged>WAVEBANK_SEGIDX_ENTRYMETADATA</unmanaged>
|
|
<unmanaged-short>WAVEBANK_SEGIDX_ENTRYMETADATA</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.Wavebanksegidx.SegidxSeektables">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANK_SEGIDX_SEEKTABLES']/*"/>
|
|
<unmanaged>WAVEBANK_SEGIDX_SEEKTABLES</unmanaged>
|
|
<unmanaged-short>WAVEBANK_SEGIDX_SEEKTABLES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.Wavebanksegidx.SegidxEntrynames">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANK_SEGIDX_ENTRYNAMES']/*"/>
|
|
<unmanaged>WAVEBANK_SEGIDX_ENTRYNAMES</unmanaged>
|
|
<unmanaged-short>WAVEBANK_SEGIDX_ENTRYNAMES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.Wavebanksegidx.SegidxEntrywavedata">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANK_SEGIDX_ENTRYWAVEDATA']/*"/>
|
|
<unmanaged>WAVEBANK_SEGIDX_ENTRYWAVEDATA</unmanaged>
|
|
<unmanaged-short>WAVEBANK_SEGIDX_ENTRYWAVEDATA</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.Wavebanksegidx.SegidxCount">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANK_SEGIDX_COUNT']/*"/>
|
|
<unmanaged>WAVEBANK_SEGIDX_COUNT</unmanaged>
|
|
<unmanaged-short>WAVEBANK_SEGIDX_COUNT</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.WaveState">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_WAVE_STATE']/*"/>
|
|
<unmanaged>XACT_WAVE_STATE</unmanaged>
|
|
<unmanaged-short>XACT_WAVE_STATE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveState.Created">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_STATE_CREATED']/*"/>
|
|
<unmanaged>MACRO_XACT_STATE_CREATED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_STATE_CREATED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveState.Preparing">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_STATE_PREPARING']/*"/>
|
|
<unmanaged>MACRO_XACT_STATE_PREPARING</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_STATE_PREPARING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveState.Prepared">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_STATE_PREPARED']/*"/>
|
|
<unmanaged>MACRO_XACT_STATE_PREPARED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_STATE_PREPARED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveState.Playing">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_STATE_PLAYING']/*"/>
|
|
<unmanaged>MACRO_XACT_STATE_PLAYING</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_STATE_PLAYING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveState.Stopping">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_STATE_STOPPING']/*"/>
|
|
<unmanaged>MACRO_XACT_STATE_STOPPING</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_STATE_STOPPING</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveState.Stopped">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_STATE_STOPPED']/*"/>
|
|
<unmanaged>MACRO_XACT_STATE_STOPPED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_STATE_STOPPED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveState.Paused">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_STATE_PAUSED']/*"/>
|
|
<unmanaged>MACRO_XACT_STATE_PAUSED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_STATE_PAUSED</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveState.InUse">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_STATE_INUSE']/*"/>
|
|
<unmanaged>MACRO_XACT_STATE_INUSE</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_STATE_INUSE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveState.PrepareFailed">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='MACRO_XACT_STATE_PREPAREFAILED']/*"/>
|
|
<unmanaged>MACRO_XACT_STATE_PREPAREFAILED</unmanaged>
|
|
<unmanaged-short>MACRO_XACT_STATE_PREPAREFAILED</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.XACT3">
|
|
<summary>
|
|
Functions
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='SharpDX.XACT3.XACT3']/*"/>
|
|
</member>
|
|
<member name="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3SoundBank']/*"/>
|
|
<msdn-id>ee418422</msdn-id>
|
|
<unmanaged>IXACT3SoundBank</unmanaged>
|
|
<unmanaged-short>IXACT3SoundBank</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.SoundBank.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.XACT3.SoundBank"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.SoundBank.op_Explicit(System.IntPtr)~SharpDX.XACT3.SoundBank">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.XACT3.SoundBank"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
|
|
</summary>
|
|
<param name="nativePointer">The native pointer.</param>
|
|
<returns>
|
|
The result of the conversion.
|
|
</returns>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.SoundBank.GetCueIndex(System.String)">
|
|
<summary>
|
|
<p>Retrieves a sound cue index based on a string that represents the friendly name of the cue.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3SoundBank::GetCueIndex']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3soundbank.ixact3soundbank.getcueindex</msdn-id>
|
|
<unmanaged>unsigned short IXACT3SoundBank::GetCueIndex([In] const char* szFriendlyName)</unmanaged>
|
|
<unmanaged-short>IXACT3SoundBank::GetCueIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.SoundBank.GetCueCount(System.Int16@)">
|
|
<summary>
|
|
<p>Retrieves the number of cues in the sound bank.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="numCuesRef"><dd> Pointer to an XACTINDEX that returns the number of cues. </dd></param>
|
|
<returns><p>Returns <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3SoundBank::GetNumCues']/*"/>
|
|
<msdn-id>ee418420</msdn-id>
|
|
<unmanaged>HRESULT IXACT3SoundBank::GetNumCues([Out] unsigned short* pnNumCues)</unmanaged>
|
|
<unmanaged-short>IXACT3SoundBank::GetNumCues</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.SoundBank.GetCueProperties(System.Int16)">
|
|
<summary>
|
|
<p>Retrieves the properties of a cue.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="cueIndex"><dd> Index of the cue to query. </dd></param>
|
|
<returns><dd> Pointer to an <see cref="T:SharpDX.XACT3.CueProperties"/> structure that receives the cue properties. </dd></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\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>
|
|
<unmanaged-short>IXACT3SoundBank::GetCueProperties</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.SoundBank.Prepare(System.Int16,System.Int32,System.Int32)">
|
|
<summary>
|
|
<p>Prepares a cue instance for playback.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="cueIndex"><dd>[in] Value that indicates the index of the cue to be prepared. </dd></param>
|
|
<param name="flags"><dd>[in] Unused. Should be 0. </dd></param>
|
|
<param name="timeOffset"><dd>[in] Time offset into the cue to start from, in milliseconds. </dd></param>
|
|
<returns><dd>[out] Pointer to the <see cref="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 --><include file=".\..\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>
|
|
<unmanaged-short>IXACT3SoundBank::Prepare</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.SoundBank.Play(System.Int16,System.Int32,System.Int32)">
|
|
<summary>
|
|
<p>Plays a cue. Optionally, returns an instance handle to the cue object for further control.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="cueIndex"><dd>[in] Value that indicates the index of the cue to be played. </dd></param>
|
|
<param name="flags"><dd>[in] Flags to pass to <see cref="M:SharpDX.XACT3.SoundBank.Prepare(System.Int16,System.Int32,System.Int32)"/> for cue playback. </dd></param>
|
|
<param name="timeOffset"><dd>[in] Time offset into the cue to start from, in milliseconds. </dd></param>
|
|
<returns><dd>[out, optional] Pointer to the <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3SoundBank::Play']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3soundbank.ixact3soundbank.play</msdn-id>
|
|
<unmanaged>HRESULT IXACT3SoundBank::Play([In] unsigned short nCueIndex,[In] unsigned int dwFlags,[In] int timeOffset,[Out, Optional] IXACT3Cue** ppCue)</unmanaged>
|
|
<unmanaged-short>IXACT3SoundBank::Play</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.SoundBank.Stop(System.Int16,SharpDX.XACT3.StopFlags)">
|
|
<summary>
|
|
<p>Stops a cue.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="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>
|
|
<param name="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 <see cref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\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>
|
|
<unmanaged-short>IXACT3SoundBank::Stop</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.SoundBank.Destroy">
|
|
<summary>
|
|
<p>Destroys the sound bank.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<returns>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</returns>
|
|
<remarks>
|
|
<p> <strong><see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3SoundBank::Destroy']/*"/>
|
|
<msdn-id>ee418417</msdn-id>
|
|
<unmanaged>HRESULT IXACT3SoundBank::Destroy()</unmanaged>
|
|
<unmanaged-short>IXACT3SoundBank::Destroy</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.SoundBank.GetState(System.Int32@)">
|
|
<summary>
|
|
<p>Retrieves the current state of the sound bank.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="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 <see cref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3SoundBank::GetState']/*"/>
|
|
<msdn-id>ee418421</msdn-id>
|
|
<unmanaged>HRESULT IXACT3SoundBank::GetState([Out] unsigned int* pdwState)</unmanaged>
|
|
<unmanaged-short>IXACT3SoundBank::GetState</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.SoundBank.#ctor(SharpDX.XACT3.AudioEngine,System.IO.Stream)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.XACT3.SoundBank"/> class from a soundbank stream.
|
|
</summary>
|
|
<param name="audioEngine">The engine.</param>
|
|
<param name="stream">The soundbank stream stream.</param>
|
|
<unmanaged>HRESULT IXACT3Engine::CreateSoundBank([In] const void* pvBuffer,[In] unsigned int dwSize,[In] unsigned int dwFlags,[In] unsigned int dwAllocAttributes,[Out, Fast] IXACT3SoundBank** ppSoundBank)</unmanaged>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.SoundBank.OnNotificationDelegate(SharpDX.XACT3.Notification)">
|
|
<summary>
|
|
Called when an internal notification occured.
|
|
</summary>
|
|
<param name="notification">The notification.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.SoundBank.RegisterNotification(SharpDX.XACT3.NotificationType)">
|
|
<summary>
|
|
Registers this instance to notify for a type of notification.
|
|
</summary>
|
|
<param name="notificationType">Type of the notification.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.SoundBank.UnregisterNotification(SharpDX.XACT3.NotificationType)">
|
|
<summary>
|
|
Unregisters this instance to notify for a type of notification.
|
|
</summary>
|
|
<param name="notificationType">Type of the notification.</param>
|
|
</member>
|
|
<member name="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3SoundBank::GetNumCues']/*"/>
|
|
<msdn-id>ee418420</msdn-id>
|
|
<unmanaged>GetNumCues</unmanaged>
|
|
<unmanaged-short>GetNumCues</unmanaged-short>
|
|
<unmanaged>HRESULT IXACT3SoundBank::GetNumCues([Out] unsigned short* pnNumCues)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.SoundBank.AudioEngine">
|
|
<summary>
|
|
Gets or sets the audio engine.
|
|
</summary>
|
|
<value>
|
|
The audio engine.
|
|
</value>
|
|
</member>
|
|
<member name="E:SharpDX.XACT3.SoundBank.OnNotification">
|
|
<summary>
|
|
Occurs when a Soundbank event occurs.
|
|
</summary>
|
|
<remarks>
|
|
Use <see cref="M:SharpDX.XACT3.SoundBank.RegisterNotification(SharpDX.XACT3.NotificationType)"/> to register types.
|
|
</remarks>
|
|
</member>
|
|
<member name="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>
|
|
<member name="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 <see cref="M:SharpDX.XACT3.Wave.SetVolume(System.Single)"/>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Wave']/*"/>
|
|
<msdn-id>ee418438</msdn-id>
|
|
<unmanaged>IXACT3Wave</unmanaged>
|
|
<unmanaged-short>IXACT3Wave</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Wave.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.XACT3.Wave"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Wave.op_Explicit(System.IntPtr)~SharpDX.XACT3.Wave">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.XACT3.Wave"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
|
|
</summary>
|
|
<param name="nativePointer">The native pointer.</param>
|
|
<returns>
|
|
The result of the conversion.
|
|
</returns>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Wave.Destroy">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<returns>No documentation.</returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Wave::Destroy']/*"/>
|
|
<unmanaged>HRESULT IXACT3Wave::Destroy()</unmanaged>
|
|
<unmanaged-short>IXACT3Wave::Destroy</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Wave.Play">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<returns>No documentation.</returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Wave::Play']/*"/>
|
|
<unmanaged>HRESULT IXACT3Wave::Play()</unmanaged>
|
|
<unmanaged-short>IXACT3Wave::Play</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Wave.Stop(SharpDX.XACT3.StopFlags)">
|
|
<summary>
|
|
<p>Stops the wave.</p><p>[Code-driven]</p>
|
|
</summary>
|
|
<param name="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 <see cref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Wave::Stop']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3wave.ixact3wave.stop</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Wave::Stop([In] XACT_STOP_FLAGS dwFlags)</unmanaged>
|
|
<unmanaged-short>IXACT3Wave::Stop</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Wave.Pause(System.Boolean)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="pause">No documentation.</param>
|
|
<returns>No documentation.</returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Wave::Pause']/*"/>
|
|
<unmanaged>HRESULT IXACT3Wave::Pause([In] BOOL fPause)</unmanaged>
|
|
<unmanaged-short>IXACT3Wave::Pause</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Wave.GetState(SharpDX.XACT3.WaveState@)">
|
|
<summary>
|
|
<p>Returns the state of the wave object.</p><p>[Code-driven]</p>
|
|
</summary>
|
|
<param name="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 <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Wave::GetState']/*"/>
|
|
<msdn-id>ee418435</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Wave::GetState([Out] XACT_WAVE_STATE* pdwState)</unmanaged>
|
|
<unmanaged-short>IXACT3Wave::GetState</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Wave.SetPitch(System.Int16)">
|
|
<summary>
|
|
<p>Sets the pitch of a wave.</p><p>[Code-driven]</p>
|
|
</summary>
|
|
<param name="pitch"><dd> XACTPITCH value that is used to set the pitch for playback of this wave. </dd></param>
|
|
<returns><p>Returns <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Wave::SetPitch']/*"/>
|
|
<msdn-id>ee418439</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Wave::SetPitch([In] short pitch)</unmanaged>
|
|
<unmanaged-short>IXACT3Wave::SetPitch</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Wave.SetVolume(System.Single)">
|
|
<summary>
|
|
<p>Sets the volume of a wave.</p><p>[Code-driven]</p>
|
|
</summary>
|
|
<param name="volume"><dd> XACTVOLUME value that is used to set the volume for playback of this wave. </dd></param>
|
|
<returns><p>Returns <see cref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Wave::SetVolume']/*"/>
|
|
<msdn-id>ee418440</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Wave::SetVolume([In] float volume)</unmanaged>
|
|
<unmanaged-short>IXACT3Wave::SetVolume</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Wave.SetMatrixCoefficients(System.Int32,System.Int32,System.Single[])">
|
|
<summary>
|
|
<p>Sets the volume value for each output of a wave.</p><p>[Code-driven]</p>
|
|
</summary>
|
|
<param name="srcChannelCount"><dd> Number of source channels. </dd></param>
|
|
<param name="dstChannelCount"><dd> Number of destination channels. </dd></param>
|
|
<param name="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 <see cref="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 <see cref="M:SharpDX.XACT3.Wave.SetVolume(System.Single)"/>.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\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>
|
|
<unmanaged-short>IXACT3Wave::SetMatrixCoefficients</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Wave.GetProperties(SharpDX.XACT3.WaveInstanceProperties@)">
|
|
<summary>
|
|
<p>Retrieves the properties of the wave object.</p><p>[Code-driven]</p>
|
|
</summary>
|
|
<param name="propertiesRef"><dd> Pointer to an <see cref="T:SharpDX.XACT3.WaveInstanceProperties"/> structure that is returned. </dd></param>
|
|
<returns><p>Returns <see cref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Wave::GetProperties']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3wave.ixact3wave.getproperties</msdn-id>
|
|
<unmanaged>HRESULT IXACT3Wave::GetProperties([Out] XACT_WAVE_INSTANCE_PROPERTIES* pProperties)</unmanaged>
|
|
<unmanaged-short>IXACT3Wave::GetProperties</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Wave.OnNotificationDelegate(SharpDX.XACT3.Notification)">
|
|
<summary>
|
|
Called when an internal notification occured.
|
|
</summary>
|
|
<param name="notification">The notification.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Wave.RegisterNotification(SharpDX.XACT3.NotificationType)">
|
|
<summary>
|
|
Registers this instance to notify for a type of notification.
|
|
</summary>
|
|
<param name="notificationType">Type of the notification.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.Wave.UnregisterNotification(SharpDX.XACT3.NotificationType)">
|
|
<summary>
|
|
Unregisters this instance to notify for a type of notification.
|
|
</summary>
|
|
<param name="notificationType">Type of the notification.</param>
|
|
</member>
|
|
<member name="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Wave::GetState']/*"/>
|
|
<msdn-id>ee418435</msdn-id>
|
|
<unmanaged>GetState</unmanaged>
|
|
<unmanaged-short>GetState</unmanaged-short>
|
|
<unmanaged>HRESULT IXACT3Wave::GetState([Out] XACT_WAVE_STATE* pdwState)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.Wave.Pitch">
|
|
<summary>
|
|
<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 --><include file=".\..\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>
|
|
<member name="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Wave::SetVolume']/*"/>
|
|
<msdn-id>ee418440</msdn-id>
|
|
<unmanaged>SetVolume</unmanaged>
|
|
<unmanaged-short>SetVolume</unmanaged-short>
|
|
<unmanaged>HRESULT IXACT3Wave::SetVolume([In] float volume)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.Wave.Properties">
|
|
<summary>
|
|
<p>Retrieves the properties of the wave object.</p><p>[Code-driven]</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3Wave::GetProperties']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3wave.ixact3wave.getproperties</msdn-id>
|
|
<unmanaged>GetProperties</unmanaged>
|
|
<unmanaged-short>GetProperties</unmanaged-short>
|
|
<unmanaged>HRESULT IXACT3Wave::GetProperties([Out] XACT_WAVE_INSTANCE_PROPERTIES* pProperties)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.Wave.AudioEngine">
|
|
<summary>
|
|
Gets or sets the audio engine.
|
|
</summary>
|
|
<value>
|
|
The audio engine.
|
|
</value>
|
|
</member>
|
|
<member name="E:SharpDX.XACT3.Wave.OnNotification">
|
|
<summary>
|
|
Occurs when a Wave event occurs.
|
|
</summary>
|
|
<remarks>
|
|
Use <see cref="M:SharpDX.XACT3.Wave.RegisterNotification(SharpDX.XACT3.NotificationType)"/> to register types.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.WaveBank">
|
|
<summary>
|
|
<p>This section contains information about the methods used with the <see cref="T:SharpDX.XACT3.WaveBank"/> interface.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3WaveBank']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.ixact3wavebank.ixact3wavebank</msdn-id>
|
|
<unmanaged>IXACT3WaveBank</unmanaged>
|
|
<unmanaged-short>IXACT3WaveBank</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.#ctor(System.IntPtr)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.XACT3.WaveBank"/> class.
|
|
</summary>
|
|
<param name="nativePtr">The native pointer.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.op_Explicit(System.IntPtr)~SharpDX.XACT3.WaveBank">
|
|
<summary>
|
|
Performs an explicit conversion from <see cref="T:System.IntPtr"/> to <see cref="T:SharpDX.XACT3.WaveBank"/>. (This method is a shortcut to <see cref="P:SharpDX.CppObject.NativePointer"/>)
|
|
</summary>
|
|
<param name="nativePointer">The native pointer.</param>
|
|
<returns>
|
|
The result of the conversion.
|
|
</returns>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.Destroy">
|
|
<summary>
|
|
<p>Destroys the wave bank.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<returns>Returns <see cref="F:SharpDX.Result.Ok"/> if successful, an error code otherwise.</returns>
|
|
<remarks>
|
|
<p> <strong><see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3WaveBank::Destroy']/*"/>
|
|
<msdn-id>ee418425</msdn-id>
|
|
<unmanaged>HRESULT IXACT3WaveBank::Destroy()</unmanaged>
|
|
<unmanaged-short>IXACT3WaveBank::Destroy</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.GetWaveCount(System.Int16@)">
|
|
<summary>
|
|
<p>Returns the number of wave entries in the wave bank.</p><p>[Code-driven]</p>
|
|
</summary>
|
|
<param name="numWavesRef"><dd> Pointer to an XACTINDEX that returns the number of waves in the wave bank. </dd></param>
|
|
<returns><p>Returns <see cref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3WaveBank::GetNumWaves']/*"/>
|
|
<msdn-id>ee418426</msdn-id>
|
|
<unmanaged>HRESULT IXACT3WaveBank::GetNumWaves([Out] unsigned short* pnNumWaves)</unmanaged>
|
|
<unmanaged-short>IXACT3WaveBank::GetNumWaves</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.GetWaveIndex(System.String)">
|
|
<summary>
|
|
<p>Returns the wave index for the friendly name of a wave in a wave bank.</p><p>[Code-driven]</p>
|
|
</summary>
|
|
<param name="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3WaveBank::GetWaveIndex']/*"/>
|
|
<msdn-id>ee418428</msdn-id>
|
|
<unmanaged>unsigned short IXACT3WaveBank::GetWaveIndex([In] const char* szFriendlyName)</unmanaged>
|
|
<unmanaged-short>IXACT3WaveBank::GetWaveIndex</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.GetWaveProperties(System.Int16,SharpDX.XACT3.WaveProperties@)">
|
|
<summary>
|
|
<p>Gets the properties of a specific wave in a wave bank.</p><p>[Code-driven]</p>
|
|
</summary>
|
|
<param name="waveIndex"><dd> Index of the wave for which to get properties. </dd></param>
|
|
<param name="wavePropertiesRef"><dd> Pointer to an <see cref="T:SharpDX.XACT3.WaveProperties"/> structure that is returned. </dd></param>
|
|
<returns><p>Returns <see cref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\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>
|
|
<unmanaged-short>IXACT3WaveBank::GetWaveProperties</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.Prepare_(System.Int16,SharpDX.XACT3.ContentPreparationFlags,System.Int32,System.Byte)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="waveIndex">No documentation.</param>
|
|
<param name="flags">No documentation.</param>
|
|
<param name="playOffset">No documentation.</param>
|
|
<param name="loopCount">No documentation.</param>
|
|
<returns>No documentation.</returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='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>
|
|
<unmanaged-short>IXACT3WaveBank::Prepare</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.Play_(System.Int16,SharpDX.XACT3.ContentPreparationFlags,System.Int32,System.Byte)">
|
|
<summary>
|
|
<p>Starts the playback for a wave that is indicated by the wave index.</p><p>[Code-driven]</p>
|
|
</summary>
|
|
<param name="waveIndex"><dd> Index of the wave. </dd></param>
|
|
<param name="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>
|
|
<param name="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>
|
|
<param name="loopCount"><dd> Number of loops for playback. </dd></param>
|
|
<returns><dd> Pointer to an <see cref="T:SharpDX.XACT3.Wave"/> object that is returned. </dd></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\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>
|
|
<unmanaged-short>IXACT3WaveBank::Play</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.Stop(System.Int16,SharpDX.XACT3.StopFlags)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="waveIndex">No documentation.</param>
|
|
<param name="flags">No documentation.</param>
|
|
<returns>No documentation.</returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3WaveBank::Stop']/*"/>
|
|
<unmanaged>HRESULT IXACT3WaveBank::Stop([In] unsigned short nWaveIndex,[In] XACT_STOP_FLAGS dwFlags)</unmanaged>
|
|
<unmanaged-short>IXACT3WaveBank::Stop</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.GetState(System.Int32@)">
|
|
<summary>
|
|
<p>Retrieves the current state of the wave bank.</p><p>[Content-driven]</p>
|
|
</summary>
|
|
<param name="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 <see cref="F:SharpDX.Result.Ok"/> if successful. Otherwise, an error code.</p></returns>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3WaveBank::GetState']/*"/>
|
|
<msdn-id>ee418427</msdn-id>
|
|
<unmanaged>HRESULT IXACT3WaveBank::GetState([Out] unsigned int* pdwState)</unmanaged>
|
|
<unmanaged-short>IXACT3WaveBank::GetState</unmanaged-short>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.#ctor(SharpDX.XACT3.AudioEngine,System.IO.Stream)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.XACT3.WaveBank"/> class from a wave bank stream.
|
|
</summary>
|
|
<param name="audioEngine">The engine.</param>
|
|
<param name="stream">The wave bank stream.</param>
|
|
<unmanaged>HRESULT IXACT3Engine::CreateInMemoryWaveBank([In] const void* pvBuffer,[In] unsigned int dwSize,[In] unsigned int dwFlags,[In] unsigned int dwAllocAttributes,[Out, Fast] IXACT3WaveBank** ppWaveBank)</unmanaged>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.#ctor(SharpDX.XACT3.AudioEngine,System.String,System.Int32,System.Int16)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:SharpDX.XACT3.WaveBank"/> class from a file for async reading.
|
|
</summary>
|
|
<param name="audioEngine">The engine.</param>
|
|
<param name="fileName">Name of the file to load the wavebank from.</param>
|
|
<param name="offset">The offset into the stream.</param>
|
|
<param name="packetSize">Packet size used to load the stream.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.OnNotificationDelegate(SharpDX.XACT3.Notification)">
|
|
<summary>
|
|
Called when an internal notification occured.
|
|
</summary>
|
|
<param name="notification">The notification.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.RegisterNotification(SharpDX.XACT3.NotificationType)">
|
|
<summary>
|
|
Registers this instance to notify for a type of notification.
|
|
</summary>
|
|
<param name="notificationType">Type of the notification.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.UnregisterNotification(SharpDX.XACT3.NotificationType)">
|
|
<summary>
|
|
Unregisters this instance to notify for a type of notification.
|
|
</summary>
|
|
<param name="notificationType">Type of the notification.</param>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.Prepare(System.Int16,SharpDX.XACT3.ContentPreparationFlags,System.Int32,System.Byte)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="waveIndex">No documentation.</param>
|
|
<param name="flags">No documentation.</param>
|
|
<param name="playOffset">No documentation.</param>
|
|
<param name="loopCount">No documentation.</param>
|
|
<returns>No documentation.</returns>
|
|
<!-- Failed to insert some or all of included XML --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='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>
|
|
</member>
|
|
<member name="M:SharpDX.XACT3.WaveBank.Play(System.Int16,SharpDX.XACT3.ContentPreparationFlags,System.Int32,System.Byte)">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<param name="waveIndex">No documentation.</param>
|
|
<param name="flags">No documentation.</param>
|
|
<param name="playOffset">No documentation.</param>
|
|
<param name="loopCount">No documentation.</param>
|
|
<returns>No documentation.</returns>
|
|
<!-- Failed to insert some or all of included XML --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='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>
|
|
<member name="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3WaveBank::GetNumWaves']/*"/>
|
|
<msdn-id>ee418426</msdn-id>
|
|
<unmanaged>GetNumWaves</unmanaged>
|
|
<unmanaged-short>GetNumWaves</unmanaged-short>
|
|
<unmanaged>HRESULT IXACT3WaveBank::GetNumWaves([Out] unsigned short* pnNumWaves)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.WaveBank.State">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='IXACT3WaveBank::GetState']/*"/>
|
|
<msdn-id>ee418427</msdn-id>
|
|
<unmanaged>GetState</unmanaged>
|
|
<unmanaged-short>GetState</unmanaged-short>
|
|
<unmanaged>HRESULT IXACT3WaveBank::GetState([Out] unsigned int* pdwState)</unmanaged>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.WaveBank.AudioEngine">
|
|
<summary>
|
|
Gets or sets the audio engine.
|
|
</summary>
|
|
<value>
|
|
The audio engine.
|
|
</value>
|
|
</member>
|
|
<member name="E:SharpDX.XACT3.WaveBank.OnNotification">
|
|
<summary>
|
|
Occurs when a WaveBank event occurs.
|
|
</summary>
|
|
<remarks>
|
|
Use <see cref="M:SharpDX.XACT3.WaveBank.RegisterNotification(SharpDX.XACT3.NotificationType)"/> to register types.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.CueInstanceProperties">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUE_INSTANCE_PROPERTIES']/*"/>
|
|
<unmanaged>XACT_CUE_INSTANCE_PROPERTIES</unmanaged>
|
|
<unmanaged-short>XACT_CUE_INSTANCE_PROPERTIES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueInstanceProperties.AllocAttributes">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUE_INSTANCE_PROPERTIES::allocAttributes']/*"/>
|
|
<unmanaged>unsigned int allocAttributes</unmanaged>
|
|
<unmanaged-short>unsigned int allocAttributes</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueInstanceProperties.CueProperties">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUE_INSTANCE_PROPERTIES::cueProperties']/*"/>
|
|
<unmanaged>XACT_CUE_PROPERTIES cueProperties</unmanaged>
|
|
<unmanaged-short>XACT_CUE_PROPERTIES cueProperties</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueInstanceProperties.ActiveVariationProperties">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUE_INSTANCE_PROPERTIES::activeVariationProperties']/*"/>
|
|
<unmanaged>XACT_SOUND_VARIATION_PROPERTIES activeVariationProperties</unmanaged>
|
|
<unmanaged-short>XACT_SOUND_VARIATION_PROPERTIES activeVariationProperties</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.CueProperties">
|
|
<summary>
|
|
<p>Reports cue properties back to the client.</p>
|
|
</summary>
|
|
<remarks>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUE_PROPERTIES']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_cue_properties</msdn-id>
|
|
<unmanaged>XACT_CUE_PROPERTIES</unmanaged>
|
|
<unmanaged-short>XACT_CUE_PROPERTIES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueProperties.FriendlyName">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUE_PROPERTIES::friendlyName']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_cue_properties</msdn-id>
|
|
<unmanaged>char friendlyName[255]</unmanaged>
|
|
<unmanaged-short>char friendlyName</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueProperties.VariableIndex">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUE_PROPERTIES::iaVariableIndex']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_cue_properties</msdn-id>
|
|
<unmanaged>unsigned short iaVariableIndex</unmanaged>
|
|
<unmanaged-short>unsigned short iaVariableIndex</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueProperties.VariationCount">
|
|
<summary>
|
|
<dd> Number of sound variations for this cue. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUE_PROPERTIES::numVariations']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_cue_properties</msdn-id>
|
|
<unmanaged>unsigned short numVariations</unmanaged>
|
|
<unmanaged-short>unsigned short numVariations</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueProperties.MaxInstances">
|
|
<summary>
|
|
<dd> Maximum number of instances that are allowed for this cue. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUE_PROPERTIES::maxInstances']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_cue_properties</msdn-id>
|
|
<unmanaged>unsigned char maxInstances</unmanaged>
|
|
<unmanaged-short>unsigned char maxInstances</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.CueProperties.CurrentInstances">
|
|
<summary>
|
|
<dd> Number of currently active instances of this cue. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUE_PROPERTIES::currentInstances']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_cue_properties</msdn-id>
|
|
<unmanaged>unsigned char currentInstances</unmanaged>
|
|
<unmanaged-short>unsigned char currentInstances</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.CueProperties.IsInteractive">
|
|
<summary>
|
|
<dd> TRUE if the cue is an interactive audio cue and <see cref="F:SharpDX.Result.False"/> otherwise. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_CUE_PROPERTIES::interactive']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_cue_properties</msdn-id>
|
|
<unmanaged>BOOL interactive</unmanaged>
|
|
<unmanaged-short>BOOL interactive</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.FileIoCallbacks">
|
|
<summary>
|
|
<p>File I/O Callbacks</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_FILEIO_CALLBACKS']/*"/>
|
|
<msdn-id>ee419079</msdn-id>
|
|
<unmanaged>XACT_FILEIO_CALLBACKS</unmanaged>
|
|
<unmanaged-short>XACT_FILEIO_CALLBACKS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.FileIoCallbacks.ReadFileCallback">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_FILEIO_CALLBACKS::readFileCallback']/*"/>
|
|
<msdn-id>ee419079</msdn-id>
|
|
<unmanaged>__function__stdcall* readFileCallback</unmanaged>
|
|
<unmanaged-short>__function__stdcall readFileCallback</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.FileIoCallbacks.GetOverlappedResultCallback">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_FILEIO_CALLBACKS::getOverlappedResultCallback']/*"/>
|
|
<msdn-id>ee419079</msdn-id>
|
|
<unmanaged>__function__stdcall* getOverlappedResultCallback</unmanaged>
|
|
<unmanaged-short>__function__stdcall getOverlappedResultCallback</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.RawNotificationCue">
|
|
<summary>
|
|
<p>Notification structure for all XACT cue notifications.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_CUE']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_cue</msdn-id>
|
|
<unmanaged>XACT_NOTIFICATION_CUE</unmanaged>
|
|
<unmanaged-short>XACT_NOTIFICATION_CUE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationCue.CueIndex">
|
|
<summary>
|
|
<dd> Cue index. XACTINDEX_INVALID signifies an invalid cue index. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_CUE::cueIndex']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_cue</msdn-id>
|
|
<unmanaged>unsigned short cueIndex</unmanaged>
|
|
<unmanaged-short>unsigned short cueIndex</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationCue.SoundBankPointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_CUE::pSoundBank']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_cue</msdn-id>
|
|
<unmanaged>IXACT3SoundBank* pSoundBank</unmanaged>
|
|
<unmanaged-short>IXACT3SoundBank pSoundBank</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationCue.CuePointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_CUE::pCue']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_cue</msdn-id>
|
|
<unmanaged>IXACT3Cue* pCue</unmanaged>
|
|
<unmanaged-short>IXACT3Cue pCue</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.RawNotificationDescription">
|
|
<summary>
|
|
<p>Provides descriptions for registering, unregistering, and flushing notifications.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION']/*"/>
|
|
<msdn-id>ee419084</msdn-id>
|
|
<unmanaged>XACT_NOTIFICATION_DESCRIPTION</unmanaged>
|
|
<unmanaged-short>XACT_NOTIFICATION_DESCRIPTION</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationDescription.Type">
|
|
<summary>
|
|
<dd> Notification type. Can be one of the following values: <table> <tr><th>Value
|
|
</th><th>Supported Fields
|
|
</th></tr> <tr><td>XACTNOTIFICATIONTYPE_CUEPREPARED
|
|
</td><td>None, sound bank, sound bank and cue index, cue instance
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_CUEPLAY
|
|
</td><td>None, sound bank, sound bank and cue index, cue instance
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_CUESTOP
|
|
</td><td>None, sound bank, sound bank and cue index, cue instance
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_CUEDESTROYED
|
|
</td><td>None, sound bank, sound bank and cue index, cue instance
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_MARKER
|
|
</td><td>None, sound bank, sound bank and cue index, cue instance
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_SOUNDBANKDESTROYED
|
|
</td><td>None, sound bank
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_WAVEBANKDESTROYED
|
|
</td><td>None, wave bank
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_LOCALVARIABLECHANGED
|
|
</td><td>None, sound bank, sound bank and cue index, cue instance
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_GLOBALVARIABLECHANGED
|
|
</td><td>None
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_GUICONNECTED
|
|
</td><td>None
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_GUIDISCONNECTED
|
|
</td><td>None
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_WAVEPREPARED
|
|
</td><td>None, wave bank and wave index, wave instance
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_WAVEPLAY
|
|
</td><td>None, sound bank, sound bank and cue index, cue instance, wave bank
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_WAVESTOP
|
|
</td><td>None, sound bank, sound bank and cue index, cue instance, wave bank
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_WAVELOOPED
|
|
</td><td>None, sound bank, sound bank and cue index, cue instance, wave bank, wave instance
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_WAVEDESTROYED
|
|
</td><td>None, wave bank and wave index, wave instance
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_WAVEBANKPREPARED
|
|
</td><td>None, wave bank
|
|
</td></tr> <tr><td>XACTNOTIFICATIONTYPE_WAVEBANKSTREAMING_INVALIDCONTENT
|
|
</td><td>None, wave bank
|
|
</td></tr> </table> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::type']/*"/>
|
|
<msdn-id>ee419084</msdn-id>
|
|
<unmanaged>XACT_NOTIFICATION_TYPE type</unmanaged>
|
|
<unmanaged-short>XACT_NOTIFICATION_TYPE type</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationDescription.Flags">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::flags']/*"/>
|
|
<msdn-id>ee419084</msdn-id>
|
|
<unmanaged>unsigned char flags</unmanaged>
|
|
<unmanaged-short>unsigned char flags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationDescription.SoundBankPointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::pSoundBank']/*"/>
|
|
<msdn-id>ee419084</msdn-id>
|
|
<unmanaged>IXACT3SoundBank* pSoundBank</unmanaged>
|
|
<unmanaged-short>IXACT3SoundBank pSoundBank</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationDescription.WaveBankPointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::pWaveBank']/*"/>
|
|
<msdn-id>ee419084</msdn-id>
|
|
<unmanaged>IXACT3WaveBank* pWaveBank</unmanaged>
|
|
<unmanaged-short>IXACT3WaveBank pWaveBank</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationDescription.CuePointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::pCue']/*"/>
|
|
<msdn-id>ee419084</msdn-id>
|
|
<unmanaged>IXACT3Cue* pCue</unmanaged>
|
|
<unmanaged-short>IXACT3Cue pCue</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationDescription.WavePointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_DESCRIPTION::pWave']/*"/>
|
|
<msdn-id>ee419084</msdn-id>
|
|
<unmanaged>IXACT3Wave* pWave</unmanaged>
|
|
<unmanaged-short>IXACT3Wave pWave</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationDescription.CueIndex">
|
|
<summary>
|
|
<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 --><include file=".\..\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>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationDescription.WaveIndex">
|
|
<summary>
|
|
<dd> Wave index. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\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>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationDescription.ContextPointer">
|
|
<summary>
|
|
<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 --><include file=".\..\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>
|
|
<member name="T:SharpDX.XACT3.RawNotificationGui">
|
|
<summary>
|
|
<p>Notification structure for all GUI notifications.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_GUI']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_gui</msdn-id>
|
|
<unmanaged>XACT_NOTIFICATION_GUI</unmanaged>
|
|
<unmanaged-short>XACT_NOTIFICATION_GUI</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationGui.Reserved">
|
|
<summary>
|
|
<dd> Reserved for future use. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_GUI::reserved']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_gui</msdn-id>
|
|
<unmanaged>unsigned int reserved</unmanaged>
|
|
<unmanaged-short>unsigned int reserved</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.RawNotificationMarker">
|
|
<summary>
|
|
<p>Notification structure for all marker notifications.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_MARKER']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_marker</msdn-id>
|
|
<unmanaged>XACT_NOTIFICATION_MARKER</unmanaged>
|
|
<unmanaged-short>XACT_NOTIFICATION_MARKER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationMarker.CueIndex">
|
|
<summary>
|
|
<dd> Cue index. XACTINDEX_INVALID signifies an invalid cue index. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_MARKER::cueIndex']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_marker</msdn-id>
|
|
<unmanaged>unsigned short cueIndex</unmanaged>
|
|
<unmanaged-short>unsigned short cueIndex</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationMarker.SoundBankPointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="T:SharpDX.XACT3.SoundBank"/> instance. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_MARKER::pSoundBank']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_marker</msdn-id>
|
|
<unmanaged>IXACT3SoundBank* pSoundBank</unmanaged>
|
|
<unmanaged-short>IXACT3SoundBank pSoundBank</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationMarker.CuePointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="T:SharpDX.XACT3.Cue"/> instance. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_MARKER::pCue']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_marker</msdn-id>
|
|
<unmanaged>IXACT3Cue* pCue</unmanaged>
|
|
<unmanaged-short>IXACT3Cue pCue</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationMarker.Marker">
|
|
<summary>
|
|
<dd> The ID of the marker. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_MARKER::marker']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_marker</msdn-id>
|
|
<unmanaged>unsigned int marker</unmanaged>
|
|
<unmanaged-short>unsigned int marker</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.RawNotificationSoundbank">
|
|
<summary>
|
|
<p>Notification structure for all sound bank notifications.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_SOUNDBANK']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_soundbank</msdn-id>
|
|
<unmanaged>XACT_NOTIFICATION_SOUNDBANK</unmanaged>
|
|
<unmanaged-short>XACT_NOTIFICATION_SOUNDBANK</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationSoundbank.SoundBankPointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_SOUNDBANK::pSoundBank']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_soundbank</msdn-id>
|
|
<unmanaged>IXACT3SoundBank* pSoundBank</unmanaged>
|
|
<unmanaged-short>IXACT3SoundBank pSoundBank</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.RawNotificationVariable">
|
|
<summary>
|
|
<p>Notification structure for all variable notifications.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_VARIABLE']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_variable</msdn-id>
|
|
<unmanaged>XACT_NOTIFICATION_VARIABLE</unmanaged>
|
|
<unmanaged-short>XACT_NOTIFICATION_VARIABLE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationVariable.CueIndex">
|
|
<summary>
|
|
<dd> Cue index. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_VARIABLE::cueIndex']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_variable</msdn-id>
|
|
<unmanaged>unsigned short cueIndex</unmanaged>
|
|
<unmanaged-short>unsigned short cueIndex</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationVariable.SoundBankPointer">
|
|
<summary>
|
|
<dd> Soundbank instance. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_VARIABLE::pSoundBank']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_variable</msdn-id>
|
|
<unmanaged>IXACT3SoundBank* pSoundBank</unmanaged>
|
|
<unmanaged-short>IXACT3SoundBank pSoundBank</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationVariable.CuePointer">
|
|
<summary>
|
|
<dd> Cue instance. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_VARIABLE::pCue']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_variable</msdn-id>
|
|
<unmanaged>IXACT3Cue* pCue</unmanaged>
|
|
<unmanaged-short>IXACT3Cue pCue</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationVariable.VariableIndex">
|
|
<summary>
|
|
<dd> Variable index. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_VARIABLE::variableIndex']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_variable</msdn-id>
|
|
<unmanaged>unsigned short variableIndex</unmanaged>
|
|
<unmanaged-short>unsigned short variableIndex</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationVariable.VariableValue">
|
|
<summary>
|
|
<dd> Variable value. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_VARIABLE::variableValue']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_variable</msdn-id>
|
|
<unmanaged>float variableValue</unmanaged>
|
|
<unmanaged-short>float variableValue</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.RawNotificationVariable.Local">
|
|
<summary>
|
|
<dd> TRUE if a local variable. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_VARIABLE::local']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_variable</msdn-id>
|
|
<unmanaged>BOOL local</unmanaged>
|
|
<unmanaged-short>BOOL local</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.RawNotificationWave">
|
|
<summary>
|
|
<p>Notification structure for all wave notifications.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_WAVE']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_wave</msdn-id>
|
|
<unmanaged>XACT_NOTIFICATION_WAVE</unmanaged>
|
|
<unmanaged-short>XACT_NOTIFICATION_WAVE</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationWave.WaveBankPointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="T:SharpDX.XACT3.WaveBank"/> instance. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_WAVE::pWaveBank']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_wave</msdn-id>
|
|
<unmanaged>IXACT3WaveBank* pWaveBank</unmanaged>
|
|
<unmanaged-short>IXACT3WaveBank pWaveBank</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationWave.WaveIndex">
|
|
<summary>
|
|
<dd> Wave index. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_WAVE::waveIndex']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_wave</msdn-id>
|
|
<unmanaged>unsigned short waveIndex</unmanaged>
|
|
<unmanaged-short>unsigned short waveIndex</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationWave.CueIndex">
|
|
<summary>
|
|
<dd> Cue index. XACTINDEX_INVALID signifies an invalid cue index. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_WAVE::cueIndex']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_wave</msdn-id>
|
|
<unmanaged>unsigned short cueIndex</unmanaged>
|
|
<unmanaged-short>unsigned short cueIndex</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationWave.SoundBankPointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="T:SharpDX.XACT3.SoundBank"/> instance. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_WAVE::pSoundBank']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_wave</msdn-id>
|
|
<unmanaged>IXACT3SoundBank* pSoundBank</unmanaged>
|
|
<unmanaged-short>IXACT3SoundBank pSoundBank</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationWave.CuePointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="T:SharpDX.XACT3.Cue"/> instance. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_WAVE::pCue']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_wave</msdn-id>
|
|
<unmanaged>IXACT3Cue* pCue</unmanaged>
|
|
<unmanaged-short>IXACT3Cue pCue</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationWave.WavePointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="T:SharpDX.XACT3.Wave"/> instance. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_WAVE::pWave']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_wave</msdn-id>
|
|
<unmanaged>IXACT3Wave* pWave</unmanaged>
|
|
<unmanaged-short>IXACT3Wave pWave</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.RawNotificationWavebank">
|
|
<summary>
|
|
<p>Notification structure for all wave bank notifications.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_WAVEBANK']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_wavebank</msdn-id>
|
|
<unmanaged>XACT_NOTIFICATION_WAVEBANK</unmanaged>
|
|
<unmanaged-short>XACT_NOTIFICATION_WAVEBANK</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotificationWavebank.WaveBankPointer">
|
|
<summary>
|
|
<dd> Pointer to the <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_NOTIFICATION_WAVEBANK::pWaveBank']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_notification_wavebank</msdn-id>
|
|
<unmanaged>IXACT3WaveBank* pWaveBank</unmanaged>
|
|
<unmanaged-short>IXACT3WaveBank pWaveBank</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.RendererDetails">
|
|
<summary>
|
|
<p>Returns information about a particular renderer.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RENDERER_DETAILS']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_renderer_details</msdn-id>
|
|
<unmanaged>XACT_RENDERER_DETAILS</unmanaged>
|
|
<unmanaged-short>XACT_RENDERER_DETAILS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RendererDetails.RendererId">
|
|
<summary>
|
|
<dd> Wide character array containing the id of the renderer. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RENDERER_DETAILS::rendererID']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_renderer_details</msdn-id>
|
|
<unmanaged>wchar_t rendererID[255]</unmanaged>
|
|
<unmanaged-short>wchar_t rendererID</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RendererDetails.DisplayName">
|
|
<summary>
|
|
<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 <see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RENDERER_DETAILS::displayName']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_renderer_details</msdn-id>
|
|
<unmanaged>wchar_t displayName[255]</unmanaged>
|
|
<unmanaged-short>wchar_t displayName</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.RendererDetails.IsDefault">
|
|
<summary>
|
|
<dd> TRUE if this renderer is the default renderer. Otherwise, <see cref="F:SharpDX.Result.False"/>. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_RENDERER_DETAILS::defaultDevice']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_renderer_details</msdn-id>
|
|
<unmanaged>BOOL defaultDevice</unmanaged>
|
|
<unmanaged-short>BOOL defaultDevice</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.SoundProperties">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_SOUND_PROPERTIES']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_sound_properties</msdn-id>
|
|
<unmanaged>XACT_SOUND_PROPERTIES</unmanaged>
|
|
<unmanaged-short>XACT_SOUND_PROPERTIES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.SoundProperties.Category">
|
|
<summary>
|
|
<dd> Category that this sound belongs to. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_SOUND_PROPERTIES::category']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_sound_properties</msdn-id>
|
|
<unmanaged>unsigned short category</unmanaged>
|
|
<unmanaged-short>unsigned short category</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.SoundProperties.Priority">
|
|
<summary>
|
|
<dd> Priority that is assigned to this sound. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_SOUND_PROPERTIES::priority']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_sound_properties</msdn-id>
|
|
<unmanaged>unsigned char priority</unmanaged>
|
|
<unmanaged-short>unsigned char priority</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.SoundProperties.Pitch">
|
|
<summary>
|
|
<dd> Current pitch of the sound. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_SOUND_PROPERTIES::pitch']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_sound_properties</msdn-id>
|
|
<unmanaged>short pitch</unmanaged>
|
|
<unmanaged-short>short pitch</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.SoundProperties.Volume">
|
|
<summary>
|
|
<dd> Current volume of the sound. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_SOUND_PROPERTIES::volume']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_sound_properties</msdn-id>
|
|
<unmanaged>float volume</unmanaged>
|
|
<unmanaged-short>float volume</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.SoundVariationProperties">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_SOUND_VARIATION_PROPERTIES']/*"/>
|
|
<msdn-id>ee419095</msdn-id>
|
|
<unmanaged>XACT_SOUND_VARIATION_PROPERTIES</unmanaged>
|
|
<unmanaged-short>XACT_SOUND_VARIATION_PROPERTIES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.SoundVariationProperties.VariationProperties">
|
|
<summary>
|
|
<dd> Properties of the currently active variation, represented by an <see cref="T:SharpDX.XACT3.VariationProperties"/> structure. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_SOUND_VARIATION_PROPERTIES::variationProperties']/*"/>
|
|
<msdn-id>ee419095</msdn-id>
|
|
<unmanaged>XACT_VARIATION_PROPERTIES variationProperties</unmanaged>
|
|
<unmanaged-short>XACT_VARIATION_PROPERTIES variationProperties</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.SoundVariationProperties.SoundProperties">
|
|
<summary>
|
|
<dd> Properties of the sound that the active variation references, represented by an <see cref="T:SharpDX.XACT3.SoundProperties"/> structure. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_SOUND_VARIATION_PROPERTIES::soundProperties']/*"/>
|
|
<msdn-id>ee419095</msdn-id>
|
|
<unmanaged>XACT_SOUND_PROPERTIES soundProperties</unmanaged>
|
|
<unmanaged-short>XACT_SOUND_PROPERTIES soundProperties</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.StreamingParameters">
|
|
<summary>
|
|
<p>Streaming parameters for a wave bank.</p>
|
|
</summary>
|
|
<remarks>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_STREAMING_PARAMETERS']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_streaming_parameters</msdn-id>
|
|
<unmanaged>XACT_STREAMING_PARAMETERS</unmanaged>
|
|
<unmanaged-short>XACT_STREAMING_PARAMETERS</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.StreamingParameters.File">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_STREAMING_PARAMETERS::file']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_streaming_parameters</msdn-id>
|
|
<unmanaged>void* file</unmanaged>
|
|
<unmanaged-short>void file</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.StreamingParameters.Offset">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_STREAMING_PARAMETERS::offset']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_streaming_parameters</msdn-id>
|
|
<unmanaged>unsigned int offset</unmanaged>
|
|
<unmanaged-short>unsigned int offset</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.StreamingParameters.Flags">
|
|
<summary>
|
|
<dd> Flags. <em>Reserved for future use. Set to 0.</em> </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_STREAMING_PARAMETERS::flags']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_streaming_parameters</msdn-id>
|
|
<unmanaged>unsigned int flags</unmanaged>
|
|
<unmanaged-short>unsigned int flags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.StreamingParameters.PacketSize">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_STREAMING_PARAMETERS::packetSize']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_streaming_parameters</msdn-id>
|
|
<unmanaged>unsigned short packetSize</unmanaged>
|
|
<unmanaged-short>unsigned short packetSize</unmanaged-short>
|
|
</member>
|
|
<member name="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 <see cref="M:SharpDX.XACT3.SoundBank.GetCueProperties(System.Int16)"/> call returns.</p>
|
|
</remarks>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_TRACK_PROPERTIES']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_track_properties</msdn-id>
|
|
<unmanaged>XACT_TRACK_PROPERTIES</unmanaged>
|
|
<unmanaged-short>XACT_TRACK_PROPERTIES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.TrackProperties.Duration">
|
|
<summary>
|
|
<dd> Duration of the track in milliseconds. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_TRACK_PROPERTIES::duration']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_track_properties</msdn-id>
|
|
<unmanaged>int duration</unmanaged>
|
|
<unmanaged-short>int duration</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.TrackProperties.VariationCount">
|
|
<summary>
|
|
<dd> Total number of wave variations in the track. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_TRACK_PROPERTIES::numVariations']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_track_properties</msdn-id>
|
|
<unmanaged>unsigned short numVariations</unmanaged>
|
|
<unmanaged-short>unsigned short numVariations</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.TrackProperties.ChannelCount">
|
|
<summary>
|
|
<dd> Maximum number of channels that are required to play the track. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_TRACK_PROPERTIES::numChannels']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_track_properties</msdn-id>
|
|
<unmanaged>unsigned char numChannels</unmanaged>
|
|
<unmanaged-short>unsigned char numChannels</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.TrackProperties.WaveVariation">
|
|
<summary>
|
|
<dd> Index of the currently active wave variation. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_TRACK_PROPERTIES::waveVariation']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_track_properties</msdn-id>
|
|
<unmanaged>unsigned short waveVariation</unmanaged>
|
|
<unmanaged-short>unsigned short waveVariation</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.TrackProperties.LoopCount">
|
|
<summary>
|
|
<dd> Current loop count on the track. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_TRACK_PROPERTIES::loopCount']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_track_properties</msdn-id>
|
|
<unmanaged>unsigned char loopCount</unmanaged>
|
|
<unmanaged-short>unsigned char loopCount</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.VariationProperties">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_VARIATION_PROPERTIES']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_variation_properties</msdn-id>
|
|
<unmanaged>XACT_VARIATION_PROPERTIES</unmanaged>
|
|
<unmanaged-short>XACT_VARIATION_PROPERTIES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.VariationProperties.Index">
|
|
<summary>
|
|
<dd> Index of the variation in the parent variation list. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_VARIATION_PROPERTIES::index']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_variation_properties</msdn-id>
|
|
<unmanaged>unsigned short index</unmanaged>
|
|
<unmanaged-short>unsigned short index</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.VariationProperties.Weight">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_VARIATION_PROPERTIES::weight']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_variation_properties</msdn-id>
|
|
<unmanaged>unsigned char weight</unmanaged>
|
|
<unmanaged-short>unsigned char weight</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.VariationProperties.VariableMin">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_VARIATION_PROPERTIES::iaVariableMin']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_variation_properties</msdn-id>
|
|
<unmanaged>float iaVariableMin</unmanaged>
|
|
<unmanaged-short>float iaVariableMin</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.VariationProperties.VariableMax">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_VARIATION_PROPERTIES::iaVariableMax']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_variation_properties</msdn-id>
|
|
<unmanaged>float iaVariableMax</unmanaged>
|
|
<unmanaged-short>float iaVariableMax</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.VariationProperties.ShouldLinger">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_VARIATION_PROPERTIES::linger']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_variation_properties</msdn-id>
|
|
<unmanaged>BOOL linger</unmanaged>
|
|
<unmanaged-short>BOOL linger</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.WaveBankData">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKDATA']/*"/>
|
|
<unmanaged>WAVEBANKDATA</unmanaged>
|
|
<unmanaged-short>WAVEBANKDATA</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankData.Flags">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKDATA::dwFlags']/*"/>
|
|
<unmanaged>unsigned int dwFlags</unmanaged>
|
|
<unmanaged-short>unsigned int dwFlags</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankData.EntryCount">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKDATA::dwEntryCount']/*"/>
|
|
<unmanaged>unsigned int dwEntryCount</unmanaged>
|
|
<unmanaged-short>unsigned int dwEntryCount</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankData.SzBankName">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKDATA::szBankName']/*"/>
|
|
<unmanaged>char szBankName[64]</unmanaged>
|
|
<unmanaged-short>char szBankName</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankData.EntryMetaDataElementSize">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKDATA::dwEntryMetaDataElementSize']/*"/>
|
|
<unmanaged>unsigned int dwEntryMetaDataElementSize</unmanaged>
|
|
<unmanaged-short>unsigned int dwEntryMetaDataElementSize</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankData.EntryNameElementSize">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKDATA::dwEntryNameElementSize']/*"/>
|
|
<unmanaged>unsigned int dwEntryNameElementSize</unmanaged>
|
|
<unmanaged-short>unsigned int dwEntryNameElementSize</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankData.Alignment">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKDATA::dwAlignment']/*"/>
|
|
<unmanaged>unsigned int dwAlignment</unmanaged>
|
|
<unmanaged-short>unsigned int dwAlignment</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankData.CompactFormat">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKDATA::CompactFormat']/*"/>
|
|
<unmanaged>WAVEBANKMINIWAVEFORMAT CompactFormat</unmanaged>
|
|
<unmanaged-short>WAVEBANKMINIWAVEFORMAT CompactFormat</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankData.BuildTime">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKDATA::BuildTime']/*"/>
|
|
<unmanaged>FILETIME BuildTime</unmanaged>
|
|
<unmanaged-short>FILETIME BuildTime</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.WaveBankEntry">
|
|
<summary>
|
|
<p>Contains the entry information from an XACT wave bank.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKENTRY']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankentry</msdn-id>
|
|
<unmanaged>WAVEBANKENTRY</unmanaged>
|
|
<unmanaged-short>WAVEBANKENTRY</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankEntry.FlagsAndDuration">
|
|
<summary>
|
|
<dd><p>DWORD value representing both the flags and duration.</p></dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKENTRY::dwFlagsAndDuration']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankentry</msdn-id>
|
|
<unmanaged>unsigned int dwFlagsAndDuration</unmanaged>
|
|
<unmanaged-short>unsigned int dwFlagsAndDuration</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankEntry.Format">
|
|
<summary>
|
|
<dd><see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKENTRY::Format']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankentry</msdn-id>
|
|
<unmanaged>WAVEBANKMINIWAVEFORMAT Format</unmanaged>
|
|
<unmanaged-short>WAVEBANKMINIWAVEFORMAT Format</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankEntry.PlayRegion">
|
|
<summary>
|
|
<dd><see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKENTRY::PlayRegion']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankentry</msdn-id>
|
|
<unmanaged>WAVEBANKREGION PlayRegion</unmanaged>
|
|
<unmanaged-short>WAVEBANKREGION PlayRegion</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankEntry.LoopRegion">
|
|
<summary>
|
|
<dd><see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKENTRY::LoopRegion']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankentry</msdn-id>
|
|
<unmanaged>WAVEBANKSAMPLEREGION LoopRegion</unmanaged>
|
|
<unmanaged-short>WAVEBANKSAMPLEREGION LoopRegion</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.WaveBankEntry.Flags">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKENTRY::dwFlags']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankentry</msdn-id>
|
|
<unmanaged>unsigned int dwFlags</unmanaged>
|
|
<unmanaged-short>unsigned int dwFlags</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.WaveBankEntry.Duration">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKENTRY::Duration']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankentry</msdn-id>
|
|
<unmanaged>unsigned int Duration</unmanaged>
|
|
<unmanaged-short>unsigned int Duration</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.WaveBankEntryCompact">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKENTRYCOMPACT']/*"/>
|
|
<unmanaged>WAVEBANKENTRYCOMPACT</unmanaged>
|
|
<unmanaged-short>WAVEBANKENTRYCOMPACT</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.WaveBankEntryCompact.Offset">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKENTRYCOMPACT::dwOffset']/*"/>
|
|
<unmanaged>unsigned int dwOffset</unmanaged>
|
|
<unmanaged-short>unsigned int dwOffset</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.WaveBankEntryCompact.LengthDeviation">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKENTRYCOMPACT::dwLengthDeviation']/*"/>
|
|
<unmanaged>unsigned int dwLengthDeviation</unmanaged>
|
|
<unmanaged-short>unsigned int dwLengthDeviation</unmanaged-short>
|
|
</member>
|
|
<member name="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKHEADER']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankheader</msdn-id>
|
|
<unmanaged>WAVEBANKHEADER</unmanaged>
|
|
<unmanaged-short>WAVEBANKHEADER</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankHeader.Signature">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKHEADER::dwSignature']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankheader</msdn-id>
|
|
<unmanaged>unsigned int dwSignature</unmanaged>
|
|
<unmanaged-short>unsigned int dwSignature</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankHeader.Version">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKHEADER::dwVersion']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankheader</msdn-id>
|
|
<unmanaged>unsigned int dwVersion</unmanaged>
|
|
<unmanaged-short>unsigned int dwVersion</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankHeader.HeaderVersion">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKHEADER::dwHeaderVersion']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankheader</msdn-id>
|
|
<unmanaged>unsigned int dwHeaderVersion</unmanaged>
|
|
<unmanaged-short>unsigned int dwHeaderVersion</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.WaveBankHeader.Segments">
|
|
<summary>
|
|
<dd>Array of <see cref="T:SharpDX.XACT3.WaveBankRegion"/> structures representing the segment lookup table. The indices into this array are defined in <see cref="T:SharpDX.XACT3.Wavebanksegidx"/>. For example, you would use the <see cref="F:SharpDX.XACT3.Wavebanksegidx.SegidxBankdata"/> index to find the bank data region.</dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKHEADER::Segments']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankheader</msdn-id>
|
|
<unmanaged>WAVEBANKREGION Segments[5]</unmanaged>
|
|
<unmanaged-short>WAVEBANKREGION Segments</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.WaveBankMiniWaveFormat">
|
|
<summary>
|
|
<p>Contains the mini-wave format for an XACT wave bank.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKMINIWAVEFORMAT']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankminiwaveformat</msdn-id>
|
|
<unmanaged>WAVEBANKMINIWAVEFORMAT</unmanaged>
|
|
<unmanaged-short>WAVEBANKMINIWAVEFORMAT</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankMiniWaveFormat.Value">
|
|
<summary>
|
|
<dd>This member is unused.</dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKMINIWAVEFORMAT::dwValue']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankminiwaveformat</msdn-id>
|
|
<unmanaged>unsigned int dwValue</unmanaged>
|
|
<unmanaged-short>unsigned int dwValue</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.WaveBankMiniWaveFormat.RawFormatTag">
|
|
<summary>
|
|
<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><see cref="F:SharpDX.XACT3.WaveBankMiniFormatTag.Pcm"/></td><td>Specifies PCM wave format.?</td></tr><tr><td><see cref="F:SharpDX.XACT3.WaveBankMiniFormatTag.Xma"/></td><td>Specifies XMA2 format.?</td></tr><tr><td><see cref="F:SharpDX.XACT3.WaveBankMiniFormatTag.Adpcm"/></td><td>Specifies ADPCM wave format.?</td></tr><tr><td><see cref="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKMINIWAVEFORMAT::wFormatTag']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankminiwaveformat</msdn-id>
|
|
<unmanaged>unsigned int wFormatTag</unmanaged>
|
|
<unmanaged-short>unsigned int wFormatTag</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.WaveBankMiniWaveFormat.Channels">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKMINIWAVEFORMAT::nChannels']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankminiwaveformat</msdn-id>
|
|
<unmanaged>unsigned int nChannels</unmanaged>
|
|
<unmanaged-short>unsigned int nChannels</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.WaveBankMiniWaveFormat.SamplesPerSecond">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKMINIWAVEFORMAT::nSamplesPerSec']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankminiwaveformat</msdn-id>
|
|
<unmanaged>unsigned int nSamplesPerSec</unmanaged>
|
|
<unmanaged-short>unsigned int nSamplesPerSec</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.WaveBankMiniWaveFormat.BlockAlign">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKMINIWAVEFORMAT::wBlockAlign']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankminiwaveformat</msdn-id>
|
|
<unmanaged>unsigned int wBlockAlign</unmanaged>
|
|
<unmanaged-short>unsigned int wBlockAlign</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.WaveBankMiniWaveFormat.BitsPerSample">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKMINIWAVEFORMAT::wBitsPerSample']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankminiwaveformat</msdn-id>
|
|
<unmanaged>unsigned int wBitsPerSample</unmanaged>
|
|
<unmanaged-short>unsigned int wBitsPerSample</unmanaged-short>
|
|
</member>
|
|
<member name="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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKREGION']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankregion</msdn-id>
|
|
<unmanaged>WAVEBANKREGION</unmanaged>
|
|
<unmanaged-short>WAVEBANKREGION</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankRegion.Offset">
|
|
<summary>
|
|
<dd>Region offset in bytes.</dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKREGION::dwOffset']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankregion</msdn-id>
|
|
<unmanaged>unsigned int dwOffset</unmanaged>
|
|
<unmanaged-short>unsigned int dwOffset</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankRegion.Length">
|
|
<summary>
|
|
<dd>Region length in bytes.</dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKREGION::dwLength']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.wavebankregion</msdn-id>
|
|
<unmanaged>unsigned int dwLength</unmanaged>
|
|
<unmanaged-short>unsigned int dwLength</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.WaveBankSampleRegion">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKSAMPLEREGION']/*"/>
|
|
<unmanaged>WAVEBANKSAMPLEREGION</unmanaged>
|
|
<unmanaged-short>WAVEBANKSAMPLEREGION</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankSampleRegion.StartSample">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKSAMPLEREGION::dwStartSample']/*"/>
|
|
<unmanaged>unsigned int dwStartSample</unmanaged>
|
|
<unmanaged-short>unsigned int dwStartSample</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveBankSampleRegion.TotalSamples">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='WAVEBANKSAMPLEREGION::dwTotalSamples']/*"/>
|
|
<unmanaged>unsigned int dwTotalSamples</unmanaged>
|
|
<unmanaged-short>unsigned int dwTotalSamples</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.WaveInstanceProperties">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_WAVE_INSTANCE_PROPERTIES']/*"/>
|
|
<unmanaged>XACT_WAVE_INSTANCE_PROPERTIES</unmanaged>
|
|
<unmanaged-short>XACT_WAVE_INSTANCE_PROPERTIES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveInstanceProperties.Properties">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_WAVE_INSTANCE_PROPERTIES::properties']/*"/>
|
|
<unmanaged>XACT_WAVE_PROPERTIES properties</unmanaged>
|
|
<unmanaged-short>XACT_WAVE_PROPERTIES properties</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.WaveInstanceProperties.IsBackgroundMusic">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_WAVE_INSTANCE_PROPERTIES::backgroundMusic']/*"/>
|
|
<unmanaged>BOOL backgroundMusic</unmanaged>
|
|
<unmanaged-short>BOOL backgroundMusic</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.WaveProperties">
|
|
<summary>
|
|
<p>Returns the properties that are common to all waves.</p>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_WAVE_PROPERTIES']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_wave_properties</msdn-id>
|
|
<unmanaged>XACT_WAVE_PROPERTIES</unmanaged>
|
|
<unmanaged-short>XACT_WAVE_PROPERTIES</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveProperties.FriendlyName">
|
|
<summary>
|
|
<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 --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_WAVE_PROPERTIES::friendlyName']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_wave_properties</msdn-id>
|
|
<unmanaged>char friendlyName[64]</unmanaged>
|
|
<unmanaged-short>char friendlyName</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveProperties.Format">
|
|
<summary>
|
|
<dd> Format for the wave. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_WAVE_PROPERTIES::format']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_wave_properties</msdn-id>
|
|
<unmanaged>WAVEBANKMINIWAVEFORMAT format</unmanaged>
|
|
<unmanaged-short>WAVEBANKMINIWAVEFORMAT format</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveProperties.DurationInSamples">
|
|
<summary>
|
|
<dd> Duration of the wave, in samples. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_WAVE_PROPERTIES::durationInSamples']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_wave_properties</msdn-id>
|
|
<unmanaged>unsigned int durationInSamples</unmanaged>
|
|
<unmanaged-short>unsigned int durationInSamples</unmanaged-short>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.WaveProperties.LoopRegion">
|
|
<summary>
|
|
<dd> Loop region that is defined in samples. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_WAVE_PROPERTIES::loopRegion']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_wave_properties</msdn-id>
|
|
<unmanaged>WAVEBANKSAMPLEREGION loopRegion</unmanaged>
|
|
<unmanaged-short>WAVEBANKSAMPLEREGION loopRegion</unmanaged-short>
|
|
</member>
|
|
<member name="P:SharpDX.XACT3.WaveProperties.IsStreaming">
|
|
<summary>
|
|
<dd> TRUE if the wave is streaming. Otherwise, <see cref="F:SharpDX.Result.False"/>. </dd>
|
|
</summary>
|
|
<!-- No matching elements were found for the following include tag --><include file=".\..\Documentation\CodeComments.xml" path="/comments/comment[@id='XACT_WAVE_PROPERTIES::streaming']/*"/>
|
|
<msdn-id>microsoft.directx_sdk.struct.xact_wave_properties</msdn-id>
|
|
<unmanaged>BOOL streaming</unmanaged>
|
|
<unmanaged-short>BOOL streaming</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.MarkerNotification">
|
|
<summary>
|
|
Marker notification parameters.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_MARKER</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.NamespaceDoc">
|
|
<summary>
|
|
The <see cref="N:SharpDX.XACT3"/> namespace provides a managed XACT3 API.
|
|
</summary>
|
|
<msdn-id>hh405049</msdn-id>
|
|
<unmanaged>XACT3</unmanaged>
|
|
<unmanaged-short>XACT3</unmanaged-short>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.RawNotification">
|
|
<summary>
|
|
Hand written version of XACT_NOTIFICATION in order to smoothly support compatible x86/x64 inner anonymous union.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotification.Type">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_TYPE type</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotification.TimeStamp">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<unmanaged>int timeStamp</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotification.ContextPointer">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<unmanaged>void* pvContext</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotification.Data">
|
|
<summary>
|
|
Notification data specific to the <see cref="F:SharpDX.XACT3.RawNotification.Type"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotification.SubData.Cue">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_CUE cue</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotification.SubData.Marker">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_MARKER marker</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotification.SubData.SoundBank">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_SOUNDBANK soundBank</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotification.SubData.WaveBank">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_WAVEBANK waveBank</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotification.SubData.Variable">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_VARIABLE variable</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotification.SubData.Gui">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_GUI gui</unmanaged>
|
|
</member>
|
|
<member name="F:SharpDX.XACT3.RawNotification.SubData.Wave">
|
|
<summary>
|
|
No documentation.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_WAVE wave</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.SoundBankNotification">
|
|
<summary>
|
|
SoundBank notification parameters.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_SOUNDBANK</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.VariableNotification">
|
|
<summary>
|
|
Variable notification parameters.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_VARIABLE</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.WaveBankNotification">
|
|
<summary>
|
|
Wavebank notification parameters.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_WAVEBANK</unmanaged>
|
|
</member>
|
|
<member name="T:SharpDX.XACT3.WaveNotification">
|
|
<summary>
|
|
Wave notification parameters.
|
|
</summary>
|
|
<unmanaged>XACT_NOTIFICATION_WAVE</unmanaged>
|
|
</member>
|
|
</members>
|
|
</doc>
|